ROOT::Detail::RDF::RMergeableMean Class Reference

Specialization of RMergeableValue for the Mean action.

This subclass is responsible for merging results coming from Mean actions. Other than the result itself, the number of entries that were used to compute that mean is also stored in the object.

Definition at line 359 of file RMergeableValue.hxx.

Public Member Functions
	RMergeableMean ()=default
	Default constructor.
	RMergeableMean (const RMergeableMean &)=delete
	RMergeableMean (Double_t value, ULong64_t counts)
	Constructor that initializes data members.
	RMergeableMean (RMergeableMean &&)=delete
RMergeableMean &	operator= (const RMergeableMean &)=delete
RMergeableMean &	operator= (RMergeableMean &&)=delete
Public Member Functions inherited from ROOT::Detail::RDF::RMergeableValue< Double_t >
	RMergeableValue ()=default
	Default constructor.
	RMergeableValue (const Double_t &value)
	Constructor taking the action result by const reference.
	RMergeableValue (const RMergeableValue &)=delete
	RMergeableValue (RMergeableValue &&)=delete
const Double_t &	GetValue () const
	Retrieve the result wrapped by this mergeable.
RMergeableValue &	operator= (const RMergeableValue &)=delete
RMergeableValue &	operator= (RMergeableValue &&)=delete
Public Member Functions inherited from ROOT::Detail::RDF::RMergeableValueBase
	RMergeableValueBase ()=default
	Default constructor.
	RMergeableValueBase (const RMergeableValueBase &)=delete
	RMergeableValueBase (RMergeableValueBase &&)=delete
virtual	~RMergeableValueBase ()=default
RMergeableValueBase &	operator= (const RMergeableValueBase &)=delete
RMergeableValueBase &	operator= (RMergeableValueBase &&)=delete

Private Member Functions
void	Merge (const RMergeableValue< Double_t > &other) final
	Aggregate the information contained in another RMergeableValue into this.

Private Attributes
ULong64_t	fCounts
	The number of entries used to compute the mean.

Additional Inherited Members
Protected Attributes inherited from ROOT::Detail::RDF::RMergeableValue< Double_t >
Double_t	fValue

#include <ROOT/RDF/RMergeableValue.hxx>

Inheritance diagram for ROOT::Detail::RDF::RMergeableMean:

Constructor & Destructor Documentation

RMergeableMean() [1/4]

ROOT::Detail::RDF::RMergeableMean::RMergeableMean ( Double_t  value, ULong64_t  counts  )

inline

Constructor that initializes data members.

Parameters

[in]	value	The action result.
[in]	counts	The number of entries used to compute that result.

Definition at line 401 of file RMergeableValue.hxx.

RMergeableMean() [2/4]

ROOT::Detail::RDF::RMergeableMean::RMergeableMean ( )

default

Default constructor.

Needed to allow serialization of ROOT objects. See [TBufferFile::WriteObjectClass] (classTBufferFile.html::a209078a4cb58373b627390790bf0c9c1)

RMergeableMean() [3/4]

ROOT::Detail::RDF::RMergeableMean::RMergeableMean ( const RMergeableMean &  )

delete

RMergeableMean() [4/4]

ROOT::Detail::RDF::RMergeableMean::RMergeableMean ( RMergeableMean &&  )

delete

Member Function Documentation

Merge()

void ROOT::Detail::RDF::RMergeableMean::Merge ( const RMergeableValue< Double_t > &  other )

inlinefinalprivatevirtual

Aggregate the information contained in another RMergeableValue into this.

Parameters

[in]

other

Another RMergeableValue object.

Exceptions

std::invalid_argument

If the cast of the other object to the same type as this one fails.

The other RMergeableValue object is cast to the same type as this object. This is needed to make sure that only results of the same type of action are merged together. The function then computes the weighted mean of the two means held by the mergeables.

Note

All the Merge methods in the RMergeableValue family are private. To merge multiple RMergeableValue objects please use [MergeValues] (namespaceROOT_1_1Detail_1_1RDF.html::af16fefbe2d120983123ddf8a1e137277).

Implements ROOT::Detail::RDF::RMergeableValue< Double_t >.

Definition at line 377 of file RMergeableValue.hxx.

operator=() [1/2]

RMergeableMean & ROOT::Detail::RDF::RMergeableMean::operator= ( const RMergeableMean &  )

delete

operator=() [2/2]

RMergeableMean & ROOT::Detail::RDF::RMergeableMean::operator= ( RMergeableMean &&  )

delete

Member Data Documentation

fCounts

ULong64_t ROOT::Detail::RDF::RMergeableMean::fCounts

private

The number of entries used to compute the mean.

Definition at line 360 of file RMergeableValue.hxx.

Libraries for ROOT::Detail::RDF::RMergeableMean:

---

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

• tree/dataframe/inc/ROOT/RDF/RMergeableValue.hxx