Logo ROOT  

Reference Guide
List of all members | Public Types | Public Member Functions | Private Attributes | List of all members
ROOT::Experimental::Detail::RHistBinRef< HISTIMPL > Class Template Reference

template<class HISTIMPL>
class ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >

Represents a bin reference.

Value of the bin iteration.

Provides access to bin content, bin geometry (from, to, center), and statistics (for instance higher moments) associated to the bin.

Definition at line 34 of file RHistBinIter.hxx.

Public Types

using CoordArray_t = typename HISTIMPL::CoordArray_t
 
using HistBinStat_t = decltype(((HISTIMPL *) 0x123) ->GetStat().GetView(1))
 
using HistImpl_t = HISTIMPL
 
using Weight_t = typename HISTIMPL::Weight_t
 

Public Member Functions

 RHistBinRef (HistImpl_t &hist, size_t idx)
 Construct from a histogram. More...
 
Statistics operations

Get the bin content (or reference to it, for non-const HistImpl_t).

auto GetContent ()
 
double GetUncertainty () const
 Get the bin uncertainty. More...
 
HistBinStat_t GetStat () const
 Get a (const, for const HistImpl_t) reference to the bin-view of the histogram statistics (uncertainty etc). More...
 
Bin operations

Get the bin center as an array over all dimensions.

CoordArray_t GetCenter () const
 
CoordArray_t GetFrom () const
 Get the bin lower edge as an array over all dimensions. More...
 
CoordArray_t GetTo () const
 Get the bin upper edge as an array over all dimensions. More...
 

Private Attributes

HistImpl_t * fHist {nullptr}
 The bin's histogram. More...
 
size_t fIndex {0}
 Bin index. More...
 
HistBinStat_t fStatView
 

#include <ROOT/RHistBinIter.hxx>

Member Typedef Documentation

◆ CoordArray_t

template<class HISTIMPL >
using ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::CoordArray_t = typename HISTIMPL::CoordArray_t

Definition at line 37 of file RHistBinIter.hxx.

◆ HistBinStat_t

template<class HISTIMPL >
using ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::HistBinStat_t = decltype(((HISTIMPL *)0x123)->GetStat().GetView(1))

Definition at line 39 of file RHistBinIter.hxx.

◆ HistImpl_t

template<class HISTIMPL >
using ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::HistImpl_t = HISTIMPL

Definition at line 36 of file RHistBinIter.hxx.

◆ Weight_t

template<class HISTIMPL >
using ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::Weight_t = typename HISTIMPL::Weight_t

Definition at line 38 of file RHistBinIter.hxx.

Constructor & Destructor Documentation

◆ RHistBinRef()

template<class HISTIMPL >
ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::RHistBinRef ( HistImpl_t &  hist,
size_t  idx 
)
inline

Construct from a histogram.

Definition at line 48 of file RHistBinIter.hxx.

Member Function Documentation

◆ GetCenter()

template<class HISTIMPL >
CoordArray_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetCenter ( ) const
inline

Definition at line 66 of file RHistBinIter.hxx.

◆ GetContent()

template<class HISTIMPL >
auto ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetContent ( )
inline

Definition at line 53 of file RHistBinIter.hxx.

◆ GetFrom()

template<class HISTIMPL >
CoordArray_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetFrom ( ) const
inline

Get the bin lower edge as an array over all dimensions.

Definition at line 69 of file RHistBinIter.hxx.

◆ GetStat()

template<class HISTIMPL >
HistBinStat_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetStat ( ) const
inline

Get a (const, for const HistImpl_t) reference to the bin-view of the histogram statistics (uncertainty etc).

Definition at line 60 of file RHistBinIter.hxx.

◆ GetTo()

template<class HISTIMPL >
CoordArray_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetTo ( ) const
inline

Get the bin upper edge as an array over all dimensions.

Definition at line 72 of file RHistBinIter.hxx.

◆ GetUncertainty()

template<class HISTIMPL >
double ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::GetUncertainty ( ) const
inline

Get the bin uncertainty.

Definition at line 56 of file RHistBinIter.hxx.

Member Data Documentation

◆ fHist

template<class HISTIMPL >
HistImpl_t* ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::fHist {nullptr}
private

The bin's histogram.

Definition at line 43 of file RHistBinIter.hxx.

◆ fIndex

template<class HISTIMPL >
size_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::fIndex {0}
private

Bin index.

Definition at line 42 of file RHistBinIter.hxx.

◆ fStatView

template<class HISTIMPL >
HistBinStat_t ROOT::Experimental::Detail::RHistBinRef< HISTIMPL >::fStatView
private

Definition at line 44 of file RHistBinIter.hxx.

The documentation for this class was generated from the following file: