Changeset 1887


Ignore:
Timestamp:
Mar 31, 2009, 7:38:16 PM (13 years ago)
Author:
Peter
Message:

closes #512. added relates tag in namespace utility.

Location:
trunk/yat/utility
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/utility/ColumnStream.h

    r1797 r1887  
    66/*
    77  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
     8  Copyright (C) 2009 Peter Johansson
    89
    910  This file is part of svndigest, http://dev.thep.lu.se/svndigest
     
    102103     Requirement: T should have operator
    103104     operator<<(ostream&, const T&)
     105
     106     \relates ColumnStream
    104107   */
    105108  template <typename T>
  • trunk/yat/utility/CommandLine.h

    r1797 r1887  
    179179     Option::print(void) function.
    180180     \see OptionHelp
     181
     182     \relates CommandLine
    181183  */
    182184  std::ostream& operator<<(std::ostream&, const CommandLine&);
  • trunk/yat/utility/DataIterator.h

    r1797 r1887  
    8181
    8282     Convenient function in same fashion as std::make_pair.
     83
     84     \relates DataIterator
    8385   */
    8486  template<typename Base>
  • trunk/yat/utility/DataWeight.h

    r1797 r1887  
    7979
    8080     \return true if lhs.data() == rhs.data()
     81
     82     \relates DataWeight
    8183   */
    8284  bool operator==(const DataWeight& lhs, const DataWeight& rhs);
     
    8688
    8789     \return true if lhs.data() != rhs.data()
     90
     91     \relates DataWeight
    8892   */
    8993  bool operator!=(const DataWeight&, const DataWeight&);
     
    9397
    9498     \return true if lhs data is less than rhs data
     99
     100     \relates DataWeight
    95101   */
    96102  bool operator<(const DataWeight&, const DataWeight&);
     
    100106
    101107     \return true if lhs data is greater than rhs data
     108
     109     \relates DataWeight
    102110   */
    103111  bool operator>(const DataWeight&, const DataWeight&);
     
    107115
    108116     \return true if lhs.data() <= rhs.data()
     117
     118     \relates DataWeight
    109119   */
    110120  bool operator<=(const DataWeight&, const DataWeight&);
     
    114124
    115125     \return true if lhs.data() >= rhs.data()
     126
     127     \relates DataWeight
    116128   */
    117129  bool operator>=(const DataWeight&, const DataWeight&);
  • trunk/yat/utility/DataWeightProxy.h

    r1797 r1887  
    108108  /**
    109109     \brief equality operator
     110
     111     \relates DataWeightProxy
    110112   */
    111113  template<typename DataIterator, typename WeightIterator>
  • trunk/yat/utility/Matrix.h

    r1823 r1887  
    518518     \return True if all elements in the Matrix is zero, false
    519519     otherwise.
     520
     521     \relates Matrix
    520522  */
    521523  bool isnull(const Matrix&);
     
    525527
    526528     \return The maximum value of the Matrix.
     529
     530     \relates Matrix
    527531  */
    528532  double max(const Matrix&);
     
    532536
    533537     \return The minimum value of the Matrix.
     538
     539     \relates Matrix
    534540  */
    535541  double min(const Matrix&);
     
    542548
    543549     \note Lower index has precedence (searching in row-major order).
     550
     551     \relates Matrix
    544552  */
    545553  void minmax_index(const Matrix&,
     
    559567
    560568     \return True if the \a templat Matrix contains at least one NaN.
     569
     570     \relates Matrix
    561571  */
    562572  bool nan(const Matrix& templat, Matrix& flag);
     
    568578
    569579     \throw GSL_error if sizes are not equal.
     580
     581     \relates Matrix
    570582  */
    571583  void swap(Matrix&, Matrix&);
     
    573585  /**
    574586     \brief The output operator for the Matrix class.
     587
     588     \relates Matrix
    575589  */
    576590  std::ostream& operator<< (std::ostream& s, const Matrix&);
     
    578592  /**
    579593     \brief Vector Matrix multiplication
     594
     595     \relates Matrix
    580596   */
    581597  Vector operator*(const Matrix&, const VectorBase&);
     
    583599  /**
    584600     \brief Matrix Vector multiplication
     601
     602     \relatesalso Matrix
     603
     604     \relatesalso VectorBase
    585605   */
    586606  Vector operator*(const VectorBase&, const Matrix&);
  • trunk/yat/utility/MatrixWeighted.h

    r1816 r1887  
    273273
    274274     \see MatrixWeighted::swap(MatrixWeighted&)
     275
     276     \relates MatrixWeighted
    275277  */
    276278  void swap(MatrixWeighted&, MatrixWeighted&);
  • trunk/yat/utility/Range.h

    r1797 r1887  
    66/*
    77  Copyright (C) 2008 Jari Häkkinen, Peter Johansson
     8  Copyright (C) 2009 Peter Johansson
    89
    910  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    9596
    9697     \since New in yat 0.5
     98
     99     \relatesalso Range
    97100   */ 
    98101  template<typename T1, typename T2>
     
    103106
    104107     \since New in yat 0.5
     108
     109     \relatesalso Range
    105110   */ 
    106111  template<typename T1, typename T2>
     
    115120
    116121     \since New in yat 0.5
     122
     123     \relatesalso Range
    117124   */ 
    118125  template<typename T1, typename T2>
     
    123130
    124131     \since New in yat 0.5
     132
     133     \relatesalso Range
    125134   */ 
    126135  template<typename T1, typename T2>
     
    131140
    132141     \since New in yat 0.5
     142
     143     \relatesalso Range
    133144   */ 
    134145  template<typename T1, typename T2>
     
    139150
    140151     \since New in yat 0.5
     152
     153     \relatesalso Range
    141154   */ 
    142155  template<typename T1, typename T2>
  • trunk/yat/utility/TypeInfo.h

    r1797 r1887  
    66/*
    77  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
     8  Copyright (C) 2009 Peter Johansson
    89
    910  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    7677     \brief Equality comparison
    7778     \return true iff underlying std::type_info are equal
     79
     80     \relates TypeInfo
    7881   */ 
    7982  bool operator==(const TypeInfo&, const TypeInfo&);
     
    8184  /**
    8285     \brief Based on operator==
     86
     87     \relates TypeInfo
    8388   */ 
    8489  bool operator!=(const TypeInfo&, const TypeInfo&);
     
    8792     \brief Ordering relation
    8893     \return true iff underlying lhs.get()<rhs.get()
     94
     95     \relates TypeInfo
    8996   */ 
    9097  bool operator<(const TypeInfo& lhs, const TypeInfo& rhs);
     
    9299  /**
    93100     \brief Based on operators == and <
     101
     102     \relates TypeInfo
    94103   */ 
    95104  bool operator<=(const TypeInfo&, const TypeInfo&);
     
    97106  /**
    98107     \brief Based on operator <
     108
     109     \relates TypeInfo
    99110   */ 
    100111  bool operator>(const TypeInfo&, const TypeInfo&);
     
    102113  /**
    103114     \brief Based on operator <=
     115
     116     \relates TypeInfo
    104117   */ 
    105118  bool operator>=(const TypeInfo&, const TypeInfo&);
  • trunk/yat/utility/Vector.h

    r1797 r1887  
    186186
    187187     \throw GSL_error if Vector lengths differs.
     188
     189     \relates Vector
    188190  */
    189191  void swap(Vector&, Vector&);
  • trunk/yat/utility/VectorBase.h

    r1797 r1887  
    176176     \return True if all elements in the VectorBase is zero, false
    177177     othwerwise.
     178
     179     \relates VectorBase
    178180  */
    179181  bool isnull(const VectorBase&);
     
    183185
    184186     \return The maximum value of the VectorBase.
     187
     188     \relates VectorBase
    185189  */
    186190  double max(const VectorBase&);
     
    192196
    193197     \note Lower index has precedence.
     198
     199     \relates VectorBase
    194200  */
    195201  size_t max_index(const VectorBase&);
     
    199205
    200206     \return The minimum value of the VectorBase.
     207
     208     \relates VectorBase
    201209  */
    202210  double min(const VectorBase&);
     
    208216
    209217     \note Lower index has precedence.
     218
     219     \relates VectorBase
    210220  */
    211221  size_t min_index(const VectorBase&);
     
    223233
    224234     \return True if the \a templat VectorBase contains at least one NaN.
     235
     236     \relates VectorBase
    225237  */
    226238  bool nan(const VectorBase& templat, Vector& flag);
     
    235247     index of the greatest element in \a invec . The VectorBase \a invec
    236248     is not changed.
     249
     250     \relatesalso VectorBase
    237251  */
    238252  void sort_index(std::vector<size_t>& sort_index, const VectorBase& invec);
     
    241255      Similar to sort_index but creates a VectorBase with indices to
    242256      the \a k smallest elements in \a invec.
     257
     258     \relatesalso VectorBase
    243259  */
    244260  void sort_smallest_index(std::vector<size_t>& sort_index, size_t k,
     
    248264      Similar to sort_index but creates a VectorBase with indices to
    249265      the \a k largest elements in \a invec.
     266
     267     \relatesalso VectorBase
    250268  */
    251269  void sort_largest_index(std::vector<size_t>& sort_index, size_t k,
     
    256274
    257275     \return The sum.
     276
     277     \relates VectorBase
    258278  */
    259279  double sum(const VectorBase&);
     
    269289     s << setfill(':') << v;
    270290     \endverbatim
     291
     292     \relates VectorBase
    271293  */
    272294  std::ostream& operator<<(std::ostream& s, const VectorBase& v);
  • trunk/yat/utility/WeightIterator.h

    r1797 r1887  
    8080
    8181     Convenient function in same fashion as std::make_pair.
     82
     83     \relates WeightIterator
    8284   */
    8385  template<typename Base>
  • trunk/yat/utility/WeightedIterator.h

    r1543 r1887  
    55
    66/*
    7   Copyright (C) 2008 Peter Johansson
     7  Copyright (C) 2008, 2009 Peter Johansson
    88
    99  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    131131
    132132     Convenient function in same fashion as std::make_pair.
     133
     134     \relates WeightedIterator
    133135   */
    134136  template<typename DataIterator, typename WeightIterator>
Note: See TracChangeset for help on using the changeset viewer.