Statistical variable, defined by its mean and variance (RMS).

Named, streamable, storable and mergeable.

Definition at line 33 of file TStatistic.h.

Public Member Functions
	TStatistic (const char name, Int_t n, const Double_t val, const Double_t *w=nullptr)
	Constructor from a vector of values.

	TStatistic (const char *name="")

	~TStatistic () override
	TStatistic destructor.

void	Fill (Double_t val, Double_t w=1.)
	Increment the entries in the object by one value-weight pair.

Double_t	GetM2 () const

Double_t	GetMax () const

Double_t	GetMean () const

Double_t	GetMeanErr () const

Double_t	GetMin () const

Long64_t	GetN () const

const char *	GetName () const override
	Returns name of object.

Long64_t	GetNeff () const

Double_t	GetRMS () const

Double_t	GetVar () const

Double_t	GetW () const

Double_t	GetW2 () const

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

void	ls (Option_t *opt="") const override
	The ls function lists the contents of a class on stdout.

Int_t	Merge (TCollection *in)
	Merge implementation of TStatistic.

void	Print (Option_t *="") const override
	Print the content of the object.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Attributes
Double_t	fM
	Sum of elements (i.e. sum of (val * weight) pairs.

Double_t	fM2
	Second order momentum.

Double_t	fMax
	Maximum value in the TStatistic object.

Double_t	fMin
	Minimum value in the TStatistic object.

Long64_t	fN
	Number of fills.

TString	fName
	Name given to the TStatistic object.

Double_t	fW
	Sum of weights.

Double_t	fW2
	Sum of squared weights.

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TStatistic.h>

Inheritance diagram for TStatistic:

[legend]

Constructor & Destructor Documentation

◆ TStatistic() [1/2]

TStatistic::TStatistic ( const char * name = "" )

inline

Definition at line 47 of file TStatistic.h.

◆ TStatistic() [2/2]

TStatistic::TStatistic	(	const char *	name,
		Int_t	n,
		const Double_t *	val,
		const Double_t *	w = `nullptr`
	)

Constructor from a vector of values.

Parameters

[in]	name	The name given to the object
[in]	n	The total number of entries
[in]	val	The vector of values
[in]	w	The vector of weights for the values

Recursively calls the TStatistic::Fill() function to fill the object.

Definition at line 35 of file TStatistic.cxx.

◆ ~TStatistic()

TStatistic::~TStatistic ( )

override

TStatistic destructor.

Definition at line 52 of file TStatistic.cxx.

Member Function Documentation

◆ Class()

static TClass * TStatistic::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TStatistic::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TStatistic::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 77 of file TStatistic.h.

◆ DeclFileName()

static const char * TStatistic::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 77 of file TStatistic.h.

◆ Fill()

void TStatistic::Fill	(	Double_t	val,
		Double_t	w = `1.`
	)

Increment the entries in the object by one value-weight pair.

Parameters

[in]	val	Value to fill the Tstatistic with
[in]	w	The weight of the value

Also updates statistics in the object. For number of entries, sum of weights, sum of squared weights and sum of (value*weight), one extra value is added to the statistic. For the sum of squared (value*weight) pairs, the function uses formula 1.4 in Chan-Golub, LeVeque : Algorithms for computing the Sample Variance (1983), generalized by LM for the case of weights:

\[ \frac{w_j}{\sum_{i=0}^{j} w_i \cdot \sum_{i=0}^{j-1} w_i} \cdot \left( \sum_{i=0}^{j} w_i \cdot val_i - \sum_{i=0}^{j} \left(w_i \cdot val_i\right) \right) \]

The minimum(maximum) is computed by checking that the fill value is either less(greater) than the current minimum(maximum)

Definition at line 78 of file TStatistic.cxx.

◆ GetM2()

Double_t TStatistic::GetM2 ( ) const

inline

Definition at line 57 of file TStatistic.h.

◆ GetMax()

Double_t TStatistic::GetMax ( ) const

inline

Definition at line 65 of file TStatistic.h.

◆ GetMean()

Double_t TStatistic::GetMean ( ) const

inline

Definition at line 58 of file TStatistic.h.

◆ GetMeanErr()

Double_t TStatistic::GetMeanErr ( ) const

inline

Definition at line 59 of file TStatistic.h.

◆ GetMin()

Double_t TStatistic::GetMin ( ) const

inline

Definition at line 64 of file TStatistic.h.

◆ GetN()

Long64_t TStatistic::GetN ( ) const

inline

Definition at line 55 of file TStatistic.h.

◆ GetName()

const char * TStatistic::GetName ( ) const

inlineoverridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 52 of file TStatistic.h.

◆ GetNeff()

Long64_t TStatistic::GetNeff ( ) const

inline

Definition at line 56 of file TStatistic.h.

◆ GetRMS()

Double_t TStatistic::GetRMS ( ) const

inline

Definition at line 60 of file TStatistic.h.

◆ GetVar()

Double_t TStatistic::GetVar ( ) const

inline

Definition at line 61 of file TStatistic.h.

◆ GetW()

Double_t TStatistic::GetW ( ) const

inline

Definition at line 62 of file TStatistic.h.

◆ GetW2()

Double_t TStatistic::GetW2 ( ) const

inline

Definition at line 63 of file TStatistic.h.

◆ Hash()

ULong_t TStatistic::Hash ( ) const

inlineoverridevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:395

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

TObject

Mother of all ROOT objects.

Definition TObject.h:41

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:1005

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2498

TStatistic::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TStatistic.h:53

Reimplemented from TObject.

Definition at line 53 of file TStatistic.h.

◆ IsA()

TClass * TStatistic::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 77 of file TStatistic.h.

◆ ls()

void TStatistic::ls ( Option_t * option = "" ) const

inlineoverridevirtual

The ls function lists the contents of a class on stdout.

Ls output is typically much less verbose then Dump().

Reimplemented from TObject.

Definition at line 75 of file TStatistic.h.

◆ Merge()

Int_t TStatistic::Merge ( TCollection * in )

Merge implementation of TStatistic.

Parameters

[in] in Other TStatistic objects to be added to the current one

The function merges the statistics of all objects together to form a new one. Merging quantities is done via simple addition for the following class data members:

number of entries fN
the sum of weights fW
the sum of squared weights fW2
the sum of (value*weight) fM

The sum of squared (value*weight) pairs fM2 is updated using the same formula as in TStatistic::Fill() function.

The minimum(maximum) is updated by checking that the minimum(maximum) of the next TStatistic object in the queue is either less(greater) than the current minimum(maximum).

Definition at line 137 of file TStatistic.cxx.

◆ Print()

void TStatistic::Print ( Option_t * = "" ) const

overridevirtual

Print the content of the object.

Prints the statistics held by the object in one line. These include the mean, mean error, RMS, the total number of values, the minimum and the maximum.

Reimplemented from TObject.

Definition at line 115 of file TStatistic.cxx.

◆ Streamer()

void TStatistic::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TStatistic::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 77 of file TStatistic.h.

Member Data Documentation

◆ fM

Double_t TStatistic::fM

private

Sum of elements (i.e. sum of (val * weight) pairs.

Definition at line 40 of file TStatistic.h.

◆ fM2

Double_t TStatistic::fM2

private

Second order momentum.

Definition at line 41 of file TStatistic.h.

◆ fMax

Double_t TStatistic::fMax

private

Maximum value in the TStatistic object.

Definition at line 43 of file TStatistic.h.

◆ fMin

Double_t TStatistic::fMin

private

Minimum value in the TStatistic object.

Definition at line 42 of file TStatistic.h.

◆ fN

Long64_t TStatistic::fN

private

Number of fills.

Definition at line 37 of file TStatistic.h.

◆ fName

TString TStatistic::fName

private

Name given to the TStatistic object.

Definition at line 36 of file TStatistic.h.

◆ fW

Double_t TStatistic::fW

private

Sum of weights.

Definition at line 38 of file TStatistic.h.

◆ fW2

Double_t TStatistic::fW2

private

Sum of squared weights.

Definition at line 39 of file TStatistic.h.

Libraries for TStatistic:

[legend]

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

math/mathcore/inc/TStatistic.h
math/mathcore/src/TStatistic.cxx

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TStatistic() [1/2]

◆ TStatistic() [2/2]

◆ ~TStatistic()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Fill()

◆ GetM2()

◆ GetMax()

◆ GetMean()

◆ GetMeanErr()

◆ GetMin()

◆ GetN()

◆ GetName()

◆ GetNeff()

◆ GetRMS()

◆ GetVar()

◆ GetW()

◆ GetW2()

◆ Hash()

◆ IsA()

◆ ls()

◆ Merge()

◆ Print()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fM

◆ fM2

◆ fMax

◆ fMin

◆ fN

◆ fName

◆ fW

◆ fW2