Changeset 3136


Ignore:
Timestamp:
Nov 28, 2013, 1:18:22 AM (7 years ago)
Author:
Peter
Message:

fix docs and remove WS

File:
1 edited

Legend:

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

    r3135 r3136  
    6565     \brief Benjamini Hochberg multiple test correction
    6666
    67      Given a sorted range of p-values such that 
    68      \f$ p_1 \le p_2 \le ... \le p_N \f$ a Benjamnini-Hochberg corrected 
    69      p-value, \c q, is calculated recursively as 
    70      \f$ q_i = \f$ min \f$(p_i \frac{N}{i}, q_{i+1})\f$ with the anchor 
     67     Given a sorted range of p-values such that
     68     \f$ p_1 \le p_2 \le ... \le p_N \f$ a Benjamnini-Hochberg corrected
     69     p-value, \c q, is calculated recursively as
     70     \f$ q_i = \f$ min \f$(p_i \frac{N}{i}, q_{i+1})\f$ with the anchor
    7171     constraint that \f$ q_m = p_m \f$.
    7272
    73      Requirements: \c BidirectionalIterator1 should be a 
     73     Requirements: \c BidirectionalIterator1 should be a
    7474     \bidirectional_iterator and \c BidirectionalIterator2 should be a
    7575     mutable \bidirectional_iterator
     
    8181                          BidirectionalIterator1 last,
    8282                          BidirectionalIterator2 result);
    83                          
     83
    8484
    8585  ///
     
    9999
    100100  /**
    101      The entropy is calculated as \f$ \sum_i p_i \log p_i \f$ where
     101     The entropy is calculated as \f$ - \sum_i p_i \log p_i \f$ where
    102102     \f$p_i = \frac{n_i}{\sum_j n_j} \f$
    103103
    104      Requirements: \c InputIterator should be an \input_iterator
    105      Requirements: \c InputIterator::value_type must be convertible to \c double
     104     Requirements:
     105     - \c InputIterator should be an \input_iterator
     106     - \c InputIterator::value_type must be convertible to \c double
     107
     108     \since New in yat 0.12
    106109   */
    107110  template<typename InputIterator>
     
    137140  ///
    138141  /// @brief Median absolute deviation from median
    139   /// 
     142  ///
    140143  /// Function is non-mutable function
    141144  ///
     
    147150  ///
    148151  template <class RandomAccessIterator>
    149   double mad(RandomAccessIterator first, RandomAccessIterator last, 
     152  double mad(RandomAccessIterator first, RandomAccessIterator last,
    150153             bool sorted=false);
    151154
     
    166169  /// @return median of range
    167170  ///
    168   template <class RandomAccessIterator> 
    169   double median(RandomAccessIterator first, RandomAccessIterator last, 
    170                 bool sorted=false); 
     171  template <class RandomAccessIterator>
     172  double median(RandomAccessIterator first, RandomAccessIterator last,
     173                bool sorted=false);
    171174
    172175
     
    184187     Function is a non-mutable function, i.e., \a first and \a last
    185188     can be const_iterators.
    186      
     189
    187190     Requirements: RandomAccessIterator is an iterator over a range of
    188191     doubles (or any type being convertable to double).
    189      
     192
    190193     @return \a p'th percentile of range
    191194
     
    197200  */
    198201  template <class RandomAccessIterator>
    199   double percentile(RandomAccessIterator first, RandomAccessIterator last, 
     202  double percentile(RandomAccessIterator first, RandomAccessIterator last,
    200203                    double p, bool sorted=false) YAT_DEPRECATE;
    201204
    202205  /**
    203206     \see Percentiler
    204      
     207
    205208     \since new in yat 0.5
    206209   */
    207210  template <class RandomAccessIterator>
    208   double percentile2(RandomAccessIterator first, RandomAccessIterator last, 
     211  double percentile2(RandomAccessIterator first, RandomAccessIterator last,
    209212                     double p, bool sorted=false)
    210213  {
Note: See TracChangeset for help on using the changeset viewer.