THnSparseT< CONT > Class Template Reference

template<class CONT>
class THnSparseT< CONT >

Templated implementation of the abstract base THnSparse.

All functionality and the interfaces to be used are in THnSparse!

THnSparse does not know how to store any bin content itself. Instead, this is delegated to the derived, templated class: the template parameter decides what the format for the bin content is. In fact it even defines the array itself; possible implementations probably derive from TArray.

Typedefs exist for template parameters with ROOT's generic types:

Templated name	Typedef	Bin content type
THnSparseT<TArrayC>	THnSparseC	Char_t
THnSparseT<TArrayS>	THnSparseS	Short_t
THnSparseT<TArrayI>	THnSparseI	Int_t
THnSparseT<TArrayL>	THnSparseL	Long_t
THnSparseT<TArrayF>	THnSparseF	Float_t
THnSparseT<TArrayD>	THnSparseD	Double_t

We recommend to use THnSparseC wherever possible, and to map its value space of 256 possible values to e.g. float values outside the class. This saves an enormous amount of memory. Only if more than 256 values need to be distinguished should e.g. THnSparseS or even THnSparseF be chosen.

Implementation detail: the derived, templated class is kept extremely small on purpose. That way the (templated thus inlined) uses of this class will only create a small amount of machine code, in contrast to e.g. STL.

Definition at line 206 of file THnSparse.h.

Public Member Functions
	THnSparseT ()
	THnSparseT (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin=0, const Double_t *xmax=0, Int_t chunksize=1024 *16)
TArray *	GenerateArray () const
Public Member Functions inherited from THnSparse
virtual	~THnSparse ()
	Destruct a THnSparse.
void	AddBinContent (const Int_t *idx, Double_t v=1.)
	Forwards to THnBase::SetBinContent().
void	AddBinContent (Long64_t bin, Double_t v=1.)
	Add "v" to the content of bin with index "bin".
void	AddBinError2 (Long64_t bin, Double_t e2)
	Add "e" to error of bin with index "bin", enable errors if needed.
ROOT::Internal::THnBaseBinIter *	CreateIter (Bool_t respectAxisRange) const
	Create an iterator over all filled bins of a THnSparse.
Long64_t	GetBin (const char *name[]) const
Long64_t	GetBin (const char *name[], Bool_t allocate=kTRUE)
	Get the bin index for the n dimensional tuple addressed by "name", allocate one if it doesn't exist yet and "allocate" is true.
Long64_t	GetBin (const Double_t *x) const
Long64_t	GetBin (const Double_t *x, Bool_t allocate=kTRUE)
	Get the bin index for the n dimensional tuple x, allocate one if it doesn't exist yet and "allocate" is true.
Long64_t	GetBin (const Int_t *idx) const
Long64_t	GetBin (const Int_t *idx, Bool_t allocate=kTRUE)
	Get the bin index for the n dimensional coordinates coord, allocate one if it doesn't exist yet and "allocate" is true.
Double_t	GetBinContent (const Int_t *idx) const
	Forwards to THnBase::GetBinContent() overload.
Double_t	GetBinContent (Long64_t bin, Int_t *idx=0) const
	Return the content of the filled bin number "idx".
Double_t	GetBinError2 (Long64_t linidx) const
	Get square of the error of bin addressed by linidx as \(\sum weight^{2}\) If errors are not enabled (via Sumw2() or CalculateErrors()) return contents.
Int_t	GetChunkSize () const
Long64_t	GetNbins () const
Int_t	GetNChunks () const
Double_t	GetSparseFractionBins () const
	Return the amount of filled bins over all bins.
Double_t	GetSparseFractionMem () const
	Return the amount of used memory over memory that would be used by a non-sparse n-dimensional histogram.
THnSparse *	Projection (Int_t ndim, const Int_t *dim, Option_t *option="") const
TH3D *	Projection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
	Forwards to THnBase::Projection().
TH1D *	Projection (Int_t xDim, Option_t *option="") const
	Forwards to THnBase::Projection().
TH2D *	Projection (Int_t yDim, Int_t xDim, Option_t *option="") const
	Forwards to THnBase::Projection().
THnSparse *	Rebin (const Int_t *group) const
THnSparse *	Rebin (Int_t group) const
void	Reset (Option_t *option="")
	Clear the histogram.
void	SetBinContent (const Int_t *idx, Double_t v)
	Forwards to THnBase::SetBinContent().
void	SetBinContent (Long64_t bin, Double_t v)
	Set content of bin with index "bin" to "v".
void	SetBinError2 (Long64_t bin, Double_t e2)
	Set error of bin with index "bin" to "e", enable errors if needed.
void	SetFilledBins (Long64_t nbins)
void	Sumw2 ()
	Enable calculation of errors.
Public Member Functions inherited from THnBase
virtual	~THnBase ()
	Destruct a THnBase.
void	Add (const TH1 *hist, Double_t c=1.)
	Fill the THnBase with the bins of hist that have content or error != 0.
void	Add (const THnBase *h, Double_t c=1.)
	Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
void	AddBinContent (const Int_t *x, Double_t v=1.)
void	Browse (TBrowser *b)
	Browse a THnSparse: create an entry (ROOT::THnSparseBrowsable) for each dimension.
void	CalculateErrors (Bool_t calc=kTRUE)
	Calculate errors (or not if "calc" == kFALSE)
Double_t	ComputeIntegral ()
	Calculate the integral of the histogram.
void	Divide (const THnBase *h)
	Divide this histogram by h this = this/(h) Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
void	Divide (const THnBase *h1, const THnBase *h2, Double_t c1=1., Double_t c2=1., Option_t *option="")
	Replace contents of this histogram by multiplication of h1 by h2 this = (c1*h1)/(c2*h2) Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this if not already set.
Long64_t	Fill (const char *name[], Double_t w=1.)
Long64_t	Fill (const Double_t *x, Double_t w=1.)
template<typename... MoreTypes>
Long64_t	Fill (Double_t firstval, MoreTypes... morevals)
	Fill with the provided variadic arguments.
TFitResultPtr	Fit (TF1 *f1, Option_t *option="", Option_t *goption="")
	Fit a THnSparse with function f.
TAxis *	GetAxis (Int_t dim) const
Double_t	GetBinContent (const Int_t *idx) const
Double_t	GetBinError (const Int_t *idx) const
Double_t	GetBinError (Long64_t linidx) const
Bool_t	GetCalculateErrors () const
Double_t	GetEntries () const
TObjArray *	GetListOfAxes ()
const TObjArray *	GetListOfAxes () const
TList *	GetListOfFunctions ()
Int_t	GetNdimensions () const
void	GetRandom (Double_t *rand, Bool_t subBinRandom=kTRUE)
	Generate an n-dimensional random tuple based on the histogrammed distribution.
Double_t	GetSumw () const
Double_t	GetSumw2 () const
Double_t	GetSumwx (Int_t dim) const
Double_t	GetSumwx2 (Int_t dim) const
Double_t	GetWeightSum () const
Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t	IsInRange (Int_t *coord) const
	Check whether bin coord is in range, as defined by TAxis::SetRange().
Long64_t	Merge (TCollection *list)
	Merge this with a list of THnBase's.
void	Multiply (const THnBase *h)
	Multiply this histogram by histogram h this = this * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
void	Multiply (TF1 *f, Double_t c=1.)
	Performs the operation: this = this*c*f1 if errors are defined, errors are also recalculated.
void	Print (Option_t *option="") const
	Print a THnBase.
void	PrintBin (Int_t *coord, Option_t *options) const
void	PrintBin (Long64_t idx, Option_t *options) const
	Print bin with linex index "idx".
void	PrintEntries (Long64_t from=0, Long64_t howmany=-1, Option_t *options=0) const
	Print "howmany" entries starting at "from".
TH3D *	Projection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
	Project all bins into a 3-dimensional histogram, keeping only axes "xDim", "yDim", and "zDim".
TH1D *	Projection (Int_t xDim, Option_t *option="") const
	Project all bins into a 1-dimensional histogram, keeping only axis "xDim".
TH2D *	Projection (Int_t yDim, Int_t xDim, Option_t *option="") const
	Project all bins into a 2-dimensional histogram, keeping only axes "xDim" and "yDim".
THnBase *	ProjectionND (Int_t ndim, const Int_t *dim, Option_t *option="") const
void	RebinnedAdd (const THnBase *h, Double_t c=1.)
	Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
void	Scale (Double_t c)
	Scale contents and errors of this histogram by c: this = this * c It does not modify the histogram's number of entries.
void	SetBinContent (const Int_t *idx, Double_t v)
void	SetBinEdges (Int_t idim, const Double_t *bins)
	Set the axis # of bins and bin limits on dimension idim.
void	SetBinError (const Int_t *idx, Double_t e)
void	SetBinError (Long64_t bin, Double_t e)
void	SetEntries (Double_t entries)
void	SetTitle (const char *title)
	Change (i.e.
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed copy ctor.
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
	TNamed destructor.
virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").
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 two TNamed objects.
virtual void	Copy (TObject &named) const
	Copy this to obj.
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
virtual const char *	GetName () const
	Returns name of object.
virtual const char *	GetTitle () const
	Returns title of object.
virtual ULong_t	Hash () const
	Return hash value for this object.
virtual Bool_t	IsSortable () const
virtual void	ls (Option_t *option="") const
	List TNamed name and title.
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.
virtual void	SetName (const char *name)
	Set the name of the TNamed.
virtual void	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title).
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.
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.
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	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 for instance with: gROOT->SetSelectedPad(gPad).
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=0)
	Execute method on this object with the given parameter string, e.g.
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=0)
	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 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).
R__ALWAYS_INLINE Bool_t	IsOnHeap () 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.
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)
	Operator delete [].
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.
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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Additional Inherited Members
Public Types inherited from TObject
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
enum	EStatusBits {   kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,   kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }
Static Public Member Functions inherited from THnSparse
static THnSparse *	CreateSparse (const char *name, const char *title, const TH1 *h1, Int_t chunkSize=1024 *16)
static THnSparse *	CreateSparse (const char *name, const char *title, const THnBase *hn, Int_t chunkSize=1024 *16)
Static Public Member Functions inherited from TObject
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.
Protected Types inherited from THnBase
enum	{ kNoInt , kValidInt , kInvalidInt }
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }
Protected Member Functions inherited from THnSparse
	THnSparse ()
	Construct an empty THnSparse.
	THnSparse (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax, Int_t chunksize)
	Construct a THnSparse with "dim" dimensions, with chunksize as the size of the chunks.
THnSparseArrayChunk *	AddChunk ()
	Create a new chunk of bin content.
void	FillBin (Long64_t bin, Double_t w)
	Increment the bin content of "bin" by "w", return the bin index.
void	FillExMap ()
	We have been streamed; set up fBins.
Long64_t	GetBinIndexForCurrentBin (Bool_t allocate)
	Return the index for fCurrentBinIndex.
THnSparseArrayChunk *	GetChunk (Int_t idx) const
THnSparseCompactBinCoord *	GetCompactCoord () const
	Return THnSparseCompactBinCoord object.
void	InitStorage (Int_t *nbins, Int_t chunkSize)
	Initialize the storage of a histogram created via Init()
void	Reserve (Long64_t nbins)
	Initialize storage for nbins.
Protected Member Functions inherited from THnBase
	THnBase ()
	THnBase (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax)
	Construct a THnBase with "dim" dimensions, "nbins" holds the number of bins for each dimension; "xmin" and "xmax" the minimal and maximal value for each dimension.
	THnBase (const char *name, const char *title, Int_t dim, const Int_t *nbins, const std::vector< std::vector< double > > &xbins)
	THnBase (const THnBase &other)
	THnBase (THnBase &&other)
void	AddInternal (const THnBase *h, Double_t c, Bool_t rebinned)
	Add() implementation for both rebinned histograms and those with identical binning.
Bool_t	CheckConsistency (const THnBase *h, const char *tag) const
	Consistency check on (some of) the parameters of two histograms (for operations).
THnBase *	CloneEmpty (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
	Create a new THnBase object that is of the same type as *this, but with dimensions and bins given by axes.
TH1 *	CreateHist (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
	Create an empty histogram with name and title with a given set of axes.
void	FillBinBase (Double_t w)
	Increment the statistics due to filled weight "w",.
void	Init (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis, Int_t chunkSize=1024 *16)
	Initialize axes and name.
THnBase &	operator= (const THnBase &other)
THnBase &	operator= (THnBase &&other)
Bool_t	PrintBin (Long64_t idx, Int_t *coord, Option_t *options) const
	Print one bin.
TObject *	ProjectionAny (Int_t ndim, const Int_t *dim, Bool_t wantNDim, Option_t *option="") const
	Project all bins into a ndim-dimensional THn / THnSparse (whatever *this is) or if (ndim < 4 and !wantNDim) a TH1/2/3 histogram, keeping only axes in dim (specifying ndim dimensions).
THnBase *	RebinBase (const Int_t *group) const
	Combine the content of "group" neighboring bins for each dimension into a new bin and return the resulting THnBase.
THnBase *	RebinBase (Int_t group) const
	Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase.
void	ResetBase (Option_t *option="")
	Clear the histogram.
void	UpdateXStat (const Double_t *x, Double_t w=1.)
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 ()
Static Protected Member Functions inherited from THnBase
static THnBase *	CreateHnAny (const char *name, const char *title, const TH1 *h1, Bool_t sparse, Int_t chunkSize=1024 *16)
	Create a THn / THnSparse object from a histogram deriving from TH1.
static THnBase *	CreateHnAny (const char *name, const char *title, const THnBase *hn, Bool_t sparse, Int_t chunkSize=1024 *16)
	Create a THnSparse (if "sparse") or THn from "hn", possibly converting THn <-> THnSparse.
Protected Attributes inherited from THnBase
TObjArray	fAxes
	Axes of the histogram.
TObjArray	fBrowsables
	! Browser-helpers for each axis
Double_t	fEntries
	Number of entries, spread over chunks.
std::vector< Double_t >	fIntegral
	! vector with bin weight sums
enum THnBase:: { ... }	fIntegralStatus
	! status of integral
Int_t	fNdimensions
	Number of dimensions.
Double_t	fTsumw
	Total sum of weights.
Double_t	fTsumw2
	Total sum of weights squared; -1 if no errors are calculated.
TArrayD	fTsumwx
	Total sum of weight*X for each dimension.
TArrayD	fTsumwx2
	Total sum of weight*X*X for each dimension.
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle

#include <THnSparse.h>

Inheritance diagram for THnSparseT< CONT >:

Constructor & Destructor Documentation

THnSparseT() [1/2]

template<class CONT >

THnSparseT< CONT >::THnSparseT ( )

inline

Definition at line 208 of file THnSparse.h.

THnSparseT() [2/2]

template<class CONT >

THnSparseT< CONT >::THnSparseT ( const char *  name, const char *  title, Int_t  dim, const Int_t *  nbins, const Double_t *  xmin = 0, const Double_t *  xmax = 0, Int_t  chunksize = 1024 * 16  )

inline

Definition at line 209 of file THnSparse.h.

Member Function Documentation

GenerateArray()

template<class CONT >

TArray * THnSparseT< CONT >::GenerateArray ( ) const

inlinevirtual

Implements THnSparse.

Definition at line 214 of file THnSparse.h.