AveragerPair.h

#ifndef _theplu_yat_statistics_averagerpair_
#define _theplu_yat_statistics_averagerpair_

// $Id: AveragerPair.h 3550 2017-01-03 05:41:02Z peter $

/*
  Copyright (C) 2004, 2005 Jari Häkkinen, Peter Johansson
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009, 2010, 2011, 2016 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library 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.

  The yat library 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
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "Averager.h"

#include "yat/utility/iterator_traits.h"

#include <boost/concept_check.hpp>
#include <boost/iterator/iterator_concepts.hpp>

#include <cmath>
#include <utility>

namespace theplu{
namespace yat{
namespace statistics{

  class AveragerPair
  {
  public:

    AveragerPair(void);

    AveragerPair(const AveragerPair&);

    void add(const double x, const double y, const long n=1);

    double ccc(void) const;

    double correlation(void) const;

    double covariance(void) const;

    double mean_xy(void) const;

    double msd(void) const;

    long n(void) const;

    void reset(void);

    double sum_xy(void) const;

    double sum_squared_deviation(void) const;

    double sum_xy_centered(void) const;

    const Averager& x_averager(void) const;

    const Averager& y_averager(void) const;

    const AveragerPair& operator=(const AveragerPair& a);

    const AveragerPair& operator+=(const AveragerPair&);

  private:
    Averager x_;
    Averager y_;
    double  xy_centered_;

    void xy_add(double mx, double my, double xy_centered, long n);
  };

  template <class InputIterator1, class InputIterator2>
  void add(AveragerPair& ap, InputIterator1 first1, InputIterator1 last1,
           InputIterator2 first2)
  {
    BOOST_CONCEPT_ASSERT((boost_concepts::ReadableIterator<InputIterator1>));
    BOOST_CONCEPT_ASSERT((boost_concepts::SinglePassIterator<InputIterator1>));
    BOOST_CONCEPT_ASSERT((boost_concepts::ReadableIterator<InputIterator2>));
    BOOST_CONCEPT_ASSERT((boost_concepts::SinglePassIterator<InputIterator2>));

    utility::check_iterator_is_unweighted(first1);
    utility::check_iterator_is_unweighted(first2);
    for ( ; first1 != last1; ++first1, ++first2)
      ap.add(*first1, *first2);
  }


}}} // of namespace statistics, yat, and theplu

#endif