#include <HyperBinningMemRes.h>

Inheritance diagram for HyperBinningMemRes:

Public Member Functions
	HyperBinningMemRes ()
	The only constructor. More...

virtual	~HyperBinningMemRes ()

virtual void	reserveCapacity (int nElements)

virtual std::vector< int >	getPrimaryVolumeNumbers () const

virtual void	setDimension (int dim)

virtual void	addPrimaryVolumeNumber (int volumeNumber)

virtual bool	addHyperVolume (const HyperVolume &hyperVolume, std::vector< int > linkedVolumes=std::vector< int >(0, 0))

virtual int	getNumHyperVolumes () const

virtual HyperVolume	getHyperVolume (int volumeNumber) const

virtual std::vector< int >	getLinkedHyperVolumes (int volumeNumber) const

virtual int	getNumPrimaryVolumes () const

virtual int	getPrimaryVolumeNumber (int i) const

virtual void	load (TString filename, TString option="READ")

virtual BinningBase *	clone () const

Public Member Functions inherited from HyperBinning
	HyperBinning ()
	The only constructor. More...

bool	isPrimaryVolume (int volumeNumber) const

int	getHyperVolumeNumber (int binNumber) const

int	getBinNum (int volumeNumber) const

virtual	~HyperBinning ()

virtual void	save (TString filename) const

virtual void	save () const

virtual void	mergeBinnings (const BinningBase &other)

virtual int	getNumBins () const

virtual int	getBinNum (const HyperPoint &coords) const

virtual std::vector< int >	getBinNum (const HyperPointSet &coords) const

std::vector< int >	getBinNumAlt (const HyperPointSet &coords) const

virtual HyperVolume	getBinHyperVolume (int binNumber) const

virtual HyperPoint	getAverageBinWidth () const

virtual HyperCuboid	getLimits () const

Public Member Functions inherited from BinningBase
	BinningBase ()

void	setNames (HyperName names)

HyperName	getNames () const

const int &	getDimension () const

double	getMin (int dimension) const

double	getMax (int dimension) const

TString	getBinningType () const

bool	isSameBinningType (const BinningBase &other) const

virtual bool	isDiskResident () const

virtual TString	filename () const

virtual	~BinningBase ()

Protected Member Functions
void	setBranchAddresses (TTree tree, int binNumber, double lowCorner, double highCorner, std::vector< int > **linkedBins) const

void	loadPrimaryVolumeNumbers (TFile *file)

Protected Member Functions inherited from HyperBinning
int	followBinLinks (const HyperPoint &coords, int binNumber) const

void	updateCash () const

void	updateBinNumbering () const

void	updateAverageBinWidth () const

void	updateMinMax () const

int	getHyperBinningDimFromTree (TTree *tree)

void	createBranches (TTree tree, int binNumber, double lowCorner, double highCorner, std::vector< int > **linkedBins) const

void	saveHyperVolumeToTree (TTree tree, double lowCorner, double *highCorner, const HyperVolume &hyperVolume) const

void	savePrimaryVolumeNumbers () const

Protected Member Functions inherited from BinningBase
void	setBinningType (TString binningType)

Protected Attributes
std::vector< HyperVolume >	_hyperVolumes

std::vector< int >	_primaryVolumeNumbers

std::vector< std::vector< int > >	_linkedHyperVolumes

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

HyperBinningMemRes is a binning scheme where each bin volume is defined by a HyperVolume.

Finding the correct bin number is quite a compuationally slow process if one has to loop over every bin and check if a HyperPoint falls within that bin volume. It's not unusual to have millions of HyperPoints that need to be sorted into tens of thousands of bins. This would require billions of calulations. To speed this process up there is the option to build a hierarchy of bins. A schematic below shows a 1D example.

      HyperVolume Numbers 
|-------------0-------------| 
|------1------|------2------| 
|--3---|---4--|---5---|--6--|
|-7-|-8| 
          Bin Numbers
| 0 | 1|   2  |   3   |  4  |

Imagine we have a HyperPoint that falls into Bin 0. One would first check if it falls into HyperVolume 0 (note the distiction here between Bin/HyperVolume Numbers as indicated by the figure). First we check if it falls into HyperVolume 0, then HyperVolume 1 or 2, then HyperVolume 3 or 4, then HyperVolume 7 or 8.

In this simple example, it took 7 operations, whereas checking each Bin would have taken

Clearly as the number of bins increases, it becomes computationally much less expensive to follow this hierarchy approach.

The

Definition at line 80 of file HyperBinningMemRes.h.

Constructor & Destructor Documentation

◆ HyperBinningMemRes()

HyperBinningMemRes::HyperBinningMemRes ( )

The only constructor.

Definition at line 5 of file HyperBinningMemRes.cpp.

 {
   WELCOME_LOG << "Hello from the HyperBinningMemRes() Constructor";
 }

◆ ~HyperBinningMemRes()

HyperBinningMemRes::~HyperBinningMemRes ( )

virtual

Destructor

Definition at line 254 of file HyperBinningMemRes.cpp.

                                        {
   GOODBYE_LOG << "Goodbye from the HyperBinningMemRes() Constructor";
 }

Member Function Documentation

◆ addHyperVolume()

bool HyperBinningMemRes::addHyperVolume	(	const HyperVolume &	hyperVolume,
		std::vector< int >	linkedVolumes = `std::vector<int>(0, 0)`
	)

virtual

Add a HyperVolume to the HyperBinningMemRes and add a set of empty HyperVolume links.

Implements HyperBinning.

Definition at line 65 of file HyperBinningMemRes.cpp.

                                                                                                    {
   
   //If this is the first volume that has been added, use it to set the dimension
   if (_hyperVolumes.size() == 0){
     setDimension( hyperVolume.getDimension() );
   }
 
   if (hyperVolume.getDimension() == getDimension()) {
     _hyperVolumes.push_back(hyperVolume); 
     _linkedHyperVolumes.push_back(linkedVolumes);
     updateCash();
     return true;
   }
 
   ERROR_LOG << "This HyperVolume has the wrong dimensionality for this HyperBinningMemRes";
   return false;
 
 }

◆ addPrimaryVolumeNumber()

void HyperBinningMemRes::addPrimaryVolumeNumber ( int volumeNumber )

virtual

Add a primary volume number

Implements HyperBinning.

Definition at line 41 of file HyperBinningMemRes.cpp.

                                                                {
   _primaryVolumeNumbers.push_back(volumeNumber);
 }

◆ clone()

BinningBase * HyperBinningMemRes::clone ( ) const

virtual

Implements HyperBinning.

Definition at line 31 of file HyperBinningMemRes.cpp.

                                             {
 
   return dynamic_cast<BinningBase*>(new HyperBinningMemRes(*this));
 
 }

◆ getHyperVolume()

HyperVolume HyperBinningMemRes::getHyperVolume ( int volumeNumber ) const

virtual

get one of the HyperVolumes

Implements HyperBinning.

Definition at line 127 of file HyperBinningMemRes.cpp.

                                                                     {
   return _hyperVolumes.at(volumeNumber);
 }

◆ getLinkedHyperVolumes()

std::vector< int > HyperBinningMemRes::getLinkedHyperVolumes ( int volumeNumber ) const

virtual

Implements HyperBinning.

Definition at line 24 of file HyperBinningMemRes.cpp.

                                                                                 {
 
   return _linkedHyperVolumes.at(volumeNumber);
 
 }

◆ getNumHyperVolumes()

int HyperBinningMemRes::getNumHyperVolumes ( ) const

virtual

get the number of HyperVolumes

Implements HyperBinning.

Definition at line 49 of file HyperBinningMemRes.cpp.

                                                 {
   return _hyperVolumes.size();
 }  

◆ getNumPrimaryVolumes()

int HyperBinningMemRes::getNumPrimaryVolumes ( ) const

virtual

Implements HyperBinning.

Definition at line 55 of file HyperBinningMemRes.cpp.

                                                     {
   return _primaryVolumeNumbers.size();
 }

◆ getPrimaryVolumeNumber()

int HyperBinningMemRes::getPrimaryVolumeNumber ( int i ) const

virtual

Implements HyperBinning.

Definition at line 59 of file HyperBinningMemRes.cpp.

                                                          {
   return _primaryVolumeNumbers.at(i);
 }

◆ getPrimaryVolumeNumbers()

std::vector< int > HyperBinningMemRes::getPrimaryVolumeNumbers ( ) const

virtual

Look at the tree that contains the HyperBinningMemRes and find the dimensionality

Reimplemented from HyperBinning.

Definition at line 134 of file HyperBinningMemRes.cpp.

                                                                 {
   return _primaryVolumeNumbers;
 }

◆ load()

void HyperBinningMemRes::load	(	TString	filename,
		TString	option = `"READ"`
	)

virtual

Load HyperBinningMemRes from a file

Implements HyperBinning.

Definition at line 141 of file HyperBinningMemRes.cpp.

                                                              {
   
   if (option != "READ"){
     INFO_LOG << "For a memory resident HyperBinning you should always use the READ option. Setting to READ" << std::endl;
     option = "READ";
   }
 
   TFile* file = new TFile(filename, "READ");
 
   if (file == 0){
     ERROR_LOG << "Could not open TFile in HyperBinningMemRes::load(" << filename << ")";
     return;
   }
 
   loadPrimaryVolumeNumbers(file);
 
   TTree* tree = (TTree*)file->Get("HyperBinning");
 
   if (tree == 0){
     ERROR_LOG << "Could not open TTree in HyperBinningMemRes::load()";
     return;
   }
   
   //Figure out how many dimensions there are from the tree
   setDimension( getHyperBinningDimFromTree(tree) );
 
   //Create branch addresses and link them to TTree
   int binNumber = -1;
   double* lowCorner  = new double [getDimension()];
   double* highCorner = new double [getDimension()];  
   std::vector<int>* linkedBins = new std::vector<int>();
 
   setBranchAddresses(tree, &binNumber, lowCorner, highCorner, &linkedBins);
   
 
   //Loop over the TTree and fill the HyperBinningMemRes
   int nEntries = tree->GetEntries();
 
   int currentBinNumber = -1;
   HyperVolume* currentHyperVolume = new HyperVolume(getDimension());
   std::vector<int> currentLinkedVolumes;
 
   //_verbose = true;
 
   for(int ent = 0; ent < nEntries; ent++){
     tree->GetEntry(ent);
     
     //If the bin number hasn't changed, need to
     //add HyperCube to previous HyperVolume
     if(ent == 0 || currentBinNumber == binNumber){
       currentBinNumber = binNumber;
       currentLinkedVolumes = *linkedBins;
       HyperPoint lowCornerVect (getDimension());
       HyperPoint highCornerVect(getDimension());
       for (int i = 0; i < getDimension(); i++){
         lowCornerVect .at(i) = lowCorner [i];
         highCornerVect.at(i) = highCorner[i];
       }
       VERBOSE_LOG << "Adding cuboid to volume";
       currentHyperVolume->addHyperCuboid(lowCornerVect, highCornerVect);
     }
 
     //if the bin number has changed, need to add
     //previous HyperVolume to HyperBinningMemRes
     //and start a new HyperVolume
     else {
       VERBOSE_LOG << "Adding volume to binning";
       this->addHyperVolume(*currentHyperVolume, currentLinkedVolumes);
       delete currentHyperVolume;
       currentHyperVolume = new HyperVolume(getDimension());
       currentLinkedVolumes = *linkedBins;
       currentBinNumber = binNumber;
       HyperPoint lowCornerVect (getDimension());
       HyperPoint highCornerVect(getDimension());
       for (int i = 0; i < getDimension(); i++){
         lowCornerVect .at(i) = lowCorner [i];
         highCornerVect.at(i) = highCorner[i];
       }
       VERBOSE_LOG << "Adding cuboid to volume";
       currentHyperVolume->addHyperCuboid(lowCornerVect, highCornerVect);
       VERBOSE_LOG << "Adding linked volumes";
       
     }
 
     //if it's the final iteration, need to add the final HyperVolume
     if (ent == nEntries - 1) {
       this->addHyperVolume(*currentHyperVolume);
     }
   }
   
   VERBOSE_LOG << "Binning loaded";
 
   //_verbose = false;
 
   delete currentHyperVolume;
   delete[] lowCorner;
   delete[] highCorner;
   delete linkedBins;
 
   updateCash();
 
   file->Close();
 
 }

◆ loadPrimaryVolumeNumbers()

void HyperBinningMemRes::loadPrimaryVolumeNumbers ( TFile * file )

protected

Save the list of Primary Volume Numbers to the open (and in scope) TFile.

Definition at line 89 of file HyperBinningMemRes.cpp.

                                                              {
 
   TTree* tree = dynamic_cast<TTree*>( file->Get("PrimaryVolumeNumbers") );
   
   if (tree == 0){
     ERROR_LOG << "Could not open TTree in HyperBinningMemRes::loadPrimaryVolumeNumbers()";
     return;
   }
 
   //Define branch addresses
   int volumeNumber = -1;
 
   tree->SetBranchAddress("volumeNumber", &volumeNumber);
 
   //Loop over each Primary Volume
   for(int i = 0; i < tree->GetEntries(); i++ ){
     tree->GetEntry(i);
     _primaryVolumeNumbers.push_back(volumeNumber);
   }
   
 }

◆ reserveCapacity()

void HyperBinningMemRes::reserveCapacity ( int nElements )

virtual

Reimplemented from HyperBinning.

Definition at line 246 of file HyperBinningMemRes.cpp.

                                                      {
   HyperBinning::reserveCapacity(nElements);
   _hyperVolumes      .reserve(nElements);
   _linkedHyperVolumes.reserve(nElements);  
 }

◆ setBranchAddresses()

void HyperBinningMemRes::setBranchAddresses	(	TTree *	tree,
		int *	binNumber,
		double *	lowCorner,
		double *	highCorner,
		std::vector< int > **	linkedBins
	)		const

protected

Set branch addresses for loading HyperBinningMemRes from a file.

Definition at line 113 of file HyperBinningMemRes.cpp.

                                                                                                                                                 {
 
   tree->SetBranchAddress("binNumber", binNumber);
   tree->SetBranchAddress("linkedBins", linkedBins);
   for (int i = 0; i < getDimension(); i++) {
     TString lowCornerName  = "lowCorner_"; lowCornerName += i; 
     TString highCornerName = "highCorner_"; highCornerName += i;
     tree->SetBranchAddress(lowCornerName, lowCorner + i);
     tree->SetBranchAddress(highCornerName, highCorner + i);
   }
 
 }

◆ setDimension()

void HyperBinningMemRes::setDimension ( int dim )

virtual

Set the dimension of the HyperBinningMemRes. This can only be called once, when it is known what dimesnion it is.

Reimplemented from HyperBinning.

Definition at line 15 of file HyperBinningMemRes.cpp.

                                             {
   
   if (getDimension() == 0){
     BinningBase::setDimension(dim);
   }
 
 }

Member Data Documentation

◆ _hyperVolumes

std::vector< HyperVolume > HyperBinningMemRes::_hyperVolumes

protected

std::vector containing all of the HyperVolumes. Usually, not all of these are bins, but part of the bin hierarchy that is discussed in the class description.

Definition at line 84 of file HyperBinningMemRes.h.

◆ _linkedHyperVolumes

std::vector< std::vector<int> > HyperBinningMemRes::_linkedHyperVolumes

protected

Every HyperVolume has a _linkedHyperVolumes - if this is empty, this means the HyperVolume is a true Bin. If not it is part of the binning hierarchy. In the below, HyperVolume 0 would be linked to HyperVolume [1,2], although HyperVolume 4 would be linked to nothing.

      HyperVolume Numbers 
|-------------0-------------| 
|------1------|------2------| 
|--3---|---4--|---5---|--6--|
|-7-|-8| 
          Bin Numbers
| 0 | 1|   2  |   3   |  4  |

Definition at line 116 of file HyperBinningMemRes.h.

◆ _primaryVolumeNumbers

std::vector< int > HyperBinningMemRes::_primaryVolumeNumbers

protected

Usually all bins will be accessed through one primary volume i.e. volume 0 in the below example. If one wants to merge two binning schemes together e.g. Binning1 and Binning2 this involes appending the list of HyperVolumes from Binning2 to Binning1. This brings a problem when trying to sort a HyperPoint into a specific bin i.e. getBinNumber(HyperPoint) - if it belongs to Binning2, it will first have to check that it doesn't fall into any of the volumes in Binning1.

To remedy this problem we introduce the list of primary volumes. If this list exists i.e. its size is greater than 0, all the primary volumes will be checked first. The existance of this list also implies that ALL volumes are linked to the primary volumes.

   HyperVolume Numbers

|----------—0----------—|

|---—1---—|---—2---—|

|–3—|—4–|—5—|–6–|

|-7-|-8|

Definition at line 90 of file HyperBinningMemRes.h.

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

Mint/HyperBinningMemRes.h
src/Mojito/Chi2Test/HyperBinningMemRes.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HyperBinningMemRes()

◆ ~HyperBinningMemRes()

Member Function Documentation

◆ addHyperVolume()

◆ addPrimaryVolumeNumber()

◆ clone()

◆ getHyperVolume()

◆ getLinkedHyperVolumes()

◆ getNumHyperVolumes()

◆ getNumPrimaryVolumes()

◆ getPrimaryVolumeNumber()

◆ getPrimaryVolumeNumbers()

◆ load()

◆ loadPrimaryVolumeNumbers()

◆ reserveCapacity()

◆ setBranchAddresses()

◆ setDimension()

Member Data Documentation

◆ _hyperVolumes

◆ _linkedHyperVolumes

◆ _primaryVolumeNumbers