Histogram.h

#ifndef _theplu_yat_statistics_histogram_
#define _theplu_yat_statistics_histogram_

// $Id: Histogram.h 4207 2022-08-26 04:36:28Z peter $

/*
  Copyright (C) 2004 Jari Häkkinen
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson
  Copyright (C) 2006 Jari Häkkinen
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009, 2010, 2016, 2022 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 "AveragerWeighted.h"
#include "yat/utility/concept_check.h"
#include "yat/utility/iterator_traits.h"

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

#include <iosfwd>
#include <string>
#include <vector>

namespace theplu {
namespace yat {
namespace statistics {

  class Histogram
  {
  public:

    Histogram(void);

    Histogram(std::istream&);

    Histogram(const Histogram&);

    Histogram(const double xmin, const double xmax, const size_t n);

    virtual ~Histogram(void);

    int add(const double x,const double weight=1.0);

    const AveragerWeighted& averager_all(void) const;

    const AveragerWeighted& averager_histogram(void) const;

    size_t nof_bins(void) const;

    void normalize(bool choice = true);

    double observation_value(const size_t k) const;

    void rescale(double factor);

    void reset(void);

    double spacing(void) const;

    double xmax(void) const;

    double xmin(void) const;

    double operator[](size_t k) const;

    const Histogram& operator=(const Histogram&);

    const Histogram& operator+=(const Histogram& rhs);

  private:
    // Returns zero if outside boundaries
    size_t bin(double d);

    std::vector<double> histogram_;
    double xmax_;
    double xmin_;
    statistics::AveragerWeighted sum_all_;      // average of all data
    statistics::AveragerWeighted sum_histogram_;// average of data in histogram
  };

  template<typename Iterator>
  void add(Histogram& h, Iterator first, Iterator last)
  {
    BOOST_CONCEPT_ASSERT((boost_concepts::SinglePassIterator<Iterator>));
    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<Iterator>));
    utility::iterator_traits<Iterator> traits;
    while (first!=last) {
      h.add(traits.data(first), traits.weight(first));
      ++first;
    }
  }

  std::ostream& operator<<(std::ostream& s,const Histogram&);

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

#endif