Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::Experimental::RHistFillContext< BinContentType > Class Template Reference

template<typename BinContentType>
class ROOT::Experimental::RHistFillContext< BinContentType >

A context to concurrently fill an RHist.

See also
RHistConcurrentFiller
Warning
This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 31 of file RHistFillContext.hxx.

Public Member Functions

 ~RHistFillContext ()
template<typename... A>
void Fill (const A &...args)
 Fill an entry into the histogram.
template<typename... A>
void Fill (const std::tuple< A... > &args)
 Fill an entry into the histogram.
template<typename... A>
void Fill (const std::tuple< A... > &args, RWeight weight)
 Fill an entry into the histogram with a weight.
void Flush ()
 Flush locally accumulated entries to the histogram.

Private Member Functions

 RHistFillContext (const RHistFillContext &)=delete
 RHistFillContext (RHist< BinContentType > &hist)
 RHistFillContext (RHistFillContext &&)=default
RHistFillContext & operator= (const RHistFillContext &)=delete
RHistFillContext & operator= (RHistFillContext &&)=default

Private Attributes

RHist< BinContentType > * fHist = nullptr
 A pointer to the filled histogram.
RHistStats fStats
 Local histogram statistics.

Friends

class RHistConcurrentFiller< BinContentType >

#include <ROOT/RHistFillContext.hxx>

Constructor & Destructor Documentation

◆ RHistFillContext() [1/3]

template<typename BinContentType>
ROOT::Experimental::RHistFillContext< BinContentType >::RHistFillContext ( RHist< BinContentType > & hist)
inlineexplicitprivate
See also
RHistConcurrentFiller::CreateFillContent()

Definition at line 42 of file RHistFillContext.hxx.

◆ RHistFillContext() [2/3]

template<typename BinContentType>
ROOT::Experimental::RHistFillContext< BinContentType >::RHistFillContext ( const RHistFillContext< BinContentType > & )
privatedelete

◆ RHistFillContext() [3/3]

template<typename BinContentType>
ROOT::Experimental::RHistFillContext< BinContentType >::RHistFillContext ( RHistFillContext< BinContentType > && )
privatedefault

◆ ~RHistFillContext()

template<typename BinContentType>
ROOT::Experimental::RHistFillContext< BinContentType >::~RHistFillContext ( )
inline

Definition at line 58 of file RHistFillContext.hxx.

Member Function Documentation

◆ Fill() [1/3]

template<typename BinContentType>
template<typename... A>
void ROOT::Experimental::RHistFillContext< BinContentType >::Fill ( const A &... args)
inline

Fill an entry into the histogram.

For weighted filling, pass an RWeight as the last argument. This is not available for integral bin content types (see RHistEngine::SupportsWeightedFilling).

If one of the arguments is outside the corresponding axis and flow bins are disabled, the entry will be silently discarded.

Throws an exception if the number of arguments does not match the axis configuration, or if an argument cannot be converted for the axis type at run-time.

Parameters
[in]argsthe arguments for each axis
See also
RHist::Fill(const A &...args)

Definition at line 111 of file RHistFillContext.hxx.

◆ Fill() [2/3]

template<typename BinContentType>
template<typename... A>
void ROOT::Experimental::RHistFillContext< BinContentType >::Fill ( const std::tuple< A... > & args)
inline

Fill an entry into the histogram.

If one of the arguments is outside the corresponding axis and flow bins are disabled, the entry will be silently discarded.

Throws an exception if the number of arguments does not match the axis configuration, or if an argument cannot be converted for the axis type at run-time.

Parameters
[in]argsthe arguments for each axis
See also
RHist::Fill(const std::tuple<A...> &args)

Definition at line 71 of file RHistFillContext.hxx.

◆ Fill() [3/3]

template<typename BinContentType>
template<typename... A>
void ROOT::Experimental::RHistFillContext< BinContentType >::Fill ( const std::tuple< A... > & args,
RWeight weight )
inline

Fill an entry into the histogram with a weight.

This overload is not available for integral bin content types (see RHistEngine::SupportsWeightedFilling).

If one of the arguments is outside the corresponding axis and flow bins are disabled, the entry will be silently discarded.

Throws an exception if the number of arguments does not match the axis configuration, or if an argument cannot be converted for the axis type at run-time.

Parameters
[in]argsthe arguments for each axis
[in]weightthe weight for this entry
See also
RHist::Fill(const std::tuple<A...> &args, RWeight weight)

Definition at line 91 of file RHistFillContext.hxx.

◆ Flush()

template<typename BinContentType>
void ROOT::Experimental::RHistFillContext< BinContentType >::Flush ( )
inline

Flush locally accumulated entries to the histogram.

Definition at line 121 of file RHistFillContext.hxx.

◆ operator=() [1/2]

template<typename BinContentType>
RHistFillContext & ROOT::Experimental::RHistFillContext< BinContentType >::operator= ( const RHistFillContext< BinContentType > & )
privatedelete

◆ operator=() [2/2]

template<typename BinContentType>
RHistFillContext & ROOT::Experimental::RHistFillContext< BinContentType >::operator= ( RHistFillContext< BinContentType > && )
privatedefault

◆ RHistConcurrentFiller< BinContentType >

template<typename BinContentType>
friend class RHistConcurrentFiller< BinContentType >
friend

Definition at line 31 of file RHistFillContext.hxx.

Member Data Documentation

◆ fHist

template<typename BinContentType>
RHist<BinContentType>* ROOT::Experimental::RHistFillContext< BinContentType >::fHist = nullptr
private

A pointer to the filled histogram.

Definition at line 36 of file RHistFillContext.hxx.

◆ fStats

template<typename BinContentType>
RHistStats ROOT::Experimental::RHistFillContext< BinContentType >::fStats
private

Local histogram statistics.

Definition at line 39 of file RHistFillContext.hxx.

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