histogram.h

Go to the documentation of this file.

/*
 * Copyright 2009-2025 The VOTCA Development Team (http://www.votca.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef VOTCA_TOOLS_HISTOGRAM_H
#define VOTCA_TOOLS_HISTOGRAM_H
 
// Standard includes
#include <cmath>
#include <limits>
 
// Local VOTCA includes
#include "table.h"
 
namespace votca {
namespace tools {

class Histogram {
 public:
  void Initialize(double min, double max, Index nbins);

  void Process(const double &v, double scale = 1.0);

  template <typename iterator_type>
  void ProcessRange(const iterator_type &begin, const iterator_type &end);

  double getMin() const { return min_; }

  double getMax() const { return max_; }

  Index getNBins() const { return nbins_; }

  double getMinBinVal() const;

  double getMaxBinVal() const;
  std::pair<double, double> getInterval(Index bin) const;

  double getStep() const { return step_; }

  void Normalize();

  void Clear();

  Table &data() { return data_; }
  const Table &data() const { return data_; }

  void setPeriodic(bool periodic) { periodic_ = periodic; }
 
 private:
  void Initialize_();
  double min_ = 0;
  double max_ = 0;
  double step_ = 0;
  bool periodic_ = false;
  Index nbins_ = 100;
  Table data_;
};
 
inline std::ostream &operator<<(std::ostream &out, Histogram &h) {
  out << h.data();
  return out;
}
 
template <typename iterator_type>
inline void Histogram::ProcessRange(const iterator_type &begin,
                                    const iterator_type &end) {
  for (iterator_type iter = begin; iter != end; ++iter) {
    Process(*iter);
  }
}
}  // namespace tools
}  // namespace votca
#endif  // VOTCA_TOOLS_HISTOGRAM_H