/usr/include/ompl/base/Planner.h is in libompl-dev 1.2.1+ds1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | /*********************************************************************
* Software License Agreement (BSD License)
*
* Copyright (c) 2010, Rice University
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the Rice University nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/
/* Author: Ioan Sucan */
#ifndef OMPL_BASE_PLANNER_
#define OMPL_BASE_PLANNER_
#include "ompl/base/SpaceInformation.h"
#include "ompl/base/ProblemDefinition.h"
#include "ompl/base/PlannerData.h"
#include "ompl/base/PlannerStatus.h"
#include "ompl/base/PlannerTerminationCondition.h"
#include "ompl/base/GenericParam.h"
#include "ompl/util/Console.h"
#include "ompl/util/Time.h"
#include "ompl/util/ClassForward.h"
#include "ompl/util/Deprecation.h"
#include <functional>
#include <boost/concept_check.hpp>
#include <string>
#include <map>
namespace ompl
{
namespace base
{
/// @cond IGNORE
/** \brief Forward declaration of ompl::base::Planner */
OMPL_CLASS_FORWARD(Planner);
/// @endcond
/** \class ompl::base::PlannerPtr
\brief A shared pointer wrapper for ompl::base::Planner */
/** \brief Helper class to extract valid start & goal
states. Usually used internally by planners.
This class is meant to behave correctly if the user
updates the problem definition between subsequent calls to
ompl::base::Planner::solve() \b without calling
ompl::base::Planner::clear() in between. Only allowed
changes to the problem definition are accounted for:
adding of starring states or adding of goal states for
instances inherited from
ompl::base::GoalSampleableRegion. */
class PlannerInputStates
{
public:
/** \brief Default constructor. No work is performed. */
PlannerInputStates(const PlannerPtr &planner) : planner_(planner.get())
{
tempState_ = nullptr;
update();
}
/** \brief Default constructor. No work is performed. */
PlannerInputStates(const Planner *planner) : planner_(planner)
{
tempState_ = nullptr;
update();
}
/** \brief Default constructor. No work is performed. A
call to use() needs to be made, before making any
calls to nextStart() or nextGoal(). */
PlannerInputStates() : planner_(nullptr)
{
tempState_ = nullptr;
clear();
}
/** \brief Destructor. Clear allocated memory. */
~PlannerInputStates()
{
clear();
}
/** \brief Clear all stored information. */
void clear();
/** \brief Forget how many states were returned by
nextStart() and nextGoal() and return all states
again */
void restart();
/** \brief Set the space information and problem
definition this class operates on, based on the
available planner instance. Returns true if changes
were found (different problem definition) and clear()
was called. */
bool update();
/** \brief Set the problem definition this class operates on.
If a planner is not set in the constructor argument, a call
to this function is needed before any calls to nextStart()
or nextGoal() are made. Returns true if changes were found
(different problem definition) and clear() was called. */
bool use(const ProblemDefinitionPtr &pdef);
/** \brief Set the problem definition this class operates on.
If a planner is not set in the constructor argument, a call
to this function is needed before any calls to nextStart()
or nextGoal() are made. Returns true if changes were found
(different problem definition) and clear() was called. */
bool use(const ProblemDefinition *pdef);
/** \brief Check if the problem definition was set, start
state are available and goal was set */
void checkValidity() const;
/** \brief Return the next valid start state or nullptr if no
more valid start states are available. */
const State* nextStart();
/** \brief Return the next valid goal state or nullptr if no
more valid goal states are available. Because
sampling of goal states may also produce invalid
goals, this function takes an argument that specifies
whether a termination condition has been reached. If
the termination condition evaluates to true the
function terminates even if no valid goal has been
found. */
const State* nextGoal(const PlannerTerminationCondition &ptc);
/** \brief Same as above but only one attempt is made to find a valid goal. */
const State* nextGoal();
/** \brief Check if there are more potential start states */
bool haveMoreStartStates() const;
/** \brief Check if there are more potential goal states */
bool haveMoreGoalStates() const;
/** \brief Get the number of start states from the problem
definition that were already seen, including invalid
ones. */
unsigned int getSeenStartStatesCount() const
{
return addedStartStates_;
}
/** \brief Get the number of sampled goal states, including invalid ones */
unsigned int getSampledGoalsCount() const
{
return sampledGoalsCount_;
}
private:
const Planner *planner_;
unsigned int addedStartStates_;
unsigned int sampledGoalsCount_;
State *tempState_;
const ProblemDefinition *pdef_;
const SpaceInformation *si_;
};
/** \brief Properties that planners may have */
struct PlannerSpecs
{
PlannerSpecs() : recognizedGoal(GOAL_ANY), multithreaded(false), approximateSolutions(false),
optimizingPaths(false), directed(false), provingSolutionNonExistence(false),
canReportIntermediateSolutions(false)
{
}
/** \brief The type of goal specification the planner can use */
GoalType recognizedGoal;
/** \brief Flag indicating whether multiple threads are used in the computation of the planner */
bool multithreaded;
/** \brief Flag indicating whether the planner is able to compute approximate solutions */
bool approximateSolutions;
/** \brief Flag indicating whether the planner attempts to optimize the path and reduce its length until the
maximum path length specified by the goal representation is satisfied */
bool optimizingPaths;
/** \brief Flag indicating whether the planner is able to account for the fact that the validity of a motion from A to B may not be the same as the validity of a motion from B to A.
If this flag is true, the planner will return solutions that do not make this assumption. Usually roadmap-based planners make this assumption and tree-based planners do not. */
bool directed;
/** \brief Flag indicating whether the planner is able to prove that no solution path exists. */
bool provingSolutionNonExistence;
/** \brief Flag indicating whether the planner is able to report the computation of intermediate paths. */
bool canReportIntermediateSolutions;
};
/** \brief Base class for a planner */
class Planner
{
public:
// non-copyable
Planner(const Planner&) = delete;
Planner& operator=(const Planner&) = delete;
/** \brief Constructor */
Planner(const SpaceInformationPtr &si, const std::string &name);
/** \brief Destructor */
virtual ~Planner()
{
}
/** \brief Cast this instance to a desired type. */
template<class T>
T* as()
{
/** \brief Make sure the type we are casting to is indeed a planner */
BOOST_CONCEPT_ASSERT((boost::Convertible<T*, Planner*>));
return static_cast<T*>(this);
}
/** \brief Cast this instance to a desired type. */
template<class T>
const T* as() const
{
/** \brief Make sure the type we are casting to is indeed a Planner */
BOOST_CONCEPT_ASSERT((boost::Convertible<T*, Planner*>));
return static_cast<const T*>(this);
}
/** \brief Get the space information this planner is using */
const SpaceInformationPtr& getSpaceInformation() const;
/** \brief Get the problem definition the planner is trying to solve */
const ProblemDefinitionPtr& getProblemDefinition() const;
/** \brief Get the planner input states */
const PlannerInputStates& getPlannerInputStates() const;
/** \brief 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(). */
virtual void setProblemDefinition(const ProblemDefinitionPtr &pdef);
/** \brief 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 \e ptc
returns true. */
virtual PlannerStatus solve(const PlannerTerminationCondition &ptc) = 0;
/** \brief Same as above except the termination condition
is only evaluated at a specified interval. */
PlannerStatus solve(const PlannerTerminationConditionFn &ptc, double checkInterval);
/** \brief Same as above except the termination condition
is solely a time limit: the number of seconds the
algorithm is allowed to spend planning. */
PlannerStatus solve(double solveTime);
/** \brief Clear all internal datastructures. Planner
settings are not affected. Subsequent calls to solve()
will ignore all previous work. */
virtual void clear();
/** \brief Get information about the current run of the
motion planner. Repeated calls to this function will
update \e 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). */
virtual void getPlannerData(PlannerData &data) const;
/** \brief Get the name of the planner */
const std::string& getName() const;
/** \brief Set the name of the planner */
void setName(const std::string &name);
/** \brief Return the specifications (capabilities of this planner) */
const PlannerSpecs& getSpecs() const;
/** \brief 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 void setup();
/** \brief 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.*/
virtual void checkValidity();
/** \brief Check if setup() was called for this planner */
bool isSetup() const;
/** \brief Get the parameters for this planner */
ParamSet& params()
{
return params_;
}
/** \brief Get the parameters for this planner */
const ParamSet& params() const
{
return params_;
}
/** \brief Definition of a function which returns a property about the planner's progress that can be queried by a benchmarking routine */
typedef std::function<std::string ()> PlannerProgressProperty;
/** \brief A dictionary which maps the name of a progress property to the function to be used for querying that property */
typedef std::map<std::string, PlannerProgressProperty> PlannerProgressProperties;
/** \brief Retrieve a planner's planner progress property map */
const PlannerProgressProperties& getPlannerProgressProperties() const
{
return plannerProgressProperties_;
}
/** \brief Print properties of the motion planner */
virtual void printProperties(std::ostream &out) const;
/** \brief Print information about the motion planner's settings */
virtual void printSettings(std::ostream &out) const;
protected:
/** \brief This function declares a parameter for this planner instance, and specifies the setter and getter functions. */
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 = "")
{
params_.declareParam<T>(name, std::bind(setter, planner, std::placeholders::_1), std::bind(getter, planner));
if (!rangeSuggestion.empty())
params_[name].setRangeSuggestion(rangeSuggestion);
}
/** \brief This function declares a parameter for this planner instance, and specifies the setter function. */
template<typename T, typename PlannerType, typename SetterType>
void declareParam(const std::string &name, const PlannerType &planner, const SetterType& setter, const std::string &rangeSuggestion = "")
{
params_.declareParam<T>(name, std::bind(setter, planner, std::placeholders::_1));
if (!rangeSuggestion.empty())
params_[name].setRangeSuggestion(rangeSuggestion);
}
/** \brief Add a planner progress property called \e progressPropertyName with a property querying function \e prop to this planner's progress property map */
void addPlannerProgressProperty(const std::string& progressPropertyName, const PlannerProgressProperty& prop)
{
plannerProgressProperties_[progressPropertyName] = prop;
}
/** \brief The space information for which planning is done */
SpaceInformationPtr si_;
/** \brief The user set problem definition */
ProblemDefinitionPtr pdef_;
/** \brief Utility class to extract valid input states */
PlannerInputStates pis_;
/** \brief The name of this planner */
std::string name_;
/** \brief The specifications of the planner (its capabilities) */
PlannerSpecs specs_;
/** \brief A map from parameter names to parameter instances for this planner. This field is populated by the declareParam() function */
ParamSet params_;
/** \brief A mapping between this planner's progress property names and the functions used for querying those progress properties */
PlannerProgressProperties plannerProgressProperties_;
/** \brief Flag indicating whether setup() has been called */
bool setup_;
};
/** \brief Definition of a function that can allocate a planner */
typedef std::function<PlannerPtr(const SpaceInformationPtr&)> PlannerAllocator;
}
}
#endif
|