Lazy Bi-directional KPIECE with one level of discretization. More...
#include <LBKPIECE1.h>
Classes | |
class | Motion |
Representation of a motion for this algorithm. More... | |
Public Member Functions | |
LBKPIECE1 (const base::SpaceInformationPtr &si) | |
Constructor. | |
void | setProjectionEvaluator (const base::ProjectionEvaluatorPtr &projectionEvaluator) |
Set the projection evaluator. This class is able to compute the projection of a given state. | |
void | setProjectionEvaluator (const std::string &name) |
Set the projection evaluator (select one from the ones registered with the state space). | |
const base::ProjectionEvaluatorPtr & | getProjectionEvaluator (void) const |
Get the projection evaluator. | |
void | setRange (double distance) |
Set the range the planner is supposed to use. More... | |
double | getRange (void) const |
Get the range the planner is using. | |
void | setBorderFraction (double bp) |
Set the fraction of time for focusing on the border (between 0 and 1). This is the minimum fraction used to select cells that are exterior (minimum because if 95% of cells are on the border, they will be selected with 95% chance, even if this fraction is set to 90%) | |
double | getBorderFraction (void) const |
Get the fraction of time to focus exploration on boundary. | |
void | setMinValidPathFraction (double fraction) |
When extending a motion, the planner can decide to keep the first valid part of it, even if invalid states are found, as long as the valid part represents a sufficiently large fraction from the original motion. This function sets the minimum acceptable fraction. | |
double | getMinValidPathFraction (void) const |
Get the value of the fraction set by setMinValidPathFraction() | |
virtual void | setup (void) |
Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceInformation::setup() if needed. This must be called before solving. | |
virtual base::PlannerStatus | solve (const base::PlannerTerminationCondition &ptc) |
Function that can solve the motion planning problem. This function can be called multiple times on the same problem, without calling clear() in between. This allows the planner to continue work for more time on an unsolved problem, for example. If this option is used, it is assumed the problem definition is not changed (unpredictable results otherwise). The only change in the problem definition that is accounted for is the addition of starting or goal states (but not changing previously added start/goal states). The function terminates if the call to ptc returns true. | |
virtual void | clear (void) |
Clear all internal datastructures. Planner settings are not affected. Subsequent calls to solve() will ignore all previous work. | |
virtual void | getPlannerData (base::PlannerData &data) const |
Get information about the current run of the motion planner. Repeated calls to this function will update data (only additions are made). This is useful to see what changed in the exploration datastructure, between calls to solve(), for example (without calling clear() in between). | |
![]() | |
Planner (const SpaceInformationPtr &si, const std::string &name) | |
Constructor. | |
virtual | ~Planner (void) |
Destructor. | |
template<class T > | |
T * | as (void) |
Cast this instance to a desired type. More... | |
template<class T > | |
const T * | as (void) const |
Cast this instance to a desired type. More... | |
const SpaceInformationPtr & | getSpaceInformation (void) const |
Get the space information this planner is using. | |
const ProblemDefinitionPtr & | getProblemDefinition (void) const |
Get the problem definition the planner is trying to solve. | |
const PlannerInputStates & | getPlannerInputStates (void) const |
Get the planner input states. | |
virtual void | setProblemDefinition (const ProblemDefinitionPtr &pdef) |
Set the problem definition for the planner. The problem needs to be set before calling solve(). Note: If this problem definition replaces a previous one, it may also be necessary to call clear(). | |
PlannerStatus | solve (const PlannerTerminationConditionFn &ptc, double checkInterval) |
Same as above except the termination condition is only evaluated at a specified interval. | |
PlannerStatus | solve (double solveTime) |
Same as above except the termination condition is solely a time limit: the number of seconds the algorithm is allowed to spend planning. | |
const std::string & | getName (void) const |
Get the name of the planner. | |
void | setName (const std::string &name) |
Set the name of the planner. | |
const PlannerSpecs & | getSpecs (void) const |
Return the specifications (capabilities of this planner) | |
virtual void | checkValidity (void) |
Check to see if the planner is in a working state (setup has been called, a goal was set, the input states seem to be in order). In case of error, this function throws an exception. | |
bool | isSetup (void) const |
Check if setup() was called for this planner. | |
ParamSet & | params (void) |
Get the parameters for this planner. | |
const ParamSet & | params (void) const |
Get the parameters for this planner. | |
virtual void | printProperties (std::ostream &out) const |
Print properties of the motion planner. | |
virtual void | printSettings (std::ostream &out) const |
Print information about the motion planner's settings. | |
Protected Member Functions | |
void | freeMotion (Motion *motion) |
Free the memory for a motion. | |
void | removeMotion (Discretization< Motion > &disc, Motion *motion) |
Remove a motion from a tree of motions. | |
bool | isPathValid (Discretization< Motion > &disc, Motion *motion, base::State *temp) |
Since solutions are computed in a lazy fashion, once trees are connected, the solution found needs to be checked for validity. This function checks whether the reverse path from a given motion to a root is valid. If this is not the case, invalid motions are removed. | |
![]() | |
template<typename T , typename PlannerType , typename SetterType , typename GetterType > | |
void | declareParam (const std::string &name, const PlannerType &planner, const SetterType &setter, const GetterType &getter, const std::string &rangeSuggestion="") |
This function declares a parameter for this planner instance, and specifies the setter and getter functions. | |
template<typename T , typename PlannerType , typename SetterType > | |
void | declareParam (const std::string &name, const PlannerType &planner, const SetterType &setter, const std::string &rangeSuggestion="") |
This function declares a parameter for this planner instance, and specifies the setter function. | |
Protected Attributes | |
base::StateSamplerPtr | sampler_ |
The employed state sampler. | |
base::ProjectionEvaluatorPtr | projectionEvaluator_ |
The employed projection evaluator. | |
Discretization< Motion > | dStart_ |
The start tree. | |
Discretization< Motion > | dGoal_ |
The goal tree. | |
double | minValidPathFraction_ |
When extending a motion, the planner can decide to keep the first valid part of it, even if invalid states are found, as long as the valid part represents a sufficiently large fraction from the original motion. | |
double | maxDistance_ |
The maximum length of a motion to be added to a tree. | |
RNG | rng_ |
The random number generator. | |
std::pair< base::State *, base::State * > | connectionPoint_ |
The pair of states in each tree connected during planning. Used for PlannerData computation. | |
![]() | |
SpaceInformationPtr | si_ |
The space information for which planning is done. | |
ProblemDefinitionPtr | pdef_ |
The user set problem definition. | |
PlannerInputStates | pis_ |
Utility class to extract valid input states. | |
std::string | name_ |
The name of this planner. | |
PlannerSpecs | specs_ |
The specifications of the planner (its capabilities) | |
ParamSet | params_ |
A map from parameter names to parameter instances for this planner. This field is populated by the declareParam() function. | |
bool | setup_ |
Flag indicating whether setup() has been called. | |
Lazy Bi-directional KPIECE with one level of discretization.
Definition at line 78 of file LBKPIECE1.h.
|
inline |
Set the range the planner is supposed to use.
This parameter greatly influences the runtime of the algorithm. It represents the maximum length of a motion to be added in the tree of motions.
Definition at line 112 of file LBKPIECE1.h.