Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext

Class template interval_view

boost::histogram::axis::interval_view — Lightweight bin view.

Synopsis

// In header: <boost/histogram/axis/interval_view.hpp>

template<typename Axis> 
class interval_view {
public:
  // construct/copy/destruct
  interval_view(const Axis &, index_type);
  interval_view(Axis &&, index_type) = delete;

  // public member functions
  decltype(auto) lower() const noexcept;
  decltype(auto) upper() const noexcept;
  decltype(auto) center() const noexcept;
  decltype(auto) width() const noexcept;
  template<typename BinType> bool operator==(const BinType &) const noexcept;
  template<typename BinType> bool operator!=(const BinType &) const noexcept;
};

Description

Represents the current bin interval.

interval_view public construct/copy/destruct

  1. interval_view(const Axis & axis, index_type idx);
  2. interval_view(Axis && axis, index_type idx) = delete;

interval_view public member functions

  1. decltype(auto) lower() const noexcept;
    Return lower edge of bin.
  2. decltype(auto) upper() const noexcept;
    Return upper edge of bin.
  3. decltype(auto) center() const noexcept;
    Return center of bin.
  4. decltype(auto) width() const noexcept;
    Return width of bin.
  5. template<typename BinType> bool operator==(const BinType & rhs) const noexcept;
  6. template<typename BinType> bool operator!=(const BinType & rhs) const noexcept;

PrevUpHomeNext