Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Struct unsafe_access

boost::histogram::unsafe_access — Unsafe read/write access to classes that potentially break consistency.

Synopsis

// In header: <boost/histogram/unsafe_access.hpp>


struct unsafe_access {

  // public static functions
  template<typename Histogram> static auto & axes(Histogram &);
  template<typename Histogram> static const auto & axes(const Histogram &);
  template<typename Histogram, unsigned I = 0> 
    static decltype(auto) 
    axis(Histogram &, std::integral_constant< unsigned, I > = {});
  template<typename Histogram> 
    static decltype(auto) axis(Histogram &, unsigned);
  template<typename Histogram> static auto & storage(Histogram &);
  template<typename Histogram> static const auto & storage(const Histogram &);
};

Description

unsafe_access public static functions

  1. template<typename Histogram> static auto & axes(Histogram & hist);
    Get axes.

    Parameters:

    hist

    histogram.

  2. template<typename Histogram> static const auto & axes(const Histogram & hist);
    Get axes.

    Parameters:

    hist

    histogram.

  3. template<typename Histogram, unsigned I = 0> 
      static decltype(auto) 
      axis(Histogram & hist, std::integral_constant< unsigned, I > = {});
    Get mutable axis reference with compile-time number.

    Parameters:

    hist

    histogram.

    Template Parameters:

    I

    axis index (optional, default: 0).

  4. template<typename Histogram> 
      static decltype(auto) axis(Histogram & hist, unsigned i);
    Get mutable axis reference with run-time number.

    Parameters:

    hist

    histogram.

    i

    axis index.

  5. template<typename Histogram> static auto & storage(Histogram & hist);
    Get storage.

    Parameters:

    hist

    histogram.

  6. template<typename Histogram> 
      static const auto & storage(const Histogram & hist);
    Get storage.

    Parameters:

    hist

    histogram.


PrevUpHomeNext