HyperVolume Class Reference

#include <HyperVolume.h>

Public Member Functions
	HyperVolume (int dimension)
	HyperVolume (const HyperPoint &lowCorner, const HyperPoint &highCorner)
	HyperVolume (const HyperCuboid &cuboid)
	Constuctor that adds just one HyperCuboid to the HyperVolume. More...
	HyperVolume (const HyperCuboid &cuboid1, const HyperCuboid &cuboid2)
	Constuctor that adds just two HyperCuboids to the HyperVolume. More...
const int &	getDimension () const
void	addHyperCuboid (const HyperPoint &lowCorner, const HyperPoint &highCorner)
void	addHyperCuboid (const HyperCuboid &hyperCuboid)
void	push_back (const HyperCuboid &hyperCuboid)
const std::vector< HyperCuboid > &	getHyperCuboids () const
const HyperCuboid &	getHyperCuboid (int i) const
const HyperCuboid &	at (int i) const
HyperCuboid &	at (int i)
int	size () const
HyperVolume &	operator= (const HyperVolume &other)
HyperVolume	operator+ (const HyperVolume &other) const
HyperPoint	getAverageCenter () const
void	print (std::ostream &os=std::cout, int endline=1) const
bool	inVolume (const HyperPoint &coords) const
bool	inVolume (const HyperPointSet &coords) const
double	volume () const
HyperVolume	slice (const HyperPoint &coords, std::vector< int > dims) const
double	getMin (int dimension) const
double	getMax (int dimension) const
HyperCuboid	getLimits () const
HyperVolume	splitAll (int dimension, double fractionalSplitPoint)
	~HyperVolume ()

Private Attributes
int	_dimension
std::vector< HyperCuboid >	_hyperCuboids

Detailed Description

Definition at line 27 of file HyperVolume.h.

Constructor & Destructor Documentation

HyperVolume() [1/4]

HyperVolume::HyperVolume

(

int

dimension

)

Simple constuctor that only takes the dimensionality of the HyperVolume.

Definition at line 6 of file HyperVolume.cpp.

                                      : 
  _dimension ( dimension )
{ 
}

HyperVolume() [2/4]

HyperVolume::HyperVolume	(	const HyperPoint &	lowCorner,
		const HyperPoint &	highCorner
	)

Constuctor that adds just one HyperCuboid to the HyperVolume, defined by its upper and lower corners.

Definition at line 13 of file HyperVolume.cpp.

                                                                                  : 
  _dimension ( lowCorner.size() )
{ 
  _hyperCuboids.push_back(HyperCuboid(lowCorner, highCorner));
}

HyperVolume() [3/4]

HyperVolume::HyperVolume

(

const HyperCuboid &

cuboid

)

Constuctor that adds just one HyperCuboid to the HyperVolume.

Definition at line 21 of file HyperVolume.cpp.

                                                  :
  _dimension ( cuboid.getDimension() )
{

  _hyperCuboids.push_back(cuboid);

}

HyperVolume() [4/4]

HyperVolume::HyperVolume	(	const HyperCuboid &	cuboid1,
		const HyperCuboid &	cuboid2
	)

Constuctor that adds just two HyperCuboids to the HyperVolume.

Definition at line 30 of file HyperVolume.cpp.

                                                                               :
  _dimension ( cuboid1.getDimension() )
{
  push_back(cuboid1);
  push_back(cuboid2);
}

~HyperVolume()

HyperVolume::~HyperVolume

(

)

Destructor

Definition at line 249 of file HyperVolume.cpp.

                          { 
}

Member Function Documentation

addHyperCuboid() [1/2]

void HyperVolume::addHyperCuboid	(	const HyperPoint &	lowCorner,
		const HyperPoint &	highCorner
	)

add a HyperCuboid (defined by upper and lower HyperPoints) to the HyperVolume

Definition at line 91 of file HyperVolume.cpp.

                                                                                        {

  addHyperCuboid( HyperCuboid(lowCorner, highCorner) );
}

addHyperCuboid() [2/2]

void HyperVolume::addHyperCuboid

(

const HyperCuboid &

hyperCuboid

)

add a HyperCuboid to the HyperVolume

Definition at line 98 of file HyperVolume.cpp.

                                                              {
  if (hyperCuboid.getDimension() == _dimension) _hyperCuboids.push_back(hyperCuboid);
  else ERROR_LOG << "The HyperCuboid you are adding to this HyperVolume has the wrong dimension";
}

at() [1/2]

const HyperCuboid& HyperVolume::at ( int  i ) const

inline

Definition at line 55 of file HyperVolume.h.

{return _hyperCuboids.at(i);}

at() [2/2]

HyperCuboid& HyperVolume::at ( int  i )

inline

return one of the HyperCuboids

Definition at line 56 of file HyperVolume.h.

getAverageCenter()

HyperPoint HyperVolume::getAverageCenter

(

)

const

Find the center of mass of the HyperVolume, assuming the mass is proportional to volume.

Definition at line 114 of file HyperVolume.cpp.

                                              {
  
  HyperPoint binCenter(_dimension);
  double sumW = 0.0;

  for(unsigned int i = 0; i < _hyperCuboids.size(); i++){
    HyperPoint ithBinCenter = _hyperCuboids.at(i).getCenter();
    double weight =           _hyperCuboids.at(i).volume();
    
    binCenter = binCenter + ithBinCenter*weight;
    sumW += weight;
  }

  binCenter = binCenter/sumW;

  return binCenter;

}

getDimension()

const int& HyperVolume::getDimension ( ) const

inline

get the dimensionality of the HyperVolume

Definition at line 44 of file HyperVolume.h.

getHyperCuboid()

const HyperCuboid& HyperVolume::getHyperCuboid ( int  i ) const

inline

Definition at line 54 of file HyperVolume.h.

{return _hyperCuboids.at(i);}

getHyperCuboids()

const std::vector<HyperCuboid>& HyperVolume::getHyperCuboids ( ) const

inline

return the std::vector containing the HyperCuboids

Definition at line 51 of file HyperVolume.h.

getLimits()

HyperCuboid HyperVolume::getLimits

(

)

const

get the limits of the HyperVolume

Definition at line 184 of file HyperVolume.cpp.

                                        {
  HyperCuboid limits(getDimension());
  for (int i = 0; i < getDimension(); i++){
    limits.getLowCorner ().at(i) = getMin(i);
    limits.getHighCorner().at(i) = getMax(i);
  }
  return limits;
}

getMax()

double HyperVolume::getMax

(

int

dimension

)

const

Find the Maximum value in a given dimension.

Definition at line 166 of file HyperVolume.cpp.

                                             {

  if (dimension < _dimension) {
    double max = _hyperCuboids.at(0).getHighCorner().at(dimension);
    for(unsigned int i = 1; i < _hyperCuboids.size(); i++){
      double temp = _hyperCuboids.at(i).getHighCorner().at(dimension);
      if (max < temp) max = temp;
    }
    return max;
  }

  ERROR_LOG << "You are requesting a dimensionality that does not exist in this HyperVolume";
  return -1.0;

}

getMin()

double HyperVolume::getMin

(

int

dimension

)

const

Find the Minimum value in a given dimension.

Definition at line 148 of file HyperVolume.cpp.

                                             {

  if (dimension < _dimension) {
    double min = _hyperCuboids.at(0).getLowCorner().at(dimension);
    for(unsigned int i = 1; i < _hyperCuboids.size(); i++){
      double temp = _hyperCuboids.at(i).getLowCorner().at(dimension);
      if (min > temp) min = temp;
    }
    return min;
  }

  ERROR_LOG << "You are requesting a dimensionality that does not exist in this HyperVolume";
  return -1.0;

}

inVolume() [1/2]

bool HyperVolume::inVolume

(

const HyperPoint &

coords

)

const

Check to see if a HyperPoint is within the HyperVolume

Definition at line 39 of file HyperVolume.cpp.

                                                        {

  for(unsigned int i = 0; i < _hyperCuboids.size(); i++){
    if(_hyperCuboids.at(i).inVolume(coords)==1) return 1;
  }
  return 0;

}

inVolume() [2/2]

bool HyperVolume::inVolume

(

const HyperPointSet &

coords

)

const

Check to see if all the HyperPoint in a HyperPointSet are within the HyperVolume.

Definition at line 51 of file HyperVolume.cpp.

                                                           {
  
  int ncoords = coords.size();
  for (int i = 0; i < ncoords; i++){
    if ( inVolume(coords.at(i)) == false ) return false;
  }
  return true;
}

operator+()

HyperVolume HyperVolume::operator+

(

const HyperVolume &

other

)

const

Make a HyperVolume that contains the HyperCuboids from both HyperVolumes.

Definition at line 63 of file HyperVolume.cpp.

                                                                  {
  
  if (getDimension() != other.getDimension()) {
    ERROR_LOG << "You are trying to add HyperVolumes of different dimensions.";
    return *this;
  }
  HyperVolume volume(getDimension());
  for(int i = 0; i < size(); i++){
    volume.addHyperCuboid(getHyperCuboid(i));
  }
  for(int i = 0; i < other.size(); i++){
    volume.addHyperCuboid(other.getHyperCuboid(i));
  }
  return volume;
}

operator=()

HyperVolume & HyperVolume::operator=

(

const HyperVolume &

other

)

Overwrite this HyperVolume with another.

Definition at line 81 of file HyperVolume.cpp.

                                                              {
  
  _hyperCuboids = other._hyperCuboids;
  _dimension =    other._dimension;

  return *this;
}

print()

void HyperVolume::print	(	std::ostream &	os = std::cout,
		int	endline = 1
	)		const

Print the HyperCuboids that define the HyperVolume

Definition at line 196 of file HyperVolume.cpp.

                                                        {

  for(unsigned int i = 0; i < _hyperCuboids.size(); i++){
    _hyperCuboids.at(i).print(os, 1);
  }  
  if (endline == 1) os << std::endl;
}

push_back()

void HyperVolume::push_back

(

const HyperCuboid &

hyperCuboid

)

add a HyperCuboid to the HyperVolume

Definition at line 105 of file HyperVolume.cpp.

                                                         {
  addHyperCuboid(hyperCuboid);
}

size()

int HyperVolume::size ( ) const

inline

return the number of HyperCuboids that make up the HyperVolume

Definition at line 60 of file HyperVolume.h.

slice()

HyperVolume HyperVolume::slice	(	const HyperPoint &	coords,
		std::vector< int >	dims
	)		const

Used for taking a slice through a HyperVolume. Pick a HyperPoint 'coords' e.g coords =(-1,5,4) then pick the dimensions you wish to slice through e.g. dims = (0). You can then imagine the plane defined by x_0 = -1, which intersects your HyperVolume. The 2D shape of this intersection is what will be returned. Further if you were to set dims = (0,1) you would get the 1D bin boundarys defined by the intersection of the line (x_0 = -1, x_1 = 5) and the HyperVolume.

Definition at line 210 of file HyperVolume.cpp.

                                                                                 {
  
  int currentDim = getDimension();
  int sliceDim   = (int)dims.size();  
  int newDim     = currentDim - sliceDim;

  HyperVolume slicedVolume(newDim);

  for(unsigned int i = 0; i < _hyperCuboids.size(); i++){
    if(_hyperCuboids.at(i).inVolume(coords, dims)==1){
      //std::cout << "Woohoo - I'm in volume, lets project" << std::endl;
      HyperCuboid cube = _hyperCuboids.at(i).projectOpposite(dims);
      //std::cout << " ---- wow, it worked" << std::endl;
      slicedVolume.addHyperCuboid(cube);
    } 
  }

  return slicedVolume;

}

splitAll()

HyperVolume HyperVolume::splitAll	(	int	dimension,
		double	fractionalSplitPoint
	)

Split all of the HyperCuboids within the HyperVolume in the dimension given, and at the fractionalSplitPoint given.

Definition at line 233 of file HyperVolume.cpp.

                                                                           {

  HyperVolume hyperCuboidSet( getDimension() );

  for (int i = 0; i < size(); i++){
    at(i).split(dimension, fractionalSplitPoint, hyperCuboidSet);
  }

  return hyperCuboidSet;

}

volume()

double HyperVolume::volume

(

)

const

Find the volume of the HyperVolume (sum of the volume of the HyperCuboids, doesn't consider overlap).

Definition at line 136 of file HyperVolume.cpp.

                                {

  double volume = 0.0;
  for(unsigned int i = 0; i < _hyperCuboids.size(); i++){
    volume += _hyperCuboids.at(i).volume();
  }
  return volume;

}

Member Data Documentation

_dimension

int HyperVolume::_dimension

private

Dimensionality of the HyperVolume

Definition at line 31 of file HyperVolume.h.

_hyperCuboids

std::vector<HyperCuboid> HyperVolume::_hyperCuboids

private

vector containing HyperCuboids that define the HyperVolume

Definition at line 33 of file HyperVolume.h.

---

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

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