Changeset 1077 for library/bdm/stat/exp_family.h

Timestamp:

06/10/10 21:40:09 (14 years ago)

Author:

mido

Message:

another update of doc - all bayesian models until bdm::MultiModel? finished
also MixEF::MixEF_options renamed just to MixEF::Options

Files:

• library/bdm/stat/exp_family.h (modified) (5 diffs)

library/bdm/stat/exp_family.h

@@ -111 +111 @@
     }
 
+   /*! Create object from the following structure
+
+    \code
+    class = 'BMEF';
+     --- optional fields ---
+    frg = [];                   % forgetting factor
+    frg_sched_factor = [];      % factor for scheduling of forgetting factor: a number from [0..1]
+    --- inherited fields ---
+    bdm::BM::from_setting
+    \endcode
+    If the optional fields are not given, they will be filled as follows:
+    \code
+    frg = 1;                    % default forgetting factor
+    frg_sched_factor = 0;
+    \endcode
+    */
     void from_setting( const Setting &set) {
         BM::from_setting(set);
         if ( !UI::get ( frg, set, "frg" ) )
             frg = 1.0;
-        UI::get ( frg_sched_factor, set, "frg_sched_factor",UI::optional );
+        if ( UI::get ( frg_sched_factor, set, "frg_sched_factor" ) )
+            frg_sched_factor = 0.0;
     }
 
@@ -364 +381 @@
 * \brief Gauss-inverse-Wishart density stored in LD form
 
-* For \f$p\f$-variate densities, given rv.count() should be \f$p\times\f$ V.rows().
+* For \f$p\f$-variate densities, given rv.count() should be \f$p    imes\f$ V.rows().
 *
 */
@@ -402 +419 @@
 
     void factorize ( mat &M, ldmat &Vz, ldmat &Lam ) const;
-    //! LS estimate of \f$\theta\f$
+    //! LS estimate of \f$    heta\f$
     vec est_theta() const;
 
@@ -830 +847 @@
         UI::save( &est, set, "prior" );
     }
+
+    /*! Create object from the following structure
+
+    \code
+    class = 'MultiBM';
+    prior = configuration of bdm::eDirich;       % any offspring of eDirich, bdm::eDirich::from_setting
+    --- inherited fields ---
+    bdm::BMEF::from_setting
+    \endcode
+    */
     void from_setting (const Setting &set )  {
         BMEF::from_setting ( set );
@@ -2062 +2089 @@
 };
 
-//! \todo unify this stuff with to_string()
+//!     odo unify this stuff with to_string()
 template<class sq_T>
 std::ostream &operator<< ( std::ostream &os,  mlnorm<sq_T> &ml ) {