Changeset 1339


Ignore:
Timestamp:
Jun 7, 2008, 1:58:39 AM (13 years ago)
Author:
Peter
Message:

Adding \since tag for new classes and functions

Location:
trunk/yat
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/statistics/Average.h

    r1317 r1339  
    3434  /**
    3535     \brief Functor to take average of a range.
     36
     37     \since New in yat 0.5
    3638   */
    3739  struct Average
  • trunk/yat/statistics/Percentiler.h

    r1323 r1339  
    3838  /**
    3939     \brief Functor to calculate percentile of a range
     40
     41     \since New in yat 0.5
    4042   */
    4143  class Percentiler
  • trunk/yat/statistics/Smoother.h

    r1311 r1339  
    3939  /**
    4040     @brief Estimating a distribution in a smooth fashion
     41
     42     \since New in yat 0.5
    4143  */
    4244  class Smoother
  • trunk/yat/utility/Range.h

    r1337 r1339  
    3737     end), defined by two iterators of type T. This can be useful, for
    3838     example, when creating numerous sub-ranges of a larger container.
     39
     40     \since New in yat 0.5
    3941  */
    4042  template<typename T>
     
    8890     \brief Equality comparison
    8991     \return true iff underlying elements are equal
     92
     93     \since New in yat 0.5
    9094   */ 
    9195  template<typename T1, typename T2>
     
    9498  /**
    9599     \brief Based on operator==
     100
     101     \since New in yat 0.5
    96102   */ 
    97103  template<typename T1, typename T2>
     
    104110
    105111     \return true if \a lhs < \a rhs
     112
     113     \since New in yat 0.5
    106114   */ 
    107115  template<typename T1, typename T2>
     
    110118  /**
    111119     \return ! (\a rhs < \a lhs )
     120
     121     \since New in yat 0.5
    112122   */ 
    113123  template<typename T1, typename T2>
     
    116126  /**
    117127     \return \a rhs < \a lhs
     128
     129     \since New in yat 0.5
    118130   */ 
    119131  template<typename T1, typename T2>
     
    122134  /**
    123135     \return ! (\a lhs < \a rhs )
     136
     137     \since New in yat 0.5
    124138   */ 
    125139  template<typename T1, typename T2>
  • trunk/yat/utility/stl_utility.h

    r1288 r1339  
    121121  /**
    122122     Functor class to exponentiate values using std::exp
     123
     124     \since New in yat 0.5
    123125  */
    124126  template<typename T>
     
    134136  /**
    135137     Functor class to take logarithm
     138
     139     \since New in yat 0.5
    136140  */
    137141  template<typename T>
  • trunk/yat/utility/utility.h

    r1338 r1339  
    5656  /**
    5757     \brief check if string is convertible to (numerical) type
     58
     59     \since New in yat 0.5
    5860   */
    5961  template<typename T>
     
    98100  /**
    99101     \brief Perform quantile normalization
     102
     103     \since New in yat 0.5
    100104   */
    101105  void quantile_normalize(Matrix&);
  • trunk/yat/utility/version.h.in

    r1328 r1339  
    4040
    4141   No compatibility is guarenteed between MAJOR versions.
     42
     43   \since New in yat 0.5
    4244 */
    4345#define YAT_MAJOR_VERSION @YAT_MAJOR_VERSION@
     
    4850   Minor API changes that do not cause binary compatibility problems.
    4951   Reset to 0 when upgrading YAT_MAJOR_VERSION
     52
     53   \since New in yat 0.5
    5054 */
    5155#define YAT_MINOR_VERSION @YAT_MINOR_VERSION@
     
    5660   The Patch level never includes API changes, simply bug fixes.
    5761   Reset to 0 when upgrading YAT_MINOR_VERSION
     62
     63   \since New in yat 0.5
    5864 */
    5965#define YAT_PATCH_VERSION @YAT_PATCH_VERSION@
     
    6369
    6470   The version of yat in string format
     71
     72   \since New in yat 0.5
    6573 */
    6674#define YAT_VERSION "@VERSION@"
     
    7078
    7179   Is set to true in releases
     80
     81   \since New in yat 0.5
    7282 */
    7383#define YAT_DEV_BUILD @YAT_DEV_BUILD@
     
    8191  /**
    8292     \return major version number of compiled yat library
     93
     94   \since New in yat 0.5
    8395   */
    8496  unsigned int major_version(void);
     
    8698  /**
    8799     \return minor version number of compiled yat library
     100
     101     \since New in yat 0.5
    88102   */
    89103  unsigned int minor_version(void);
     
    91105  /**
    92106     \return patch version number of compiled yat library
     107
     108     \since New in yat 0.5
    93109   */
    94110  unsigned int patch_version(void);
     
    96112  /**
    97113     \return version number of compiled yat library
     114
     115     \since New in yat 0.5
    98116   */
    99117  std::string version(void);
Note: See TracChangeset for help on using the changeset viewer.