ompl::base::GaussianValidStateSampler Class Reference

Generate valid samples using the Gaussian sampling strategy. More...

#include <GaussianValidStateSampler.h>

Inheritance diagram for ompl::base::GaussianValidStateSampler:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 GaussianValidStateSampler (const SpaceInformation *si)
 Constructor.
double getStdDev (void) const
 Get the standard deviation used when sampling.
virtual bool sample (State *state)
 Sample a state. Return false in case of failure.
virtual bool sampleNear (State *state, const State *near, const double distance)
 Sample a state near another, within specified distance. Return false, in case of failure.
void setStdDev (double stddev)
 Set the standard deviation to use when sampling.
virtual ~GaussianValidStateSampler (void)

Protected Attributes

StateSamplerPtr sampler_
 The sampler to build upon.
double stddev_
 The standard deviation to use in the sampling process.

Detailed Description

Generate valid samples using the Gaussian sampling strategy.

Definition at line 49 of file GaussianValidStateSampler.h.


Constructor & Destructor Documentation

ompl::base::GaussianValidStateSampler::GaussianValidStateSampler ( const SpaceInformation si  ) 

Constructor.

virtual ompl::base::GaussianValidStateSampler::~GaussianValidStateSampler ( void   )  [inline, virtual]

Definition at line 56 of file GaussianValidStateSampler.h.


Member Function Documentation

double ompl::base::GaussianValidStateSampler::getStdDev ( void   )  const [inline]

Get the standard deviation used when sampling.

Definition at line 64 of file GaussianValidStateSampler.h.

virtual bool ompl::base::GaussianValidStateSampler::sample ( State state  )  [virtual]

Sample a state. Return false in case of failure.

Implements ompl::base::ValidStateSampler.

virtual bool ompl::base::GaussianValidStateSampler::sampleNear ( State state,
const State near,
const double  distance 
) [virtual]

Sample a state near another, within specified distance. Return false, in case of failure.

Note:
The memory for near must be disjoint from the memory for state

Implements ompl::base::ValidStateSampler.

void ompl::base::GaussianValidStateSampler::setStdDev ( double  stddev  )  [inline]

Set the standard deviation to use when sampling.

Definition at line 70 of file GaussianValidStateSampler.h.


Member Data Documentation

The sampler to build upon.

Definition at line 78 of file GaussianValidStateSampler.h.

The standard deviation to use in the sampling process.

Definition at line 81 of file GaussianValidStateSampler.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:33:59 2013