Changeset 536 for library/bdm/base/bdmbase.h

Timestamp:

08/16/09 18:13:31 (15 years ago)

Author:

smidl

Message:

removal of unused functions _e() and samplecond(,) and added documentation lines

Files:

• library/bdm/base/bdmbase.h (modified) (14 diffs)

library/bdm/base/bdmbase.h

@@ -29 +29 @@
 
 typedef std::map<string, int> RVmap;
+//! Internal global variable storing sizes of RVs
 extern ivec RV_SIZES;
+//! Internal global variable storing names of RVs
 extern Array<string> RV_NAMES;
 
@@ -160 +162 @@
                 }
                 //!@}
-
-                //TODO why not inline and later??
 
                 //! \name Algebra on Random Variables
@@ -192 +192 @@
                 //!@{
 
-                //! generate \c str from rv, by expanding sizes TODO to_string..
+                //! generate \c str from rv, by expanding sizes 
                 str tostr() const;
                 //! when this rv is a part of bigger rv, this function returns indices of self in the data vector of the bigger crv.
@@ -223 +223 @@
 
                 // TODO dodelat void to_setting( Setting &set ) const;
-
                 //! Invalidate all named RVs. Use before initializing any RV instances, with care...
                 static void clear_all();
@@ -391 +390 @@
 SHAREDPTR(epdf);
 
-//! Conditional probability density, e.g. modeling some dependencies.
-//TODO Samplecond can be generalized
+//! Conditional probability density, e.g. modeling \f$ f( x | y) \f$, where \f$ x \f$ is random variable, \c rv, and \f$ y \f$ is conditioning variable, \c rvc.
 class mpdf : public root
 {
@@ -405 +403 @@
 
         protected:
+                //! set internal pointer \c ep to point to given \c iepdf
                 void set_ep (epdf &iepdf) {
                         ep = &iepdf;
                 }
+                //! set internal pointer \c ep to point to given \c iepdf
                 void set_ep (epdf *iepdfp) {
                         ep = iepdfp;
@@ -487 +487 @@
 SHAREDPTR(mpdf);
 
+//! Mpdf with internal epdf that is modified by function \c condition
 template <class EPDF>
 class mpdf_internal: public mpdf
 {
         protected :
+                //! Internal epdf used for sampling
                 EPDF iepdf;
         public:
@@ -555 +557 @@
                 //! Constructor
                 datalink() : downsize (0), upsize (0) { }
+                //! Conevnience constructor
                 datalink (const RV &rv, const RV &rv_up) {
                         set_connection (rv, rv_up);
@@ -607 +610 @@
                 //! Constructor
                 datalink_m2e() : condsize (0) { }
-
+                //! Set connection between vectors
                 void set_connection (const RV &rv, const RV &rvc, const RV &rv_up) {
                         datalink::set_connection (rv, rv_up);
@@ -621 +624 @@
                         return tmp;
                 }
-
+                //! Copy corresponding values to Up.condition
                 void pushup_cond (vec &val_up, const vec &val, const vec &cond) {
                         it_assert_debug (downsize == val.length(), "Wrong val");
@@ -643 +646 @@
                 //! Constructor
                 datalink_m2m() {};
+                //! Set connection between the vectors
                 void set_connection (const RV &rv, const RV &rvc, const RV &rv_up, const RV &rvc_up) {
                         datalink_m2e::set_connection (rv, rvc, rv_up);
@@ -713 +717 @@
 class mepdf : public mpdf
 {
-
+                //! Internal shared pointer to epdf
                 shared_ptr<epdf> iepdf;
         public:
                 //!Default constructor
                 mepdf() { }
-
+                //! Set internal shared pointer
                 mepdf (shared_ptr<epdf> em) {
                         iepdf = em;
@@ -893 +897 @@
                         return NULL;
                 };
-                //!Constructs a conditional density 1-step ahead predictor \f$ f(d_{t+1} |d_{t+h-1}, \ldots d_{t})
+                //!Constructs conditional density of 1-step ahead predictor \f$ f(d_{t+1} |d_{t+h-1}, \ldots d_{t}) \f$
                 virtual mpdf* predictor() const {
                         it_error ("Not implemented");
@@ -939 +943 @@
                 }
                 virtual const epdf& posterior() const = 0;
-                virtual const epdf* _e() const = 0;
                 //!@}