smp::region< NUM_DIMENSIONS > Class Template Reference

A rectangular region in an Euclidean space of prespecified dimension. More...

#include <region.h>

List of all members.

Public Member Functions

 region (const region< NUM_DIMENSIONS > &region_in)
 Copy constructor.
const region< NUM_DIMENSIONS > & operator= (const region< NUM_DIMENSIONS > &region_in)
 Equality operator.

Public Attributes

double center [NUM_DIMENSIONS]
 The coordinates of the center of the region.
double size [NUM_DIMENSIONS]
 The size of the region in each dimension.

Detailed Description

template<int NUM_DIMENSIONS>
class smp::region< NUM_DIMENSIONS >

A rectangular region in an Euclidean space of prespecified dimension.

This class implements a rectangular in an Euclidean space of a certain dimension given by a template parameter.

Examples:

libbot_rrg_double_integrator.cpp, libbot_rrg_dubins_car.cpp, libbot_rrg_dubins_double_integrator_airplane.cpp, libbot_rrg_single_integrator.cpp, libbot_rrg_single_integrator_mu_calculus.cpp, libbot_rrt_double_integrator.cpp, libbot_rrt_dubins_car.cpp, libbot_rrt_dubins_double_integrator_airplane.cpp, libbot_rrt_single_integrator.cpp, libbot_rrtstar_double_integrator.cpp, libbot_rrtstar_dubins_car.cpp, libbot_rrtstar_dubins_double_integrator_airplane.cpp, libbot_rrtstar_single_integrator.cpp, libbot_rrtstar_single_integrator_halton.cpp, libbot_rrtstar_single_integrator_trajectory_biasing.cpp, libbot_rrtstar_single_integrator_trajectory_biasing_and_bnb.cpp, standalone_rrg_double_integrator.cpp, standalone_rrg_dubins_car.cpp, standalone_rrg_dubins_double_integrator_airplane.cpp, standalone_rrg_single_integrator.cpp, standalone_rrg_single_integrator_mu_calculus.cpp, standalone_rrt_double_integrator.cpp, standalone_rrt_dubins_car.cpp, standalone_rrt_dubins_double_integrator_airplane.cpp, standalone_rrt_single_integrator.cpp, standalone_rrtstar_double_integrator.cpp, standalone_rrtstar_dubins_car.cpp, standalone_rrtstar_dubins_double_integrator_airplane.cpp, standalone_rrtstar_single_integrator.cpp, standalone_rrtstar_single_integrator_halton.cpp, standalone_rrtstar_single_integrator_trajectory_biasing.cpp, and standalone_rrtstar_single_integrator_trajectory_biasing_and_bnb.cpp.


Member Function Documentation

template<int NUM_DIMENSIONS>
const region<NUM_DIMENSIONS>& smp::region< NUM_DIMENSIONS >::operator= ( const region< NUM_DIMENSIONS > &  region_in)

Equality operator.

Two states are equal if and only if all their components are equal. This function checks whether this criterion is satisfied.


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