ompl::base::RealVectorBounds Class Reference

The lower and upper bounds for an Rn space. More...

#include <ompl/base/spaces/RealVectorBounds.h>

Public Member Functions

 RealVectorBounds (unsigned int dim)
 Constructor; dim represents the dimension of the space these bounds are for. More...
 
void setLow (double value)
 Set the lower bound in each dimension to a specific value. More...
 
void setHigh (double value)
 Set the upper bound in each dimension to a specific value. More...
 
void setLow (unsigned int index, double value)
 Set the lower bound of a dimension to a specific value. More...
 
void setHigh (unsigned int index, double value)
 Set the upper bound of a dimension to a specific value. More...
 
void resize (std::size_t size)
 Change the number of dimensions for the bounds. More...
 
double getVolume () const
 Compute the volume of the space enclosed by the bounds. More...
 
std::vector< double > getDifference () const
 Get the difference between the high and low bounds for each dimension: result[i] = high[i] - low[i]. More...
 
void check () const
 Check if the bounds are valid (same length for low and high, high[i] > low[i]). Throw an exception if this is not the case. More...
 

Public Attributes

std::vector< double > low
 Lower bound. More...
 
std::vector< double > high
 Upper bound. More...
 

Detailed Description

The lower and upper bounds for an Rn space.

Definition at line 47 of file RealVectorBounds.h.

Constructor & Destructor Documentation

◆ RealVectorBounds()

ompl::base::RealVectorBounds::RealVectorBounds ( unsigned int  dim)
inline

Constructor; dim represents the dimension of the space these bounds are for.

Definition at line 51 of file RealVectorBounds.h.

Member Function Documentation

◆ check()

void ompl::base::RealVectorBounds::check ( ) const

Check if the bounds are valid (same length for low and high, high[i] > low[i]). Throw an exception if this is not the case.

Definition at line 89 of file RealVectorBounds.cpp.

◆ getDifference()

std::vector< double > ompl::base::RealVectorBounds::getDifference ( ) const

Get the difference between the high and low bounds for each dimension: result[i] = high[i] - low[i].

Definition at line 62 of file RealVectorBounds.cpp.

◆ getVolume()

double ompl::base::RealVectorBounds::getVolume ( ) const

Compute the volume of the space enclosed by the bounds.

Definition at line 71 of file RealVectorBounds.cpp.

◆ resize()

void ompl::base::RealVectorBounds::resize ( std::size_t  size)

Change the number of dimensions for the bounds.

Definition at line 83 of file RealVectorBounds.cpp.

◆ setHigh() [1/2]

void ompl::base::RealVectorBounds::setHigh ( double  value)

Set the upper bound in each dimension to a specific value.

Definition at line 47 of file RealVectorBounds.cpp.

◆ setHigh() [2/2]

void ompl::base::RealVectorBounds::setHigh ( unsigned int  index,
double  value 
)

Set the upper bound of a dimension to a specific value.

Definition at line 57 of file RealVectorBounds.cpp.

◆ setLow() [1/2]

void ompl::base::RealVectorBounds::setLow ( double  value)

Set the lower bound in each dimension to a specific value.

Definition at line 42 of file RealVectorBounds.cpp.

◆ setLow() [2/2]

void ompl::base::RealVectorBounds::setLow ( unsigned int  index,
double  value 
)

Set the lower bound of a dimension to a specific value.

Definition at line 52 of file RealVectorBounds.cpp.

Member Data Documentation

◆ high

std::vector<double> ompl::base::RealVectorBounds::high

Upper bound.

Definition at line 87 of file RealVectorBounds.h.

◆ low

std::vector<double> ompl::base::RealVectorBounds::low

Lower bound.

Definition at line 84 of file RealVectorBounds.h.


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