| Line |
Branch |
Exec |
Source |
| 1 |
|
|
// |
| 2 |
|
|
// Copyright (c) 2014 CNRS |
| 3 |
|
|
// Authors: Florent Lamiraux |
| 4 |
|
|
// |
| 5 |
|
|
|
| 6 |
|
|
// Redistribution and use in source and binary forms, with or without |
| 7 |
|
|
// modification, are permitted provided that the following conditions are |
| 8 |
|
|
// met: |
| 9 |
|
|
// |
| 10 |
|
|
// 1. Redistributions of source code must retain the above copyright |
| 11 |
|
|
// notice, this list of conditions and the following disclaimer. |
| 12 |
|
|
// |
| 13 |
|
|
// 2. Redistributions in binary form must reproduce the above copyright |
| 14 |
|
|
// notice, this list of conditions and the following disclaimer in the |
| 15 |
|
|
// documentation and/or other materials provided with the distribution. |
| 16 |
|
|
// |
| 17 |
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 18 |
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 19 |
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 20 |
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 21 |
|
|
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 22 |
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 23 |
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 24 |
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 25 |
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 26 |
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 27 |
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
| 28 |
|
|
// DAMAGE. |
| 29 |
|
|
|
| 30 |
|
|
#ifndef HPP_CORE_PATH_OPTIMIZER_HH |
| 31 |
|
|
#define HPP_CORE_PATH_OPTIMIZER_HH |
| 32 |
|
|
|
| 33 |
|
|
#include <boost/date_time/posix_time/ptime.hpp> |
| 34 |
|
|
#include <hpp/core/config.hh> |
| 35 |
|
|
#include <hpp/core/fwd.hh> |
| 36 |
|
|
|
| 37 |
|
|
namespace hpp { |
| 38 |
|
|
namespace core { |
| 39 |
|
|
/// \addtogroup path_optimization |
| 40 |
|
|
/// \{ |
| 41 |
|
|
|
| 42 |
|
|
/// Abstraction of path optimizer |
| 43 |
|
|
/// |
| 44 |
|
|
class HPP_CORE_DLLAPI PathOptimizer { |
| 45 |
|
|
public: |
| 46 |
|
30 |
virtual ~PathOptimizer() {}; |
| 47 |
|
|
|
| 48 |
|
|
/// Get problem |
| 49 |
|
246 |
ProblemConstPtr_t problem() const { return problem_; } |
| 50 |
|
|
|
| 51 |
|
|
/// Optimize path |
| 52 |
|
|
virtual PathVectorPtr_t optimize(const PathVectorPtr_t& path) = 0; |
| 53 |
|
|
|
| 54 |
|
|
/// Interrupt path optimization |
| 55 |
|
✗ |
void interrupt() { interrupt_ = true; } |
| 56 |
|
|
/// Set maximal number of iterations |
| 57 |
|
|
void maxIterations(const unsigned long int& n); |
| 58 |
|
|
/// set time out (in seconds) |
| 59 |
|
|
void timeOut(const double& timeOut); |
| 60 |
|
|
|
| 61 |
|
|
protected: |
| 62 |
|
|
/// Whether to interrupt computation |
| 63 |
|
|
/// Set to false at start of optimize method, set to true by method |
| 64 |
|
|
/// interrupt. |
| 65 |
|
|
bool interrupt_; |
| 66 |
|
|
|
| 67 |
|
|
PathOptimizer(const ProblemConstPtr_t& problem); |
| 68 |
|
|
|
| 69 |
|
|
PathPtr_t steer(ConfigurationIn_t q1, ConfigurationIn_t q2) const; |
| 70 |
|
|
|
| 71 |
|
|
void monitorExecution(); |
| 72 |
|
|
|
| 73 |
|
21 |
void endIteration() { ++monitor_.iteration; } |
| 74 |
|
|
|
| 75 |
|
|
bool shouldStop() const; |
| 76 |
|
|
|
| 77 |
|
|
void initFromParameters(); |
| 78 |
|
|
|
| 79 |
|
|
private: |
| 80 |
|
|
ProblemConstPtr_t problem_; |
| 81 |
|
|
|
| 82 |
|
|
/// Maximal number of iterations to solve a problem |
| 83 |
|
|
/// reaching this bound raises an exception. |
| 84 |
|
|
size_type maxIterations_; |
| 85 |
|
|
/// Time out (in seconds) before interrupting the planning |
| 86 |
|
|
double timeOut_; |
| 87 |
|
|
|
| 88 |
|
|
/// Information used to monitor the execution of the algorithm. |
| 89 |
|
|
/// This information is: |
| 90 |
|
|
/// \li initialized by \ref monitorExecution |
| 91 |
|
|
/// \li updated by \ref endIteration |
| 92 |
|
|
/// \li read by \ref shouldStop |
| 93 |
|
|
struct { |
| 94 |
|
|
bool enabled; |
| 95 |
|
|
size_type iteration; |
| 96 |
|
|
boost::posix_time::ptime timeStart; |
| 97 |
|
|
} monitor_; |
| 98 |
|
|
}; // class PathOptimizer; |
| 99 |
|
|
/// } |
| 100 |
|
|
} // namespace core |
| 101 |
|
|
} // namespace hpp |
| 102 |
|
|
#endif // HPP_CORE_PATH_OPTIMIZER_HH |
| 103 |
|
|
|