Public Member Functions | |
| ForwardQueue (const std::shared_ptr< const ompl::base::OptimizationObjective > &objective, const std::shared_ptr< const ompl::base::StateSpace > &space) | |
| Constructs the queue given the objective and state space. | |
| ~ForwardQueue ()=default | |
| Destructs the queue. | |
| bool | empty () const |
| Returns whether the queue is empty. | |
| std::size_t | size () const |
| Returns how many elements are in the queue. | |
| void | insertOrUpdate (const Edge &edge) |
| Inserts or updates an edge in the queue. | |
| void | insertOrUpdate (const std::vector< Edge > &edges) |
| Inserts or updates multiple edges into the queue. | |
| void | remove (const Edge &edge) |
| Removes an edge from the queue. Throws if the edge is not in the queue. | |
| void | updateIfExists (const Edge &edge) |
| Update an edge in the queue. Does nothing if the edge is not in the queue. | |
| Edge | peek (double suboptimalityFactor) |
| Returns a copy to the next edge. | |
| Edge | pop (double suboptimalityFactor) |
| Returns and deletes the top element of the queue. | |
| ompl::base::Cost | getLowerBoundOnOptimalSolutionCost () const |
| Returns a lower bound on the resolution-optimal solution cost. | |
| bool | containsOpenTargets (std::size_t reverseSearchTag) const |
| Returns whether the queue contains edges with targets that are open or unconnected in the reverse search tree. | |
| void | clear () |
| Clears the queue, i.e., deletes all elements from it. | |
| std::vector< Edge > | getEdges () const |
| Copies all edges into a vector and returns the vector. | |
| void | rebuild () |
| Rebuilds the queue. | |
| unsigned int | getMinEffortToCome () const |
| Returns the minimum effort that remains. | |
| std::size_t | estimateEffort (const Edge &edge) const |
| Estimates the effort that remains to validate a solution through an edge. | |
Detailed Description
Definition at line 78 of file ForwardQueue.h.
Constructor & Destructor Documentation
◆ ForwardQueue()
| ompl::geometric::eitstar::ForwardQueue::ForwardQueue | ( | const std::shared_ptr< const ompl::base::OptimizationObjective > & | objective, |
| const std::shared_ptr< const ompl::base::StateSpace > & | space ) |
Constructs the queue given the objective and state space.
Definition at line 51 of file ForwardQueue.cpp.
Member Function Documentation
◆ clear()
| void ompl::geometric::eitstar::ForwardQueue::clear | ( | ) |
Clears the queue, i.e., deletes all elements from it.
Definition at line 289 of file ForwardQueue.cpp.
◆ containsOpenTargets()
| bool ompl::geometric::eitstar::ForwardQueue::containsOpenTargets | ( | std::size_t | reverseSearchTag | ) | const |
Returns whether the queue contains edges with targets that are open or unconnected in the reverse search tree.
Definition at line 279 of file ForwardQueue.cpp.
◆ empty()
| bool ompl::geometric::eitstar::ForwardQueue::empty | ( | ) | const |
Returns whether the queue is empty.
Definition at line 58 of file ForwardQueue.cpp.
◆ estimateEffort()
| std::size_t ompl::geometric::eitstar::ForwardQueue::estimateEffort | ( | const Edge & | edge | ) | const |
Estimates the effort that remains to validate a solution through an edge.
Definition at line 396 of file ForwardQueue.cpp.
◆ getEdges()
| std::vector< Edge > ompl::geometric::eitstar::ForwardQueue::getEdges | ( | ) | const |
Copies all edges into a vector and returns the vector.
Definition at line 300 of file ForwardQueue.cpp.
◆ getLowerBoundOnOptimalSolutionCost()
| ompl::base::Cost ompl::geometric::eitstar::ForwardQueue::getLowerBoundOnOptimalSolutionCost | ( | ) | const |
Returns a lower bound on the resolution-optimal solution cost.
Definition at line 273 of file ForwardQueue.cpp.
◆ getMinEffortToCome()
| unsigned int ompl::geometric::eitstar::ForwardQueue::getMinEffortToCome | ( | ) | const |
Returns the minimum effort that remains.
Definition at line 228 of file ForwardQueue.cpp.
◆ insertOrUpdate() [1/2]
| void ompl::geometric::eitstar::ForwardQueue::insertOrUpdate | ( | const Edge & | edge | ) |
Inserts or updates an edge in the queue.
Definition at line 68 of file ForwardQueue.cpp.
◆ insertOrUpdate() [2/2]
| void ompl::geometric::eitstar::ForwardQueue::insertOrUpdate | ( | const std::vector< Edge > & | edges | ) |
Inserts or updates multiple edges into the queue.
Definition at line 89 of file ForwardQueue.cpp.
◆ peek()
| Edge ompl::geometric::eitstar::ForwardQueue::peek | ( | double | suboptimalityFactor | ) |
Returns a copy to the next edge.
Definition at line 182 of file ForwardQueue.cpp.
◆ pop()
| Edge ompl::geometric::eitstar::ForwardQueue::pop | ( | double | suboptimalityFactor | ) |
Returns and deletes the top element of the queue.
Definition at line 215 of file ForwardQueue.cpp.
◆ rebuild()
| void ompl::geometric::eitstar::ForwardQueue::rebuild | ( | ) |
Rebuilds the queue.
Definition at line 312 of file ForwardQueue.cpp.
◆ remove()
| void ompl::geometric::eitstar::ForwardQueue::remove | ( | const Edge & | edge | ) |
Removes an edge from the queue. Throws if the edge is not in the queue.
Definition at line 100 of file ForwardQueue.cpp.
◆ size()
| std::size_t ompl::geometric::eitstar::ForwardQueue::size | ( | ) | const |
Returns how many elements are in the queue.
Definition at line 63 of file ForwardQueue.cpp.
◆ updateIfExists()
| void ompl::geometric::eitstar::ForwardQueue::updateIfExists | ( | const Edge & | edge | ) |
Update an edge in the queue. Does nothing if the edge is not in the queue.
Definition at line 200 of file ForwardQueue.cpp.
The documentation for this class was generated from the following files:
- ompl/geometric/planners/informedtrees/eitstar/ForwardQueue.h
- ompl/geometric/planners/informedtrees/eitstar/src/ForwardQueue.cpp