Changeset 1068 for library/bdm/stat/emix.h

Timestamp:

06/09/10 18:35:14 (14 years ago)

Author:

mido

Message:

patch of documentation - all conditional pdfs revised

Files:

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

library/bdm/stat/emix.h

@@ -24 +24 @@
 
 /*! \brief Class representing ratio of two densities
+
 which arise e.g. by applying the Bayes rule.
 It represents density in the form:
@@ -266 +267 @@
     }
 
-    //! Load from structure with elements:
-    //!  \code
-    //! { class='mprod';
-    //!   pdfs = (..., ...);     // list of pdfs in the order of chain rule
-    //! }
+    //! Create object from the following structure
+    //! \code
+    //! class='mprod';
+    //! pdfs = { list of bdm::pdf };          % list of bdm::pdf offsprings stored in the order of chain rule, bdm::pdf::from_setting
+    //! --- inherited fields ---
+    //! bdm::pdf::from_setting
     //! \endcode
     //!@}
     void from_setting ( const Setting &set ) ;
-    void     to_setting  (Setting  &set) const;
-
-
+    void to_setting  (Setting  &set) const;    
 };
 UIREGISTER ( mprod );
@@ -370 +370 @@
 UIREGISTER(eprod);
 
-//! \brief Internal class similar to eprod - factors are external pointers. To be used only internally!  
+//! \brief Internal class similar to eprod - factors are external pointers. To be used internally!  
 class eprod_internal: public eprod_base {
 protected:
@@ -409 +409 @@
     vec samplecond ( const vec &cond );
 
-    //! Load from structure with elements:
-    //!  \code
-    //! { class='mmix';
-    //!   pdfs = (..., ...);     // list of pdfs in the mixture
-    //!   weights = ( 0.5, 0.5 ); // weights of pdfs in the mixture
     //! }
     //! \endcode
     //!@}
+   
+    /*! Create object from the following structure
+    \code
+    class = 'mmix';
+    pdfs = { list of components bdm::pdf };          % list of pdf offsprings, bdm::pdf::from_setting
+    --- optional fields ---
+    weights = [...];                                 % weights of pdfs in the mixture
+    --- inherited fields ---
+    bdm::pdf::from_setting
+    \endcode
+    \endcode
+    If the optional fields are not given, they will be filled as follows:
+    \code
+    weights = 1/n * [1,1,1,...];
+    \endcode
+    */
     void from_setting ( const Setting &set );
     void     to_setting  (Setting  &set) const;
@@ -430 +441 @@
     Array<vec_from_vec> bm_yt;
     Array<vec_from_2vec> bm_cond;
+
+    //! \brief Internal class
     class eprod_bm : public eprod_base {
         ProdBMBase & pb;