Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ROOT::Experimental::Internal::RAxes Class Referencefinal

Bin configurations for all dimensions of a histogram.

Definition at line 39 of file RAxes.hxx.

Public Member Functions

 RAxes (std::vector< RAxisVariant > axes)
 
template<std::size_t N>
RLinearizedIndex ComputeGlobalIndex (const std::array< RBinIndex, N > &indices) const
 Compute the global index for all axes.
 
template<typename... A>
RLinearizedIndex ComputeGlobalIndex (const std::tuple< A... > &args) const
 Compute the global index for all axes.
 
std::size_t ComputeTotalNBins () const
 Compute the total number of bins for all axes.
 
const std::vector< RAxisVariant > & Get () const
 
std::size_t GetNDimensions () const
 
void Streamer (TBuffer &)
 ROOT Streamer function to throw when trying to store an object of this class.
 

Private Member Functions

template<std::size_t N, typename... A>
RLinearizedIndex ComputeGlobalIndexImpl (const std::tuple< A... > &args) const
 
template<std::size_t I, std::size_t N, typename... A>
RLinearizedIndex ComputeGlobalIndexImpl (std::size_t index, const std::tuple< A... > &args) const
 

Private Attributes

std::vector< RAxisVariant > fAxes
 

Friends

template<typename T >
class ::ROOT::Experimental::RHistEngine
 
bool operator!= (const RAxes &lhs, const RAxes &rhs)
 
bool operator== (const RAxes &lhs, const RAxes &rhs)
 

#include <ROOT/RAxes.hxx>

Constructor & Destructor Documentation

◆ RAxes()

ROOT::Experimental::Internal::RAxes::RAxes ( std::vector< RAxisVariant > axes)
inlineexplicit
Parameters
[in]axesthe axis objects, must have size > 0

Definition at line 47 of file RAxes.hxx.

Member Function Documentation

◆ ComputeGlobalIndex() [1/2]

template<std::size_t N>
RLinearizedIndex ROOT::Experimental::Internal::RAxes::ComputeGlobalIndex ( const std::array< RBinIndex, N > & indices) const
inline

Compute the global index for all axes.

Parameters
[in]indicesthe array of RBinIndex
Returns
the global index that may be invalid

Definition at line 130 of file RAxes.hxx.

◆ ComputeGlobalIndex() [2/2]

template<typename... A>
RLinearizedIndex ROOT::Experimental::Internal::RAxes::ComputeGlobalIndex ( const std::tuple< A... > & args) const
inline

Compute the global index for all axes.

Parameters
[in]argsthe arguments
Returns
the global index that may be invalid

Definition at line 117 of file RAxes.hxx.

◆ ComputeGlobalIndexImpl() [1/2]

template<std::size_t N, typename... A>
RLinearizedIndex ROOT::Experimental::Internal::RAxes::ComputeGlobalIndexImpl ( const std::tuple< A... > & args) const
inlineprivate

Definition at line 106 of file RAxes.hxx.

◆ ComputeGlobalIndexImpl() [2/2]

template<std::size_t I, std::size_t N, typename... A>
RLinearizedIndex ROOT::Experimental::Internal::RAxes::ComputeGlobalIndexImpl ( std::size_t index,
const std::tuple< A... > & args ) const
inlineprivate

Definition at line 82 of file RAxes.hxx.

◆ ComputeTotalNBins()

std::size_t ROOT::Experimental::Internal::RAxes::ComputeTotalNBins ( ) const
inline

Compute the total number of bins for all axes.

It is the product of each dimension's total number of bins.

Returns
the total number of bins

Definition at line 65 of file RAxes.hxx.

◆ Get()

const std::vector< RAxisVariant > & ROOT::Experimental::Internal::RAxes::Get ( ) const
inline

Definition at line 55 of file RAxes.hxx.

◆ GetNDimensions()

std::size_t ROOT::Experimental::Internal::RAxes::GetNDimensions ( ) const
inline

Definition at line 54 of file RAxes.hxx.

◆ Streamer()

void ROOT::Experimental::Internal::RAxes::Streamer ( TBuffer & )
inline

ROOT Streamer function to throw when trying to store an object of this class.

Definition at line 158 of file RAxes.hxx.

Friends And Related Symbol Documentation

◆ ::ROOT::Experimental::RHistEngine

template<typename T >
friend class ::ROOT::Experimental::RHistEngine
friend

Definition at line 41 of file RAxes.hxx.

◆ operator!=

bool operator!= ( const RAxes & lhs,
const RAxes & rhs )
friend

Definition at line 58 of file RAxes.hxx.

◆ operator==

bool operator== ( const RAxes & lhs,
const RAxes & rhs )
friend

Definition at line 57 of file RAxes.hxx.

Member Data Documentation

◆ fAxes

std::vector<RAxisVariant> ROOT::Experimental::Internal::RAxes::fAxes
private

Definition at line 43 of file RAxes.hxx.

Libraries for ROOT::Experimental::Internal::RAxes:
[legend]
The documentation for this class was generated from the following file: