Merge branch 'stf' into stfcaus

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.

src/libs/libstfinv/stfinvbase.cc

@@ -46,6 +46,10 @@
 
 namespace stfinv {
 
+  /*!
+   * Constructor stores all references to time series data passed by the
+   * caller.
+   */
   STFBaseEngine::STFBaseEngine(const stfinv::Tvectoroftriples& triples,
                                const stfinv::Waveform& stf,
                                const stfinv::Tvectorofpairs& pairs,
@@ -58,6 +62,10 @@ namespace stfinv {
 
   /*----------------------------------------------------------------------*/
 
+  /*!
+   * Constructor stores all references to time series data passed by the
+   * caller.
+   */
   STFBaseEngine::STFBaseEngine(const stfinv::Tvectoroftriples& triples,
                                const stfinv::Waveform& stf,
                                const std::string& parameters)
@@ -69,6 +77,17 @@ namespace stfinv {
 
   /*----------------------------------------------------------------------*/
 
+  /*!
+   * -# The STFBaseEngine::initialize() function parses the parameter string.
+   *    Parsed values are stored in Mparamap.
+   * -# Extract settings for parameters:
+   *     - DEBUG: set debug output level
+   *     - verbose: activate verbose output
+   *     - exp: set power-law exponent and store weights in member data Mweights
+   * -# Check consistency of data
+   * -# Align index ranges of aff::Series objects such that the first element
+   *    (sample) has index zero
+   */
   void STFBaseEngine::initialize(const std::string& parameters)
   {
     this->parseparameters(parameters);
@@ -130,6 +149,13 @@ namespace stfinv {
 
   /*----------------------------------------------------------------------*/
 
+  /*!
+   * Check consistency of time series data passed to the STFBaseEngine
+   * with respect to
+   *  -# number of samples
+   *  -# sampling interval
+   *
+   */
   void STFBaseEngine::checkconsistency() const
   {
     const unsigned int& n=Mstf.sampling.n;
@@ -198,6 +224,13 @@ namespace stfinv {
 
   /*----------------------------------------------------------------------*/
 
+  /*!
+   * Pass the parameter string (as usually passed along the chain of
+   * constructors to the constructor and initialize() function of
+   * STFBaseEngine).
+   * The values are stored in the member data
+   * STFBaseEngine::Mparamap
+   */
   void STFBaseEngine::parseparameters(std::string parameters) 
   {
     while (parameters.length()>0)

src/libs/libstfinv/stfinvbase.h

@@ -293,7 +293,7 @@ namespace stfinv {
       //@{
       //! \brief initialize base class
       void initialize(const std::string& parameters);
-      //! \brief parse parameters in Mparameters
+      //! \brief parse parameters and store them in Mparamap
       void parseparameters(std::string parameters);
       //! \brief Check consistency of data members.
       void checkconsistency() const;