Changeset 1063 for library/bdm/base

Timestamp:

06/09/10 11:50:16 (14 years ago)

Author:

mido

Message:

a small patch of documentation, to be contiuned..

Location:

library/bdm/base

Files:

• bdmbase.h (modified) (4 diffs)
• datasources.h (modified) (1 diff)
• user_info.h (modified) (6 diffs)

library/bdm/base/bdmbase.h

@@ -570 +570 @@
 
   This macro has to be called within a class declaration. Its argument \a classname has to correspond to that wrapping class.
-  This macro defines a log_level instance which can be modified either directly or by the means of #UI class.
+  This macro defines a log_level instance which can be modified either directly or by the means of #bdm::UI class.
 
   One of the main purposes of this macro is to allow variability in using enumerations. By relating them to their names through
@@ -736 +736 @@
         //! log upper bound of the density (see function qbounds)
         
-        //! \var log_level_enums logfull
-        //! log full record of the density in the form of setting
         LOG_LEVEL(epdf,logmean,loglbound,logubound);
 
@@ -801 +799 @@
         //! Set statistics to match given input epdf. Typically it copies statistics from epdf of the same type and projects those form different types
         //! \param pdf0 epdf to match
-        //! \param option placeholder for potential options
         void set_statistics(const epdf *pdf0) NOT_IMPLEMENTED_VOID;
         //!@}
@@ -1309 +1306 @@
 
         /*! \brief Incremental Bayes rule
-        @param dt vector of input data
+        @param yt vector of input data
         */
         virtual void bayes ( const vec &yt, const vec &cond = empty_vec ) =0;

library/bdm/base/datasources.h

@@ -269 +269 @@
         class = 'PdfDS';
         pdf = configuration of bdm::pdf;          % any offspring of pdf, bdm::pdf::from_setting
-        --- optional ---
+        --- optional fields ---
         init_rv = RV({'names',...},[sizes,...],[times,...]);   % define what rv to initialize - typically delayed values, time=-1, etc.!
         init_values = [...];                      % vector of initial values corresponding to init_rv
         \endcode
-        Class does not inherits from bdm::DS::from_setting, names of data are taken from pdf.rv and pdf.rvc.
+        Class does not call from bdm::DS::from_setting, names of data are taken from pdf.rv and pdf.rvc.
         
         If init_rv is not given, init_values are set to zero.

library/bdm/base/user_info.h

@@ -395 +395 @@
         //! The new instance of type T* is constructed and initialized with values stored in the Setting element[name]
         //!
-        //! If there does not exist any sub-element named #name and settingPresence is #optional, an empty bdm::shared_ptr<T> is returned. When settingPresence is #compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
+        //! If there does not exist any sub-element named name and settingPresence is optional, an empty bdm::shared_ptr<T> is returned. 
+        //! When settingPresence is compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
         template<class T>
         static bdm::shared_ptr<T> build ( const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
@@ -412 +413 @@
         //! The new instance of type T* is constructed and initialized with values stored in the Setting element[index]
         //!
-        //! If there does not exist  any sub-element indexed by #index, and settingPresence is #optional, an empty bdm::shared_ptr<T> is returned. When settingPresence is #compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
+        //! If there does not exist  any sub-element indexed by index, and settingPresence is optional, an empty bdm::shared_ptr<T> is returned. 
+        //! When settingPresence is compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
         template<class T>
         static bdm::shared_ptr<T> build ( const Setting &element, const int index, SettingPresence settingPresence = optional ) {
@@ -447 +449 @@
 
         //! The existing instance of type T is initialized with values stored in the Setting element[name]
-        //! If there does not exist any sub-element named #name, this method returns false.
+        //! If there does not exist any sub-element named name, this method returns false.
         template<class T> static bool get ( T &instance, const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
                 if ( !element.exists ( name ) ) {
@@ -461 +463 @@
 
         //! The existing instance of type T is initialized with values stored in the Setting element[index]
-        //! If there does not exist any sub-element indexed by #index, this method returns false.
+        //! If there does not exist any sub-element indexed by index, this method returns false.
         template<class T> static bool get ( T &instance, const Setting &element, const int index, SettingPresence settingPresence = optional ) {
                 if ( element.getLength() <= index ) {
@@ -490 +492 @@
 
         //! The existing array of type T is initialized with values stored in the Setting element[name]
-        //! If there is not any sub-element named #name, this method returns false.
+        //! If there is not any sub-element named name, this method returns false.
         template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
                 if ( !element.exists ( name ) ) {
@@ -504 +506 @@
 
         //! The existing array of type T is initialized with values stored in the Setting element[index]
-        //! If there is not any sub-element indexed by #index, this method returns false.
+        //! If there is not any sub-element indexed by index, this method returns false.
         template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const int index, SettingPresence settingPresence = optional ) {
                 if ( element.getLength() <= index ) {