BinningBase Class Reference

#include <BinningBase.h>

Inheritance diagram for BinningBase:

Public Member Functions
	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 ()
virtual void	load (TString filename, TString option="READ")=0
virtual void	save (TString filename) const =0
virtual void	save () const =0
virtual BinningBase *	clone () const =0
virtual int	getNumBins () const =0
virtual int	getBinNum (const HyperPoint &coords) const =0
virtual HyperVolume	getBinHyperVolume (int binNumber) const =0
virtual void	mergeBinnings (const BinningBase &other)=0
virtual HyperPoint	getAverageBinWidth () const =0
virtual HyperCuboid	getLimits () const =0
virtual void	reserveCapacity (int nElements)
virtual std::vector< int >	getBinNum (const HyperPointSet &coords) const

Protected Member Functions
virtual void	setDimension (int dimension)
void	setBinningType (TString binningType)

Private Attributes
int	_dimension
HyperName	_axisNames
TString	_binningType

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

The base class for any Binning object

Definition at line 27 of file BinningBase.h.

Constructor & Destructor Documentation

BinningBase()

BinningBase::BinningBase

(

)

Definition at line 3 of file BinningBase.cpp.

                         :
  _dimension  (0 ),
  _axisNames  (0 ),
  _binningType("")   
{


}

~BinningBase()

BinningBase::~BinningBase ( )

virtual

Definition at line 76 of file BinningBase.cpp.

                         {

}

Member Function Documentation

clone()

virtual BinningBase* BinningBase::clone ( ) const

pure virtual

Implemented in HyperBinning, HyperBinningMemRes, HyperBinningDiskRes, and UniformBinning.

filename()

TString BinningBase::filename ( ) const

virtual

Reimplemented in HyperBinningDiskRes.

Definition at line 57 of file BinningBase.cpp.

                                   {
  return "";
}

getAverageBinWidth()

virtual HyperPoint BinningBase::getAverageBinWidth ( ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

getBinHyperVolume()

virtual HyperVolume BinningBase::getBinHyperVolume ( int  binNumber ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

getBinningType()

TString BinningBase::getBinningType

(

)

const

Definition at line 50 of file BinningBase.cpp.

                                         {
  return _binningType;
}

getBinNum() [1/2]

virtual int BinningBase::getBinNum ( const HyperPoint &  coords ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

getBinNum() [2/2]

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

virtual

Reimplemented in HyperBinning.

Definition at line 65 of file BinningBase.cpp.

                                                                      {
  std::vector<int> binNums;
  binNums.reserve(coords.size());

  for (unsigned i = 0; i < coords.size(); i++){
    binNums.push_back( getBinNum(coords.at(i)) );
  }
  return binNums;
} 

getDimension()

const int & BinningBase::getDimension

(

)

const

get the dimensionality of the binning

Definition at line 30 of file BinningBase.cpp.

                                           { 
  return _dimension; 
}  

getLimits()

virtual HyperCuboid BinningBase::getLimits ( ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

getMax()

double BinningBase::getMax

(

int

dimension

)

const

Definition at line 46 of file BinningBase.cpp.

                                             {
  return getLimits().getHighCorner().at(dimension);
}

getMin()

double BinningBase::getMin

(

int

dimension

)

const

Definition at line 42 of file BinningBase.cpp.

                                             {
  return getLimits().getLowCorner().at(dimension);
}

getNames()

HyperName BinningBase::getNames

(

)

const

get the a names for each dimension

Definition at line 25 of file BinningBase.cpp.

                                     {
  return _axisNames;
}       

getNumBins()

virtual int BinningBase::getNumBins ( ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

isDiskResident()

bool BinningBase::isDiskResident ( ) const

virtual

Reimplemented in HyperBinningDiskRes.

Definition at line 54 of file BinningBase.cpp.

                                      {
  return false;
}

isSameBinningType()

bool BinningBase::isSameBinningType

(

const BinningBase &

other

)

const

Definition at line 12 of file BinningBase.cpp.

                                                                   {
  return (other._binningType == _binningType);
}

load()

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

pure virtual

Implemented in HyperBinning, HyperBinningMemRes, HyperBinningDiskRes, and UniformBinning.

mergeBinnings()

virtual void BinningBase::mergeBinnings ( const BinningBase &  other )

pure virtual

Implemented in HyperBinning, and UniformBinning.

reserveCapacity()

void BinningBase::reserveCapacity ( int  nElements )

virtual

Reimplemented in HyperBinning, HyperBinningMemRes, and HyperBinningDiskRes.

Definition at line 61 of file BinningBase.cpp.

                                              {
  nElements++;
}

save() [1/2]

virtual void BinningBase::save ( TString  filename ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

save() [2/2]

virtual void BinningBase::save ( ) const

pure virtual

Implemented in HyperBinning, and UniformBinning.

setBinningType()

void BinningBase::setBinningType ( TString  binningType )

protected

Definition at line 16 of file BinningBase.cpp.

                                                   {
  _binningType = binningType;
}

setDimension()

void BinningBase::setDimension ( int  dimension )

protectedvirtual

set the dimensionality of the binning

Reimplemented in HyperBinning, HyperBinningMemRes, and HyperBinningDiskRes.

Definition at line 34 of file BinningBase.cpp.

                                            {
  if (_dimension == 0){
    _dimension       = dimension;
    _axisNames       = HyperName  (dimension);
  }
}

setNames()

void BinningBase::setNames

(

HyperName

names

)

set the a name for each dimension

Definition at line 21 of file BinningBase.cpp.

                                                { 
  _axisNames = names; 
}  

Member Data Documentation

_axisNames

HyperName BinningBase::_axisNames

private

Possible to assign names to each dimension, which will be used for plotting etc

Definition at line 36 of file BinningBase.h.

_binningType

TString BinningBase::_binningType

private

Useful to know what kind of binning this actually is (will be set by derrived type)

Definition at line 41 of file BinningBase.h.

_dimension

int BinningBase::_dimension

private

Dimensionality of the binning. Can only be set ONCE with setDimension();

Definition at line 31 of file BinningBase.h.

---

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

• Mint/BinningBase.h
• src/Mojito/Chi2Test/BinningBase.cpp