histogram.h

// ---------------------------------------------------------------------
//
// Copyright (C) 1999 - 2018 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------

#ifndef dealii_histogram_h
#define dealii_histogram_h


#include <deal.II/base/config.h>

#include <deal.II/base/exceptions.h>

#include <deal.II/lac/vector.h>

#include <string>
#include <vector>

DEAL_II_NAMESPACE_OPEN


class Histogram
{
public:
  enum IntervalSpacing
  {
    linear,
    logarithmic
  };


  template <typename number>
  void
  evaluate(const std::vector<Vector<number>> &values,
           const std::vector<double> &        y_values,
           const unsigned int                 n_intervals,
           const IntervalSpacing              interval_spacing = linear);

  template <typename number>
  void
  evaluate(const Vector<number> &values,
           const unsigned int    n_intervals,
           const IntervalSpacing interval_spacing = linear);

  void
  write_gnuplot(std::ostream &out) const;

  static std::string
  get_interval_spacing_names();

  static IntervalSpacing
  parse_interval_spacing(const std::string &name);

  std::size_t
  memory_consumption() const;

  DeclExceptionMsg(ExcEmptyData,
                   "Your input argument to this function does not appear to "
                   "have any data in it.");
  DeclException2(ExcIncompatibleArraySize,
                 int,
                 int,
                 << "The two array sizes " << arg1 << " and " << arg2
                 << " must match, but don't.");
  DeclException1(ExcInvalidName,
                 std::string,
                 << "The given name <" << arg1
                 << "> does not match any of the known formats.");

private:
  struct Interval
  {
    Interval(const double left_point, const double right_point);

    std::size_t
    memory_consumption() const;

    double left_point;

    double right_point;

    unsigned int content;
  };

  template <typename number>
  static bool
  logarithmic_less(const number n1, const number n2);

  std::vector<std::vector<Interval>> intervals;

  std::vector<double> y_values;
};


DEAL_II_NAMESPACE_CLOSE

#endif