Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TFoamCell Class Reference

Used by TFoam.

Objects of this class are hyper-rectangular cells organized in the binary tree. Special algorithm for encoding relative positioning of the cells allow to save total memory allocation needed for the system of cells.

Definition at line 12 of file TFoamCell.h.

Public Member Functions

 TFoamCell ()
 Default constructor for streamer.
 
 TFoamCell (Int_t)
 User constructor allocating single empty Cell.
 
 TFoamCell (TFoamCell &&)=delete
 
 TFoamCell (TFoamCell const &)=delete
 
 ~TFoamCell () override
 Destructor.
 
void CalcVolume ()
 Calculates volume of the cell using size params which are calculated.
 
void Fill (Int_t, TFoamCell *, TFoamCell *, TFoamCell *)
 Fills in certain data into newly allocated cell.
 
Int_t GetBest () const
 
TFoamCell ** GetCells () const
 
TFoamCellGetDau0 () const
 
TFoamCellGetDau1 () const
 
Double_t GetDriv () const
 
void GetHcub (TFoamVect &, TFoamVect &) const
 Provides size and position of the cell These parameter are calculated by analyzing information in all parents cells up to the root cell.
 
void GetHSize (TFoamVect &) const
 Provides size of the cell Size parameters are calculated by analyzing information in all parents cells up to the root cell.
 
Double_t GetIntg () const
 
TFoamCellGetPare () const
 
Double_t GetPrim () const
 
Int_t GetSerial () const
 
Int_t GetStat () const
 
Double_t GetVolume () const
 
Double_t GetXdiv () const
 
TClassIsA () const override
 
TFoamCelloperator= (const TFoamCell &)=delete
 
TFoamCelloperator= (TFoamCell &&)=delete
 
void Print (Option_t *option) const override
 Printout of the cell geometry parameters for the debug purpose.
 
void SetBest (Int_t Best)
 
void SetCells (TFoamCell **cells)
 
void SetDau0 (TFoamCell *Daug)
 
void SetDau1 (TFoamCell *Daug)
 
void SetDriv (Double_t Driv)
 
void SetIntg (Double_t Intg)
 
void SetPrim (Double_t Prim)
 
void SetSerial (Int_t Serial)
 
void SetStat (Int_t Stat)
 
void SetXdiv (Double_t Xdiv)
 
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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns 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_tGetOption () 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.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
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)
 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)
 
TObjectoperator= (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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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

Int_t fBest
 Best Edge for division.
 
TFoamCell ** fCells = nullptr
 ! Array of ALL cells, owned by the TFoam object
 
TRef fDaught0
 Pointer to daughter 1.
 
Int_t fDaught0Idx = -1
 Serial number of daughter 1.
 
TRef fDaught1
 Pointer to daughter 2.
 
Int_t fDaught1Idx = -1
 Serial number of daughter 2.
 
Short_t fDim
 Dimension of the vector space.
 
Double_t fDrive
 Driver integral, only for cell build-up.
 
Double_t fIntegral
 Integral over cell (estimate from exploration)
 
TRef fParent
 Pointer to parent cell.
 
Int_t fParentIdx = -1
 Serial number of parent cell.
 
Double_t fPrimary
 Primary integral, only for MC generation.
 
Int_t fSerial
 Serial number.
 
Int_t fStatus
 Status (active, inactive)
 
Double_t fVolume
 Cartesian Volume of cell.
 
Double_t fXdiv
 Factor for division.
 

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 <TFoamCell.h>

Inheritance diagram for TFoamCell:
[legend]

Constructor & Destructor Documentation

◆ TFoamCell() [1/4]

TFoamCell::TFoamCell ( )

Default constructor for streamer.

Definition at line 24 of file TFoamCell.cxx.

◆ TFoamCell() [2/4]

TFoamCell::TFoamCell ( Int_t  kDim)

User constructor allocating single empty Cell.

Definition at line 31 of file TFoamCell.cxx.

◆ TFoamCell() [3/4]

TFoamCell::TFoamCell ( TFoamCell const &  )
delete

◆ TFoamCell() [4/4]

TFoamCell::TFoamCell ( TFoamCell &&  )
delete

◆ ~TFoamCell()

TFoamCell::~TFoamCell ( )
override

Destructor.

Definition at line 51 of file TFoamCell.cxx.

Member Function Documentation

◆ CalcVolume()

void TFoamCell::CalcVolume ( void  )

Calculates volume of the cell using size params which are calculated.

Definition at line 125 of file TFoamCell.cxx.

◆ Class()

static TClass * TFoamCell::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TFoamCell::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TFoamCell::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 89 of file TFoamCell.h.

◆ DeclFileName()

static const char * TFoamCell::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 89 of file TFoamCell.h.

◆ Fill()

void TFoamCell::Fill ( Int_t  Status,
TFoamCell Parent,
TFoamCell Daugh1,
TFoamCell Daugh2 
)

Fills in certain data into newly allocated cell.

Definition at line 58 of file TFoamCell.cxx.

◆ GetBest()

Int_t TFoamCell::GetBest ( ) const
inline

Definition at line 57 of file TFoamCell.h.

◆ GetCells()

TFoamCell ** TFoamCell::GetCells ( ) const
inline

Definition at line 85 of file TFoamCell.h.

◆ GetDau0()

TFoamCell * TFoamCell::GetDau0 ( ) const
inline

Definition at line 77 of file TFoamCell.h.

◆ GetDau1()

TFoamCell * TFoamCell::GetDau1 ( ) const
inline

Definition at line 78 of file TFoamCell.h.

◆ GetDriv()

Double_t TFoamCell::GetDriv ( ) const
inline

Definition at line 66 of file TFoamCell.h.

◆ GetHcub()

void TFoamCell::GetHcub ( TFoamVect cellPosi,
TFoamVect cellSize 
) const

Provides size and position of the cell These parameter are calculated by analyzing information in all parents cells up to the root cell.

It takes time but saves memory.

Definition at line 71 of file TFoamCell.cxx.

◆ GetHSize()

void TFoamCell::GetHSize ( TFoamVect cellSize) const

Provides size of the cell Size parameters are calculated by analyzing information in all parents cells up to the root cell.

It takes time but saves memory.

Definition at line 100 of file TFoamCell.cxx.

◆ GetIntg()

Double_t TFoamCell::GetIntg ( ) const
inline

Definition at line 65 of file TFoamCell.h.

◆ GetPare()

TFoamCell * TFoamCell::GetPare ( ) const
inline

Definition at line 76 of file TFoamCell.h.

◆ GetPrim()

Double_t TFoamCell::GetPrim ( ) const
inline

Definition at line 67 of file TFoamCell.h.

◆ GetSerial()

Int_t TFoamCell::GetSerial ( ) const
inline

Definition at line 83 of file TFoamCell.h.

◆ GetStat()

Int_t TFoamCell::GetStat ( ) const
inline

Definition at line 72 of file TFoamCell.h.

◆ GetVolume()

Double_t TFoamCell::GetVolume ( ) const
inline

Definition at line 64 of file TFoamCell.h.

◆ GetXdiv()

Double_t TFoamCell::GetXdiv ( ) const
inline

Definition at line 56 of file TFoamCell.h.

◆ IsA()

TClass * TFoamCell::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 89 of file TFoamCell.h.

◆ operator=() [1/2]

TFoamCell & TFoamCell::operator= ( const TFoamCell )
delete

◆ operator=() [2/2]

TFoamCell & TFoamCell::operator= ( TFoamCell &&  )
delete

◆ Print()

void TFoamCell::Print ( Option_t option) const
overridevirtual

Printout of the cell geometry parameters for the debug purpose.

Reimplemented from TObject.

Definition at line 140 of file TFoamCell.cxx.

◆ SetBest()

void TFoamCell::SetBest ( Int_t  Best)
inline

Definition at line 58 of file TFoamCell.h.

◆ SetCells()

void TFoamCell::SetCells ( TFoamCell **  cells)
inline

Definition at line 84 of file TFoamCell.h.

◆ SetDau0()

void TFoamCell::SetDau0 ( TFoamCell Daug)
inline

Definition at line 80 of file TFoamCell.h.

◆ SetDau1()

void TFoamCell::SetDau1 ( TFoamCell Daug)
inline

Definition at line 81 of file TFoamCell.h.

◆ SetDriv()

void TFoamCell::SetDriv ( Double_t  Driv)
inline

Definition at line 69 of file TFoamCell.h.

◆ SetIntg()

void TFoamCell::SetIntg ( Double_t  Intg)
inline

Definition at line 68 of file TFoamCell.h.

◆ SetPrim()

void TFoamCell::SetPrim ( Double_t  Prim)
inline

Definition at line 70 of file TFoamCell.h.

◆ SetSerial()

void TFoamCell::SetSerial ( Int_t  Serial)
inline

Definition at line 82 of file TFoamCell.h.

◆ SetStat()

void TFoamCell::SetStat ( Int_t  Stat)
inline

Definition at line 73 of file TFoamCell.h.

◆ SetXdiv()

void TFoamCell::SetXdiv ( Double_t  Xdiv)
inline

Definition at line 59 of file TFoamCell.h.

◆ Streamer()

void TFoamCell::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TFoamCell::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 89 of file TFoamCell.h.

Member Data Documentation

◆ fBest

Int_t TFoamCell::fBest
private

Best Edge for division.

Definition at line 39 of file TFoamCell.h.

◆ fCells

TFoamCell** TFoamCell::fCells = nullptr
private

! Array of ALL cells, owned by the TFoam object

Definition at line 35 of file TFoamCell.h.

◆ fDaught0

TRef TFoamCell::fDaught0
private

Pointer to daughter 1.

Definition at line 27 of file TFoamCell.h.

◆ fDaught0Idx

Int_t TFoamCell::fDaught0Idx = -1
private

Serial number of daughter 1.

Definition at line 31 of file TFoamCell.h.

◆ fDaught1

TRef TFoamCell::fDaught1
private

Pointer to daughter 2.

Definition at line 28 of file TFoamCell.h.

◆ fDaught1Idx

Int_t TFoamCell::fDaught1Idx = -1
private

Serial number of daughter 2.

Definition at line 32 of file TFoamCell.h.

◆ fDim

Short_t TFoamCell::fDim
private

Dimension of the vector space.

Definition at line 15 of file TFoamCell.h.

◆ fDrive

Double_t TFoamCell::fDrive
private

Driver integral, only for cell build-up.

Definition at line 43 of file TFoamCell.h.

◆ fIntegral

Double_t TFoamCell::fIntegral
private

Integral over cell (estimate from exploration)

Definition at line 42 of file TFoamCell.h.

◆ fParent

TRef TFoamCell::fParent
private

Pointer to parent cell.

Definition at line 26 of file TFoamCell.h.

◆ fParentIdx

Int_t TFoamCell::fParentIdx = -1
private

Serial number of parent cell.

Definition at line 30 of file TFoamCell.h.

◆ fPrimary

Double_t TFoamCell::fPrimary
private

Primary integral, only for MC generation.

Definition at line 44 of file TFoamCell.h.

◆ fSerial

Int_t TFoamCell::fSerial
private

Serial number.

Definition at line 19 of file TFoamCell.h.

◆ fStatus

Int_t TFoamCell::fStatus
private

Status (active, inactive)

Definition at line 20 of file TFoamCell.h.

◆ fVolume

Double_t TFoamCell::fVolume
private

Cartesian Volume of cell.

Definition at line 41 of file TFoamCell.h.

◆ fXdiv

Double_t TFoamCell::fXdiv
private

Factor for division.

Definition at line 38 of file TFoamCell.h.

Libraries for TFoamCell:

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