#include <HyperCuboid.h>

Public Member Functions
const int &	getDimension () const

	HyperCuboid (int dimension)

	HyperCuboid (const HyperPoint &lowCorner, const HyperPoint &highCorner)

	HyperCuboid (int dimension, double low, double high)

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

HyperPoint	getCenter () const

bool	inVolume (const HyperPoint &coords) const

const HyperCuboid &	inflateCuboid (double percent)

double	volume () const

double	getPositiveIntersectionParameter (const HyperLine &line) const

HyperPoint	getPositiveIntersectionPoint (const HyperLine &line) const

double	getNegativeIntersectionParameter (const HyperLine &line) const

HyperPoint	getNegativeIntersectionPoint (const HyperLine &line) const

HyperPoint	getRandomPoint (TRandom *random=gRandom) const

HyperPointSet	getRandomPoints (int nPoints=100, TRandom *random=gRandom) const

std::vector< HyperPlane >	getConnectedHyperPlanes (const HyperPoint &point) const

std::vector< HyperPlane >	getConnectedHyperPlanes (const HyperPointSet &point) const

std::vector< HyperPlane >	getBoundaryHyperPlanes () const

HyperPoint	getOppositePoint (const HyperPoint &point) const

HyperPointSet	getConnectedVerticies (const HyperPointSet &pointSet) const

HyperPointSet	getConnectedVerticies (const HyperPoint &point) const

HyperPointSet	getVertices () const

HyperPointSet	getEdgeCenters () const

HyperCuboid	project (std::vector< int > dims) const

HyperCuboid	projectOpposite (std::vector< int > dims) const

bool	inVolume (const HyperPoint &coords, std::vector< int > dims) const

const HyperPoint &	getLowCorner () const

const HyperPoint &	getHighCorner () const

HyperPoint &	getLowCorner ()

HyperPoint &	getHighCorner ()

HyperCuboid	splitAbove (int dimension, double fractionalSplitPoint) const

HyperCuboid	splitBelow (int dimension, double fractionalSplitPoint) const

HyperVolume	split (int dimension, double fractionalSplitPoint) const

void	split (int dimension, double fractionalSplitPoint, HyperVolume &set) const

HyperPoint	getWidth () const

double	getWidth (int dim) const

bool	setCorners (const HyperPoint &lowCorner, const HyperPoint &highCorner)

bool	operator== (const HyperCuboid &other) const

bool	operator != (const HyperCuboid &other) const

	~HyperCuboid ()

Private Member Functions
void	updateFaceCash () const

Private Attributes
int	_dimension

HyperPoint	_lowCorner

HyperPoint	_highCorner

std::vector< HyperPlane >	_faces

Detailed Description

Definition at line 28 of file HyperCuboid.h.

Constructor & Destructor Documentation

◆ HyperCuboid() [1/3]

HyperCuboid::HyperCuboid ( int dimension )

Most basic constructor where only the dimension of the cuboid is specified.

Definition at line 6 of file HyperCuboid.cpp.

                                       : 
   _dimension ( dimension ),
   _lowCorner ( dimension ),
   _highCorner( dimension )
 { 
 }

◆ HyperCuboid() [2/3]

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

Construct the HyperCuboid with two HyperPoints, one in the low corner, and one in the high corner

Definition at line 15 of file HyperCuboid.cpp.

                                                                                   :
   _dimension( lowCorner.size() ),
   _lowCorner ( _dimension ),  //note this assignment sets the dimension of this variable forever, so if 
   _highCorner( _dimension )   //low and high corners are a different size, an error will be thrown inside HyperPoint
 {
 
   if (lowCorner.allLT(highCorner)){
     _lowCorner  = lowCorner;
     _highCorner = highCorner;
   }
   else{
     ERROR_LOG << "Your lowCorner isn't lower than your highCorner"<< std::endl;
     _lowCorner .print();
     _highCorner.print();
   }
 
 }

◆ HyperCuboid() [3/3]

HyperCuboid::HyperCuboid	(	int	dimension,
		double	low,
		double	high
	)

Construct the HyperCuboid with two HyperPoints (x, x, x ....) and (y, y, y ....)

Definition at line 35 of file HyperCuboid.cpp.

                                                                :
   _dimension ( dimension ),
   _lowCorner ( dimension ),  //note this assignment sets the dimension of this variable forever, so if 
   _highCorner( dimension )   //low and high corners are a different size, an error will be thrown inside HyperPoint
 {
   
   for (int i = 0; i < _dimension; i++){
     _lowCorner.at(i)  = low ;
     _highCorner.at(i) = high;
   }
 
   if (low > high) {
     ERROR_LOG << "Your lowCorner isn't lower than your highCorner" << std::endl;
   }
 }

◆ ~HyperCuboid()

HyperCuboid::~HyperCuboid ( )

Destructor

Definition at line 708 of file HyperCuboid.cpp.

708 {

709 }

Member Function Documentation

◆ getBoundaryHyperPlanes()

std::vector< HyperPlane > HyperCuboid::getBoundaryHyperPlanes ( ) const

Get all the HyperPlanes that define the ‘faces’ of the HyperCuboid. Note that nDim points are needed to define such HyperPlanes.

e.g. for a square the 'faces' are lines defined by 2 points for a cube the 'faces' are planes defined by 3 points

Definition at line 252 of file HyperCuboid.cpp.

                                                                {
   
   //Get all the verticies of the HyperCuboid, then find all the HyperPlanes
   //that are conected to these verticies.
   std::vector<HyperPlane> planes = getConnectedHyperPlanes(getVertices());
   std::vector<int> isUnique(planes.size(), 1);
   
   //remove all the duplicates.
 
   VERBOSE_LOG << "There are " << planes.size() << " planes before removing doubles"; 
   
   for(unsigned j = 0; j < planes.size(); j++){
 
     if (isUnique.at(j) == 0){ VERBOSE_LOG << "    Skippied"; continue; }
 
     for(unsigned i = j+1; i < planes.size(); i++){
 
       if (isUnique.at(i) == 0) continue;
       if (planes.at(i) == planes.at(j)) isUnique.at(i) = 0;
 
     }
   }
 
   std::vector<HyperPlane> faces;
   for(unsigned j = 0; j < planes.size(); j++){
     if (isUnique.at(j) == 1) faces.push_back(planes.at(j));
   }
 
   VERBOSE_LOG << "There are " << faces.size() << " planes after removing doubles"; 
 
   return faces;
 
 }

◆ getCenter()

HyperPoint HyperCuboid::getCenter ( ) const

Get the HyperPoint at the center of the HyperCuboid

Definition at line 93 of file HyperCuboid.cpp.

                                        {
   return (_lowCorner + _highCorner)*0.5;
 }

◆ getConnectedHyperPlanes() [1/2]

std::vector< HyperPlane > HyperCuboid::getConnectedHyperPlanes ( const HyperPoint & point ) const

Give it a corner of the HyperCuboid and it will return all faces (HyperPlanes) connected to that corner. Note that nDim points are needed to define such a HyperPlane.

e.g. for a square the 'faces' are lines defined by 2 points for a cube the 'faces' are planes defined by 3 points

Definition at line 197 of file HyperCuboid.cpp.

                                                                                        {
   
   std::vector<HyperPlane> connectedHyperPlanes;
   
   //First find all the verticies that are connected to this one by an edge.
   //There will be nDim such verticies
   int dim = getDimension();
   HyperPointSet connectedVerticies = getConnectedVerticies(point);
   
   //We now have the vertex given, and an additional nDim connected 
   //verticies. There is therefore nDim possible Hyperplanes one can form.
   for (int i = 0; i < dim; i++){
     HyperPointSet pointsInPlane(dim);
     pointsInPlane.push_back(point);
     for(int j = 0; j < dim; j++){
       if (i != j) pointsInPlane.push_back(connectedVerticies.at(j));
     }
     pointsInPlane.sort();
     HyperPlane plane(pointsInPlane);
     connectedHyperPlanes.push_back(plane);
   }
   
   return connectedHyperPlanes;
 
 }

◆ getConnectedHyperPlanes() [2/2]

std::vector< HyperPlane > HyperCuboid::getConnectedHyperPlanes ( const HyperPointSet & point ) const

Give it a corners of the HyperCuboid and it will return all faces (HyperPlanes) connected to that corner. Note that nDim points are needed to define such a HyperPlane.

e.g. for a square the 'faces' are lines defined by 2 points for a cube the 'faces' are planes defined by 3 points

This is done for all corners given in the HyperPointSet

Definition at line 231 of file HyperCuboid.cpp.

                                                                                           {
    
   std::vector<HyperPlane> connectedHyperPlanes;
 
   for(unsigned i = 0; i < point.size(); i++){
     std::vector<HyperPlane> someHyperPlanes = getConnectedHyperPlanes(point.at(i));
     for(unsigned j = 0; j < someHyperPlanes.size(); j++){
       connectedHyperPlanes.push_back(someHyperPlanes.at(j));
     }
   }
   
   return connectedHyperPlanes;
 
 }

◆ getConnectedVerticies() [1/2]

HyperPointSet HyperCuboid::getConnectedVerticies ( const HyperPointSet & pointSet ) const

If a vertex of the HyperCuboid is given, this finds all other verticies that are connected to that one by an edge. It does this for all HyperPoints in the HyperPointSet given.

For example, if you give it the top right corner of a square, it will return the top left and bottom right corners.

Definition at line 521 of file HyperCuboid.cpp.

                                                                                    {
   
   HyperPointSet hyperPointSet(getDimension());
   
   for (unsigned int i = 0; i < pointSet.size(); i++){
     hyperPointSet.addHyperPointSet ( getConnectedVerticies(pointSet.at(i)) );
     VERBOSE_LOG << "Sorting....";
     hyperPointSet.sort();
     VERBOSE_LOG << "Removing Duplicates....";
     hyperPointSet.removeDuplicates();
   }
   
   return hyperPointSet;
 }

◆ getConnectedVerticies() [2/2]

HyperPointSet HyperCuboid::getConnectedVerticies ( const HyperPoint & point ) const

If a vertex of the HyperCuboid is given, this finds all other verticies that are connected to that one by an edge

For example, if you give it the top right corner of a square, it will return the top left and bottom right corners.

Definition at line 541 of file HyperCuboid.cpp.

                                                                              {
   
   int dim = getDimension();
 
   HyperPointSet hyperPointSet(dim);
 
   HyperPoint oppositePoint    = getOppositePoint(point);
   HyperPoint vectorToOpposite = oppositePoint - point;
 
   for (int i = 0; i < dim; i++){
     HyperPoint translation(dim);
     translation.at(i) = vectorToOpposite.at(i);
     HyperPoint newCorner = point + translation;
     hyperPointSet.push_back(newCorner);
   }
   
   return hyperPointSet;
 
 }

◆ getDimension()

const int& HyperCuboid::getDimension ( ) const

inline

get the dimensionality

Definition at line 45 of file HyperCuboid.h.

◆ getEdgeCenters()

HyperPointSet HyperCuboid::getEdgeCenters ( ) const

Definition at line 416 of file HyperCuboid.cpp.

                                                {
 
   int ndim = getDimension();
 
   std::bitset< 15 > binary( 0 );
 
   HyperPoint center = getCenter();
   HyperPoint vectorToHighCorner = _highCorner - center;
 
   int nVertices = pow(2, ndim);
   
   HyperPointSet verticies(ndim);
   
   for (int dimToIgnore = 0; dimToIgnore < ndim; dimToIgnore++){
 
     for (int i = 0; i < nVertices; i++){
       HyperPoint vectorToVertex(vectorToHighCorner);
       binary = i;
       for (int dim = 0; dim < ndim; dim++){
         if (binary[dim] == 0){
           vectorToVertex.at(dim) = -vectorToVertex.at(dim);
         }
         if (dimToIgnore == dim){
           vectorToVertex.at(dim) = 0.0;
         }        
       }
       verticies.push_back(vectorToVertex + center);
     }  
   }
   
   verticies.sort();
   verticies.removeDuplicates();
 
   return verticies;
 
 }

◆ getHighCorner() [1/2]

const HyperPoint& HyperCuboid::getHighCorner ( ) const

inline

return the high HyperPoint corner

Definition at line 89 of file HyperCuboid.h.

◆ getHighCorner() [2/2]

HyperPoint& HyperCuboid::getHighCorner ( )

inline

return the high HyperPoint corner

Definition at line 93 of file HyperCuboid.h.

◆ getLowCorner() [1/2]

const HyperPoint& HyperCuboid::getLowCorner ( ) const

inline

return the low HyperPoint corner

Definition at line 87 of file HyperCuboid.h.

◆ getLowCorner() [2/2]

HyperPoint& HyperCuboid::getLowCorner ( )

inline

return the low HyperPoint corner

Definition at line 91 of file HyperCuboid.h.

◆ getNegativeIntersectionParameter()

double HyperCuboid::getNegativeIntersectionParameter ( const HyperLine & line ) const

A HyperLine is parameterised by (v_1 + x.v_2). This finds one of the two points, x_-, where the HyperLine intersects a face of the HyperCuboid.

Definition at line 352 of file HyperCuboid.cpp.

                                                                                {
 
   updateFaceCash();
   
   int foundSolution = 0;
   double negativeLineParam = 0.0;
 
   for(unsigned i = 0; i < _faces.size(); i++){
     HyperPoint LineParam  = _faces.at(i).findLineIntersectionParameter(line);
     HyperPoint PlaneParam = _faces.at(i).findPlaneIntersectionParameters(line);
 
     VERBOSE_LOG << "-----------------------" << i << "--------------------------";
     VERBOSE_LOG << "Get the parameters for the line and the plane";  
 
     if (LineParam.getDimension()==0){
       VERBOSE_LOG << "Matrix is singular...";
       continue;
     }
 
     if (PlaneParam <= 1.0 && PlaneParam >= 0.0) {
       VERBOSE_LOG << "This intersection is within the cuboid";
       if(LineParam < 0 && foundSolution == 1){
         double otherPoint = LineParam.at(0);
         double diff = otherPoint - negativeLineParam;
         if (fabs(diff)>10e-2) ERROR_LOG << "Somehow there are two distinct negative intercepts";
         else ERROR_LOG << "Already have this solution... weird";
       }
       else if(LineParam < 0) {
         VERBOSE_LOG << "This positive intersection point " << LineParam.at(0);
 
         negativeLineParam = LineParam.at(0);
         foundSolution = 1;
       }
       else{
         VERBOSE_LOG << "This positive intersection point" << LineParam.at(0);
       }
     }
     else{
       VERBOSE_LOG << "This intersection is not within the cuboid";
     }
 
   }
 
   if (foundSolution == 0) ERROR_LOG << "Found no intercept in cuboid.";
 
   return negativeLineParam;
 } 

◆ getNegativeIntersectionPoint()

HyperPoint HyperCuboid::getNegativeIntersectionPoint ( const HyperLine & line ) const

A HyperLine is parameterised by (v_1 + x.v_2). This finds one of the two points, (v_1 + x_-.v_2), where the HyperLine intersects a face of the HyperCuboid

Definition at line 410 of file HyperCuboid.cpp.

                                                                                {
 
   return line.getParametricPoint(getNegativeIntersectionParameter(line));
 
 }

◆ getOppositePoint()

HyperPoint HyperCuboid::getOppositePoint ( const HyperPoint & point ) const

Get point on the opposite side of the HyperCuboid

Imagine a vector V going from the center of the HyperCuboid, C, to the given point. This returns C - V

Definition at line 158 of file HyperCuboid.cpp.

                                                                      {
 
   HyperPoint shift = point - _lowCorner;
   HyperPoint opposite = _highCorner - shift;
   
   return opposite;
 }

◆ getPositiveIntersectionParameter()

double HyperCuboid::getPositiveIntersectionParameter ( const HyperLine & line ) const

A HyperLine is parameterised by (v_1 + x.v_2). This finds one of the two points, x_+, where the HyperLine intersects a face of the HyperCuboid

Definition at line 301 of file HyperCuboid.cpp.

                                                                                {
 
   updateFaceCash();
   
   int foundSolution = 0;
   double negativeLineParam = 0.0;
 
   for(unsigned i = 0; i < _faces.size(); i++){
     HyperPoint LineParam  = _faces.at(i).findLineIntersectionParameter(line);
     HyperPoint PlaneParam = _faces.at(i).findPlaneIntersectionParameters(line);
 
     VERBOSE_LOG << "-----------------------" << i << "--------------------------";
     VERBOSE_LOG << "Get the parameters for the line and the plane";  
 
     if (LineParam.getDimension()==0){
       VERBOSE_LOG << "Matrix is singular...";
       continue;
     }
 
     if (PlaneParam <= 1.0 && PlaneParam >= 0.0) {
       VERBOSE_LOG << "This intersection is within the cuboid";
       if(LineParam > 0 && foundSolution == 1){
         double otherPoint = LineParam.at(0);
         double diff = otherPoint - negativeLineParam;
         if (fabs(diff)>10e-2) ERROR_LOG << "Somehow there are two distinct negative intercepts";
         else ERROR_LOG << "Already have this solution... weird";
       }
       else if(LineParam > 0) {
         VERBOSE_LOG << "This positive intersection point " << LineParam.at(0);
         
         negativeLineParam = LineParam.at(0);
         foundSolution = 1;
       }
       else{
         VERBOSE_LOG << "This positive intersection point" << LineParam.at(0);
       }
     }
     else{
       VERBOSE_LOG << "This intersection is not within the cuboid";
     }
 
   }
 
   if (foundSolution == 0) ERROR_LOG << "Found no intercept in cuboid.";
 
   return negativeLineParam;
 
 }

◆ getPositiveIntersectionPoint()

HyperPoint HyperCuboid::getPositiveIntersectionPoint ( const HyperLine & line ) const

A HyperLine is parameterised by (v_1 + x.v_2). This finds one of the two points, (v_1 + x_+.v_2), where the HyperLine intersects a face of the HyperCuboid

Definition at line 402 of file HyperCuboid.cpp.

                                                                                {
 
   return line.getParametricPoint(getPositiveIntersectionParameter(line));
 
 }

◆ getRandomPoint()

HyperPoint HyperCuboid::getRandomPoint ( TRandom * random = gRandom ) const

Get a random point in the HyperCuboid (uses gRandom)

Definition at line 168 of file HyperCuboid.cpp.

                                                            {
   
   HyperPoint point(getDimension());
   for (int i = 0; i < getDimension(); i++){
     point.at(i) = random->Uniform(getLowCorner().at(i), getHighCorner().at(i));
   }
   return point;
 
 }

◆ getRandomPoints()

HyperPointSet HyperCuboid::getRandomPoints	(	int	nPoints = `100`,
		TRandom *	random = `gRandom`
	)		const

Get a random point in the HyperCuboid (uses gRandom)

Definition at line 180 of file HyperCuboid.cpp.

                                                                             {
   
   HyperPointSet points(getDimension());
   for (int i = 0; i < nPoints; i++){
     points.push_back( getRandomPoint(random) );
   }
   return points;
   
 }

◆ getVertices()

HyperPointSet HyperCuboid::getVertices ( ) const

Get all verticies of the HyperCuboid with no repeats.

This is done by starting from one corner and following the edges to the other corners. This has to be done nDim times in order to get all the corners.

Definition at line 461 of file HyperCuboid.cpp.

                                             {
   
   //New faster method. We know the number of verticies, so just
   //loop from 0 -> nVertex-1 and convert this number to binary.
   //Imagine the binary number is a vector V. 
   //Also have the center of the cube, C, and a vector to the top right
   //corner T.
   //
   //
 
   int ndim = getDimension();
 
   std::bitset< 15 > binary( 0 );
 
   HyperPoint center = getCenter();
   HyperPoint vectorToHighCorner = _highCorner - center;
 
   int nVertices = pow(2, ndim);
   
   HyperPointSet verticies(ndim);
 
   for (int i = 0; i < nVertices; i++){
     HyperPoint vectorToVertex(vectorToHighCorner);
     binary = i;
     for (int dim = 0; dim < ndim; dim++){
       if (binary[dim] == 0){
         vectorToVertex.at(dim) = -vectorToVertex.at(dim);
       }
     }
     verticies.push_back(vectorToVertex + center);
   }
   
   return verticies;
 
   //OLD method
   //HyperPointSet hyperPointSet(getDimension());
   //hyperPointSet.push_back(_lowCorner);
   //
   //HyperPointSet previousHyperPointSet = hyperPointSet;
 
   //for(int i = 1; i < getDimension(); i++){
   //  previousHyperPointSet = getConnectedVerticies(previousHyperPointSet);
   //  hyperPointSet.addHyperPointSet(previousHyperPointSet);
   //  hyperPointSet.sort();
   //  hyperPointSet.removeDuplicates();
   //}
   //
   //hyperPointSet.push_back(_highCorner);
 
 
   //return hyperPointSet;
 
 }

◆ getWidth() [1/2]

HyperPoint HyperCuboid::getWidth ( ) const

Find width of the HyperCuboid as a HyperPoint

Definition at line 611 of file HyperCuboid.cpp.

                                       {
   return _highCorner - _lowCorner;  
 }

◆ getWidth() [2/2]

double HyperCuboid::getWidth ( int dim ) const

Find the width of the HyperCuboid in a given dimension

Definition at line 617 of file HyperCuboid.cpp.

                                          {
   return _highCorner.at(dim) - _lowCorner.at(dim);
 }

◆ inflateCuboid()

const HyperCuboid & HyperCuboid::inflateCuboid ( double percent )

Inflate the boundaries of the HyperCuboid by some percentage.

x_low_0' = x_low_0 - (x_high_0 - x_low_0) * percent

x_high_0' = x_high_0 + (x_high_0 - x_low_0) * percent

Definition at line 80 of file HyperCuboid.cpp.

                                                            {
 
   for (int i = 0; i < getDimension(); i++){
     double diff = getHighCorner().at(i) - getLowCorner().at(i);
     double increase = diff*percent;
     getHighCorner().at(i) = getHighCorner().at(i) + increase;
     getLowCorner() .at(i) = getLowCorner() .at(i) - increase;
   }  
   return *this;
 }

◆ inVolume() [1/2]

bool HyperCuboid::inVolume ( const HyperPoint & coords ) const

See if a HyperPoint is within the HyperCuboid volume

Definition at line 578 of file HyperCuboid.cpp.

                                                         {
 
   if (_lowCorner.allLT(coords) &&  _highCorner.allGTOE(coords)) return 1;
   return 0;
 
 }

◆ inVolume() [2/2]

bool HyperCuboid::inVolume	(	const HyperPoint &	coords,
		std::vector< int >	dims
	)		const

See if a HyperPoint is within the HyperCuboid volume, but only for selected dimensions.

Definition at line 587 of file HyperCuboid.cpp.

                                                                              {
 
   for (unsigned i = 0; i < dims.size(); i++){
     int dim = dims.at(i);
     double minEdge = getLowCorner ().at(dim);
     double maxEdge = getHighCorner().at(dim);
     double val     = coords.at(dim);
     if ( ( minEdge < val && val <= maxEdge ) == false ) return false;
   }
 
   return true;
 
 }

◆ operator !=()

bool HyperCuboid::operator != ( const HyperCuboid & other ) const

See if two HyperCuboids are not the same

Definition at line 65 of file HyperCuboid.cpp.

                                                            {
   if (other.getDimension() != this->getDimension()) {
     ERROR_LOG << "Trying to compare HyperCuboids of different dimensions, returning false";
     return false; 
   }
   if (getLowCorner()  != other.getLowCorner() ) return true;
   if (getHighCorner() != other.getHighCorner()) return true;
   return false;
 }

◆ operator==()

bool HyperCuboid::operator== ( const HyperCuboid & other ) const

See if two HyperCuboids are the same

Definition at line 53 of file HyperCuboid.cpp.

                                                            {
   if (other.getDimension() != this->getDimension()) {
     ERROR_LOG << "Trying to compare HyperCuboids of different dimensions, returning false";
     return false; 
   }
   if (getLowCorner()  != other.getLowCorner() ) return false;
   if (getHighCorner() != other.getHighCorner()) return false;
   return true;
 }

◆ print()

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

Print the HyperCuboid to given std::ostream

Definition at line 99 of file HyperCuboid.cpp.

                                                         {
 
   os << "Lower Corner: ";
   _lowCorner.print(os, 0);
   os << "     High Corner: ";
   _highCorner.print(os, 0);
   if (endline) os << std::endl;
 
 }

◆ project()

HyperCuboid HyperCuboid::project ( std::vector< int > dims ) const

Project the HyperCuboid into a lower dimensional space. E.g. start with HyperCuboid defined by (0,-1,-2) , (0,+1,+2) and project over dimensions 0 and 2. This would return a HyperCuboid defined by (0,-2) , (0,+2)

Definition at line 113 of file HyperCuboid.cpp.

                                                          {
   
   int newdim = (int)dims.size();
   HyperPoint lowCorner (newdim);
   HyperPoint highCorner(newdim);
 
   for (int i = 0; i < newdim; i++){
     lowCorner .at(i) = getLowCorner ().at( dims.at(i) );
     highCorner.at(i) = getHighCorner().at( dims.at(i) );
   }
 
   return HyperCuboid(lowCorner, highCorner);
 
 }

◆ projectOpposite()

HyperCuboid HyperCuboid::projectOpposite ( std::vector< int > dims ) const

Project the HyperCuboid into a lower dimensional space. E.g. start with HyperCuboid defined by (0,-1,-2) , (0,+1,+2) and projectOpposite over dimensions 1. This would return a HyperCuboid defined by (0,-2) , (0,+2)

Definition at line 132 of file HyperCuboid.cpp.

                                                                  {
   
   int currentDim = getDimension();
   int newdim     = (int)dims.size();
   
   std::vector<int> projdims;
 
   for (int i = 0; i < currentDim; i++){
     bool doesExist = false;
     for (int j = 0; j < newdim; j++){
       int dim = dims.at(j);
       if (i == dim) doesExist = true;
     }
 
     if (doesExist == false) projdims.push_back(i);
   }  
 
   return project(projdims);
 
 }

◆ setCorners()

bool HyperCuboid::setCorners	(	const HyperPoint &	lowCorner,
		const HyperPoint &	highCorner
	)

Set the upper and lower corners of the HyperCuboid

Definition at line 563 of file HyperCuboid.cpp.

                                                                                      {
 
   if (lowCorner.allLTOE(highCorner)){
     _lowCorner  = lowCorner;
     _highCorner = highCorner;
   }
   else{
     ERROR_LOG << "Your lowCorner isn't lower than your highCorner" <<std::endl;
     return 0;
   }
   return 1;
 }

◆ split() [1/2]

HyperVolume HyperCuboid::split	(	int	dimension,
		double	fractionalSplitPoint
	)		const

split the cuboid into two along the dimension given and return the resulting HyperCuboids in a HyperCuboidSet. The fractional split point [0,1] decides where (in that dimesnion) the split is

Definition at line 687 of file HyperCuboid.cpp.

                                                                               {
 
   return HyperVolume(
              splitBelow(dimension,fractionalSplitPoint), 
              splitAbove(dimension,fractionalSplitPoint)
              );
 
 }

◆ split() [2/2]

void HyperCuboid::split	(	int	dimension,
		double	fractionalSplitPoint,
		HyperVolume &	set
	)		const

split the cuboid into two along the dimension given and append the resulting HyperCuboids to the HyperCuboidSet given. The fractional split point [0,1] decides where (in that dimesnion) the split is

Definition at line 699 of file HyperCuboid.cpp.

                                                                                          {
 
   set.push_back( splitBelow(dimension,fractionalSplitPoint) );
   set.push_back( splitAbove(dimension,fractionalSplitPoint) );
 
 }

◆ splitAbove()

HyperCuboid HyperCuboid::splitAbove	(	int	dimension,
		double	fractionalSplitPoint
	)		const

split the cuboid into two along the dimension given and return the resulting HyperCuboid. The fractional split point [0,1] decides where (in that dimesnion) the split is

Definition at line 656 of file HyperCuboid.cpp.

                                                                                    {
   
   if (dimension < 0 || dimension >= getDimension()){
     ERROR_LOG << "You cannot split in a dimension that doesn't exist!!" << std::endl;
     return HyperCuboid(*this);
   }
   if (fractionalSplitPoint <= 0.0 || fractionalSplitPoint >= 1.0){
     ERROR_LOG << "Your fractional split point must be between 0.0 and 1.0" << std::endl;
     return HyperCuboid(*this);
   }
 
   HyperPoint lowCorner2 (_lowCorner );
   HyperPoint highCorner2(_highCorner);
   
   double low   = _lowCorner .at(dimension);
   double high  = _highCorner.at(dimension);
   double width = high - low;
 
   double splitCoord = low + width*fractionalSplitPoint;
 
   lowCorner2 .at(dimension) = splitCoord;
 
   HyperCuboid highCuboid(lowCorner2, highCorner2); 
   
   return highCuboid;
 
 }

◆ splitBelow()

HyperCuboid HyperCuboid::splitBelow	(	int	dimension,
		double	fractionalSplitPoint
	)		const

split the cuboid into two along the dimension given and return the resulting HyperCuboid. The fractional split point [0,1] decides where (in that dimesnion) the split is

Definition at line 625 of file HyperCuboid.cpp.

                                                                                    {
   
   if (dimension < 0 || dimension >= getDimension()){
     ERROR_LOG << "You cannot split in a dimension that doesn't exist!!" << std::endl;
     return HyperCuboid(*this);
   }
   if (fractionalSplitPoint <= 0.0 || fractionalSplitPoint >= 1.0){
     ERROR_LOG << "Your fractional split point must be between 0.0 and 1.0" << std::endl;
     return HyperCuboid(*this);
   }
 
   HyperPoint lowCorner1 (_lowCorner );
   HyperPoint highCorner1(_highCorner);
   
   double low   = _lowCorner .at(dimension);
   double high  = _highCorner.at(dimension);
   double width = high - low;
 
   double splitCoord = low + width*fractionalSplitPoint;
 
   highCorner1.at(dimension) = splitCoord;
 
   HyperCuboid lowCuboid (lowCorner1, highCorner1); 
   
   return lowCuboid;
 
 } 

◆ updateFaceCash()

void HyperCuboid::updateFaceCash ( ) const

private

It takes a while to find all the HyperPlanes (that define the faces of the HyperCuboid), so they are cashed using this function. Beware if you later change the corners of the HyperCuboid

Definition at line 293 of file HyperCuboid.cpp.

                                       {
   
   if(_faces.size() == 0) _faces = getBoundaryHyperPlanes();
 
 }

◆ volume()

double HyperCuboid::volume ( ) const

Find the volume of the HyperCuboid

Definition at line 603 of file HyperCuboid.cpp.

                                 {
   
   return (_highCorner - _lowCorner).multiplyElements();
 
 }

Member Data Documentation

◆ _dimension

int HyperCuboid::_dimension

private

The dimensionality of the cuboid

Definition at line 32 of file HyperCuboid.h.

◆ _faces

std::vector<HyperPlane> HyperCuboid::_faces

mutableprivate

The HyperPlanes that define the faces of the cuboid. Dy default these are not filled, but if needed it's useful to cashe them here

Definition at line 39 of file HyperCuboid.h.

◆ _highCorner

HyperPoint HyperCuboid::_highCorner

private

The higher corner of the cuboid

Definition at line 35 of file HyperCuboid.h.

◆ _lowCorner

HyperPoint HyperCuboid::_lowCorner

private

The lower corner of the cuboid

Definition at line 34 of file HyperCuboid.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HyperCuboid() [1/3]

◆ HyperCuboid() [2/3]

◆ HyperCuboid() [3/3]

◆ ~HyperCuboid()

Member Function Documentation

◆ getBoundaryHyperPlanes()

◆ getCenter()

◆ getConnectedHyperPlanes() [1/2]

◆ getConnectedHyperPlanes() [2/2]

◆ getConnectedVerticies() [1/2]

◆ getConnectedVerticies() [2/2]

◆ getDimension()

◆ getEdgeCenters()

◆ getHighCorner() [1/2]

◆ getHighCorner() [2/2]

◆ getLowCorner() [1/2]

◆ getLowCorner() [2/2]

◆ getNegativeIntersectionParameter()

◆ getNegativeIntersectionPoint()

◆ getOppositePoint()

◆ getPositiveIntersectionParameter()

◆ getPositiveIntersectionPoint()

◆ getRandomPoint()

◆ getRandomPoints()

◆ getVertices()

◆ getWidth() [1/2]

◆ getWidth() [2/2]

◆ inflateCuboid()

◆ inVolume() [1/2]

◆ inVolume() [2/2]

◆ operator !=()

◆ operator==()

◆ print()

◆ project()

◆ projectOpposite()

◆ setCorners()

◆ split() [1/2]

◆ split() [2/2]

◆ splitAbove()

◆ splitBelow()

◆ updateFaceCash()

◆ volume()

Member Data Documentation

◆ _dimension

◆ _faces

◆ _highCorner

◆ _lowCorner