histogram.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 1999 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.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