Changeset 1077 for library/bdm/estim/particles.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/estim/particles.h (modified) (6 diffs)

library/bdm/estim/particles.h

@@ -67 +67 @@
         }
     }
+
+
+    /*! Create object from the following structure
+
+    \code
+    class = "MarginalizedParticleBase";
+    bm = configuration of bdm::BM;          % any offspring of BM, bdm::BM::from_setting
+    --- inherited fields ---
+    bdm::BM::from_setting
+    \endcode
+    */
     void from_setting(const Setting &set) {
         BM::from_setting ( set );
@@ -78 +89 @@
 };
 
+//! \brief Internal class used in PF (surely?)
 class MarginalizedParticle : public MarginalizedParticleBase {
 protected:
@@ -110 +122 @@
     }
 
-    /*! parse structure
+    /*! Create object from the following structure
+
     \code
     class = "MarginalizedParticle";
-    parameter_pdf = {class = 'epdf_offspring', ...};
-    bm = {class = 'bm_offspring',...};
+    parameter_pdf = configuration of bdm::epdf;          % any offspring of epdf, bdm::epdf::from_setting
+    --- inherited fields ---
+    bdm::MarginalizedParticleBase::from_setting
     \endcode
-    If rvs are set, then it checks for compatibility.
-    */
+    */    
     void from_setting(const Setting &set) {
         MarginalizedParticleBase::from_setting ( set );
@@ -159 +172 @@
 UIREGISTER(MarginalizedParticle);
 
-//! class used in PF
+//! Internal class which is used in PF
 class BootstrapParticle : public BM {
     dirac est;
@@ -193 +206 @@
     }
 
-    /*! parse structure
+    /*! Create object from the following structure
     \code
     class = "BootstrapParticle";
-    parameter_pdf = {class = 'epdf_offspring', ...};
-    observation_pdf = {class = 'epdf_offspring',...};
+    parameter_pdf = configuration of bdm::epdf;      % any offspring of epdf, bdm::epdf::from_setting
+    observation_pdf = configuration of bdm::epdf;    % any offspring of epdf, bdm::epdf::from_setting
+    --- inherited fields ---
+    bdm::BM::from_setting
     \endcode
-    If rvs are set, then it checks for compatibility.
     */
     void from_setting(const Setting &set) {
@@ -206 +220 @@
         obs = UI::build<pdf> ( set, "observation_pdf", UI::compulsory );
     }
+
     void validate() {
         yrv = obs->_rv();