ROOT::Experimental::RProfileFillContext Class Reference

A context to concurrently fill an RProfile.

See also

RProfileConcurrentFiller

Warning

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

Definition at line 28 of file RProfileFillContext.hxx.

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

Private Member Functions
	RProfileFillContext (const RProfileFillContext &)=delete
	RProfileFillContext (RProfile &profile)
	RProfileFillContext (RProfileFillContext &&)=default
RProfileFillContext &	operator= (const RProfileFillContext &)=delete
RProfileFillContext &	operator= (RProfileFillContext &&)=default

Private Attributes
RProfile *	fProfile = nullptr
	A pointer to the filled profile histogram.
RHistStats	fStats
	Local histogram statistics.

Friends
class	RProfileConcurrentFiller

#include <ROOT/RProfileFillContext.hxx>

Constructor & Destructor Documentation

RProfileFillContext() [1/3]

ROOT::Experimental::RProfileFillContext::RProfileFillContext ( RProfile & profile )

inlineexplicitprivate

See also

RProfileConcurrentFiller::CreateFillContent()

Definition at line 39 of file RProfileFillContext.hxx.

RProfileFillContext() [2/3]

ROOT::Experimental::RProfileFillContext::RProfileFillContext ( const RProfileFillContext & )

privatedelete

RProfileFillContext() [3/3]

ROOT::Experimental::RProfileFillContext::RProfileFillContext ( RProfileFillContext && )

privatedefault

~RProfileFillContext()

ROOT::Experimental::RProfileFillContext::~RProfileFillContext ( )

inline

Definition at line 55 of file RProfileFillContext.hxx.

Member Function Documentation

Fill() [1/3]

template<typename... A>

void ROOT::Experimental::RProfileFillContext::Fill ( const A &... args )

inline

Fill an entry into the profile histogram.

For weighted filling, pass an RWeight as the last argument.

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]

args

the arguments for each axis

See also

RProfile::Fill(const A &...args)

Definition at line 111 of file RProfileFillContext.hxx.

Fill() [2/3]

template<typename... A, typename V >

void ROOT::Experimental::RProfileFillContext::Fill ( const std::tuple< A... > & args, const V & value )

inline

Fill an entry into the profile 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]	args	the arguments for each axis
[in]	v	the additional argument

See also

RProfile::Fill(const std::tuple<A...> &args, const V &value)

Definition at line 69 of file RProfileFillContext.hxx.

Fill() [3/3]

template<typename... A, typename V >

void ROOT::Experimental::RProfileFillContext::Fill ( const std::tuple< A... > & args, const V & value, RWeight weight )

inline

Fill an entry into the profile histogram with a weight.

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]	args	the arguments for each axis
[in]	v	the additional argument
[in]	weight	the weight for this entry

See also

RProfile::Fill(const std::tuple<A...> &args, const V &value, RWeight weight)

Definition at line 90 of file RProfileFillContext.hxx.

Flush()

void ROOT::Experimental::RProfileFillContext::Flush ( )

inline

Flush locally accumulated entries to the profile histogram.

Definition at line 137 of file RProfileFillContext.hxx.

operator=() [1/2]

RProfileFillContext & ROOT::Experimental::RProfileFillContext::operator= ( const RProfileFillContext & )

privatedelete

operator=() [2/2]

RProfileFillContext & ROOT::Experimental::RProfileFillContext::operator= ( RProfileFillContext && )

privatedefault

Friends And Related Symbol Documentation

RProfileConcurrentFiller

friend class RProfileConcurrentFiller

friend

Definition at line 29 of file RProfileFillContext.hxx.

Member Data Documentation

fProfile

RProfile* ROOT::Experimental::RProfileFillContext::fProfile = nullptr

private

A pointer to the filled profile histogram.

Definition at line 33 of file RProfileFillContext.hxx.

fStats

RHistStats ROOT::Experimental::RProfileFillContext::fStats

private

Local histogram statistics.

Definition at line 36 of file RProfileFillContext.hxx.

Libraries for ROOT::Experimental::RProfileFillContext:

---

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

• hist/histv7/inc/ROOT/RProfileFillContext.hxx