Changeset 1054 for applications/bdmtoolbox/doc/local/001wrappers.dox

Timestamp:

06/07/10 17:25:57 (14 years ago)

Author:

smidl

Message:

doc

Files:

• applications/bdmtoolbox/doc/local/001wrappers.dox (moved) (moved from applications/bdmtoolbox/doc/local/10wrappers.dox) (5 diffs)

applications/bdmtoolbox/doc/local/001wrappers.dox

@@ -1 +1 @@
 /*!
-\page bdt_wrappers Elementary functions operating on descriptive matlab structures
+\page bdt_wrappers Use Case #2: Matlab wrappers for BDM functions
 
 A wrapper is a mex file that does the following:
@@ -8 +8 @@
  
 The use of these functions is inefficient, however, it is very usefull for:
- - operations on parts of the experiment configurations for scenarios, see example in \ref some_ref
+ - operations on parts of the experiment configurations for scenarios, see ...
  - insight into the results, e.g. mean values of non-standard densities 
  - algorithms written in Matlab using these functions can be trivially re-written into C++
- 
  
 General notation of wrappers is: <b> \<class\>_\<function\>.m </b>
@@ -66 +65 @@
 
 The follwing wrappers are provided:
- - \b epdf_mean returning mean value of any epdf function in \ref annotated_epdf.
+ - \b epdf_mean returning mean value of any epdf function in <a href="annotated_bdm_epdf.html"> list </a>.
  \code 
  >> G.class='egamma';
@@ -77 +76 @@
     0.7500 
  \endcode
- - \b epdf_variance returning variance of any epdf function in \ref annotated_epdf.
+ - \b epdf_variance returning variance of any epdf function in <a href="annotated_bdm_epdf.html"> list </a>..
  \code
  >> epdf_variance(G)
@@ -103 +102 @@
 \endcode
 
-For up-to-date list of wrappers see files in \ref files.html
+For up-to-date list of wrappers see files in <a href="files.html"> files.html</a>
  
  \section bdt_wrp_off Wrappers of offsprings