descriptiveStats.hpp

Go to the documentation of this file.

/*

Copyright (C) 2003-2009 Kevin Thornton, krthornt[]@[]uci.edu

Remove the brackets to email me.

This file is part of libsequence.

libsequence is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

libsequence is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
long with libsequence.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef __DESCRIPTIVE_STATS_H__
#define __DESCRIPTIVE_STATS_H__

#include <type_traits>
#include <utility>

namespace Sequence
{

  template<typename iterator> 
  double mean(iterator beg, iterator end);

  template<typename iterator> 
  double variance(iterator beg, iterator end);

  template<typename ForwardIterator> 
  std::pair<double,double> meanAndVar(ForwardIterator beg,
                                      ForwardIterator end);

  template< typename T >
  class Sums
  {
  public:
    //T must be convertible to floating_type via a typecast
    static_assert( std::is_convertible<T,double>::value,
                   "T must be convertible to double");
  private:
    T __sum,__sumsq;
    unsigned __n;
  public:
    Sums();
    Sums<T> & operator+=(const T &);
    Sums<T> & operator+=(const Sums<T> &);
    const T & sum() const;
    const T & sumSquares() const;
    double mean() const;
    double variance() const;
  };

  template<typename T>
  const Sums<T> operator+(const Sums<T> & lhs,const Sums<T> & rhs);

  template<typename T>
  const Sums<T> operator+(const Sums<T> & lhs,const T & rhs);

}//namespace Sequence
#include <Sequence/bits/descriptiveStats.tcc>
#endif