RRT.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2008, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Author: Ioan Sucan */
36 
37 #ifndef OMPL_GEOMETRIC_PLANNERS_RRT_RRT_
38 #define OMPL_GEOMETRIC_PLANNERS_RRT_RRT_
39 
40 #include "ompl/geometric/planners/PlannerIncludes.h"
41 #include "ompl/datastructures/NearestNeighbors.h"
42 
43 namespace ompl
44 {
45  namespace geometric
46  {
65  class RRT : public base::Planner
66  {
67  public:
69  RRT(const base::SpaceInformationPtr &si);
70 
71  ~RRT() override;
72 
73  void getPlannerData(base::PlannerData &data) const override;
74 
76 
77  void clear() override;
78 
88  void setGoalBias(double goalBias)
89  {
90  goalBias_ = goalBias;
91  }
92 
94  double getGoalBias() const
95  {
96  return goalBias_;
97  }
98 
104  void setRange(double distance)
105  {
106  maxDistance_ = distance;
107  }
108 
110  double getRange() const
111  {
112  return maxDistance_;
113  }
114 
116  template <template <typename T> class NN>
118  {
119  if (nn_ && nn_->size() != 0)
120  OMPL_WARN("Calling setNearestNeighbors will clear all states.");
121  clear();
122  nn_ = std::make_shared<NN<Motion *>>();
123  setup();
124  }
125 
126  void setup() override;
127 
128  protected:
133  class Motion
134  {
135  public:
136  Motion() : state(nullptr), parent(nullptr)
137  {
138  }
139 
141  Motion(const base::SpaceInformationPtr &si) : state(si->allocState()), parent(nullptr)
142  {
143  }
144 
145  ~Motion() = default;
146 
149 
152  };
153 
155  void freeMemory();
156 
158  double distanceFunction(const Motion *a, const Motion *b) const
159  {
160  return si_->distance(a->state, b->state);
161  }
162 
165 
167  std::shared_ptr<NearestNeighbors<Motion *>> nn_;
168 
171  double goalBias_;
172 
174  double maxDistance_;
175 
178 
181  };
182  }
183 }
184 
185 #endif
double maxDistance_
The maximum length of a motion to be added to a tree.
Definition: RRT.h:174
base::StateSamplerPtr sampler_
State sampler.
Definition: RRT.h:164
Motion(const base::SpaceInformationPtr &si)
Constructor that allocates memory for the state.
Definition: RRT.h:141
Object containing planner generated vertex and edge data. It is assumed that all vertices are unique...
Definition: PlannerData.h:174
std::shared_ptr< NearestNeighbors< Motion * > > nn_
A nearest-neighbors datastructure containing the tree of motions.
Definition: RRT.h:167
double getGoalBias() const
Get the goal bias the planner is using.
Definition: RRT.h:94
Motion * parent
The parent motion in the exploration tree.
Definition: RRT.h:151
A shared pointer wrapper for ompl::base::StateSampler.
void setRange(double distance)
Set the range the planner is supposed to use.
Definition: RRT.h:104
void setup() override
Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceIn...
Definition: RRT.cpp:70
Encapsulate a termination condition for a motion planner. Planners will call operator() to decide whe...
void clear() override
Clear all internal datastructures. Planner settings are not affected. Subsequent calls to solve() wil...
Definition: RRT.cpp:60
Main namespace. Contains everything in this library.
Definition: AppBase.h:21
Random number generation. An instance of this class cannot be used by multiple threads at once (membe...
Definition: RandomNumbers.h:58
RNG rng_
The random number generator.
Definition: RRT.h:177
Base class for a planner.
Definition: Planner.h:232
base::PlannerStatus solve(const base::PlannerTerminationCondition &ptc) override
Function that can solve the motion planning problem. This function can be called multiple times on th...
Definition: RRT.cpp:99
A class to store the exit status of Planner::solve()
Definition: PlannerStatus.h:48
Rapidly-exploring Random Trees.
Definition: RRT.h:65
A shared pointer wrapper for ompl::base::SpaceInformation.
void freeMemory()
Free the memory allocated by this planner.
Definition: RRT.cpp:84
double distanceFunction(const Motion *a, const Motion *b) const
Compute distance between motions (actually distance between contained states)
Definition: RRT.h:158
Definition of an abstract state.
Definition: State.h:49
Motion * lastGoalMotion_
The most recent goal motion. Used for PlannerData computation.
Definition: RRT.h:180
#define OMPL_WARN(fmt,...)
Log a formatted warning string.
Definition: Console.h:66
void getPlannerData(base::PlannerData &data) const override
Get information about the current run of the motion planner. Repeated calls to this function will upd...
Definition: RRT.cpp:212
double getRange() const
Get the range the planner is using.
Definition: RRT.h:110
Representation of a motion.
Definition: RRT.h:133
RRT(const base::SpaceInformationPtr &si)
Constructor.
Definition: RRT.cpp:42
void setNearestNeighbors()
Set a different nearest neighbors datastructure.
Definition: RRT.h:117
SpaceInformationPtr si_
The space information for which planning is done.
Definition: Planner.h:415
double goalBias_
The fraction of time the goal is picked as the state to expand towards (if such a state is available)...
Definition: RRT.h:171
void setGoalBias(double goalBias)
Set the goal bias.
Definition: RRT.h:88
base::State * state
The state contained by the motion.
Definition: RRT.h:148