ompl::base::RealVectorBounds Class Reference

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

#include <RealVectorBounds.h>

List of all members.

Public Member Functions

void check (void) 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.
std::vector< double > getDifference (void) const
 Get the difference between the high and low bounds for each dimension: result[i] = high[i] - low[i].
double getVolume (void) const
 Compute the volume of the space enclosed by the bounds.
 RealVectorBounds (unsigned int dim)
 Constructor; dim represents the dimension of the space these bounds are for.
void setHigh (unsigned int index, double value)
 Set the upper bound of a dimension to a specific value.
void setHigh (double value)
 Set the upper bound in each dimension to a specific value.
void setLow (unsigned int index, double value)
 Set the lower bound of a dimension to a specific value.
void setLow (double value)
 Set the lower bound in each dimension to a specific value.

Public Attributes

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

Detailed Description

The lower and upper bounds for an Rn space.

Definition at line 48 of file RealVectorBounds.h.


Constructor & Destructor Documentation

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

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

Definition at line 53 of file RealVectorBounds.h.


Member Function Documentation

void ompl::base::RealVectorBounds::check ( void   )  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.

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

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

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

Compute the volume of the space enclosed by the bounds.

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

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

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

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

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

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

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

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


Member Data Documentation

Upper bound.

Definition at line 86 of file RealVectorBounds.h.

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

Lower bound.

Definition at line 83 of file RealVectorBounds.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:34:00 2013