Public Member Functions | |
| ReverseQueue (const std::shared_ptr< const ompl::base::OptimizationObjective > &objective, const std::shared_ptr< const ompl::base::StateSpace > &space, const bool isQueueCostOrdered) | |
| Constructs the queue with the given optimization objective and state space. | |
| ~ReverseQueue ()=default | |
| Destructs this queue. | |
| bool | empty () const |
| Returns whether the queue is empty. | |
| std::size_t | size () const |
| Returns the number of elements in the queue. | |
| void | insertOrUpdate (const Edge &edge) |
| Inserts or updates an element in the queue. | |
| void | insertOrUpdate (const std::vector< Edge > &edges) |
| Inserts or updates multiple elements in the queue. | |
| const Edge & | peek () const |
| Get a reference to the top edge in the queue. | |
| unsigned int | peekEffort () const |
| Get the effort corresponding to the top edge of the queue. | |
| Edge | pop () |
| Returns and deletes the top element of the queue. | |
| void | setCostQueueOrder (const bool isQueueCostOrdered) |
| Updates the queue ordering depending on the given suboptimality factor. | |
| ompl::base::Cost | getLowerBoundOnOptimalSolutionCost () const |
| Returns a lower bound on the resolution-optimal solution cost. | |
| 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. | |
| void | removeOutgoingEdges (const std::shared_ptr< Vertex > &vertex) |
| Removes the outgoing edges of a vertex from the queue. | |
| unsigned int | computeAdmissibleSolutionEffort (const Edge &edge) const |
| Returns the admissible total potential effort of an edge. | |
| ompl::base::Cost | computeAdmissibleSolutionCost (const Edge &edge) const |
| Returns the admissible total potential solution cost of an edge. | |
Detailed Description
Definition at line 59 of file ReverseQueue.h.
Constructor & Destructor Documentation
◆ ReverseQueue()
| ompl::geometric::eitstar::ReverseQueue::ReverseQueue | ( | const std::shared_ptr< const ompl::base::OptimizationObjective > & | objective, |
| const std::shared_ptr< const ompl::base::StateSpace > & | space, | ||
| const bool | isQueueCostOrdered ) |
Constructs the queue with the given optimization objective and state space.
Definition at line 49 of file ReverseQueue.cpp.
Member Function Documentation
◆ clear()
| void ompl::geometric::eitstar::ReverseQueue::clear | ( | ) |
Clears the queue, i.e., deletes all elements from it.
Definition at line 337 of file ReverseQueue.cpp.
◆ computeAdmissibleSolutionCost()
| ompl::base::Cost ompl::geometric::eitstar::ReverseQueue::computeAdmissibleSolutionCost | ( | const Edge & | edge | ) | const |
Returns the admissible total potential solution cost of an edge.
Definition at line 165 of file ReverseQueue.cpp.
◆ computeAdmissibleSolutionEffort()
| unsigned int ompl::geometric::eitstar::ReverseQueue::computeAdmissibleSolutionEffort | ( | const Edge & | edge | ) | const |
Returns the admissible total potential effort of an edge.
Definition at line 180 of file ReverseQueue.cpp.
◆ empty()
| bool ompl::geometric::eitstar::ReverseQueue::empty | ( | ) | const |
Returns whether the queue is empty.
Definition at line 59 of file ReverseQueue.cpp.
◆ getEdges()
| std::vector< Edge > ompl::geometric::eitstar::ReverseQueue::getEdges | ( | ) | const |
Copies all edges into a vector and returns the vector.
Definition at line 349 of file ReverseQueue.cpp.
◆ getLowerBoundOnOptimalSolutionCost()
| ompl::base::Cost ompl::geometric::eitstar::ReverseQueue::getLowerBoundOnOptimalSolutionCost | ( | ) | const |
Returns a lower bound on the resolution-optimal solution cost.
Definition at line 332 of file ReverseQueue.cpp.
◆ insertOrUpdate() [1/2]
| void ompl::geometric::eitstar::ReverseQueue::insertOrUpdate | ( | const Edge & | edge | ) |
Inserts or updates an element in the queue.
Definition at line 69 of file ReverseQueue.cpp.
◆ insertOrUpdate() [2/2]
| void ompl::geometric::eitstar::ReverseQueue::insertOrUpdate | ( | const std::vector< Edge > & | edges | ) |
Inserts or updates multiple elements in the queue.
Definition at line 90 of file ReverseQueue.cpp.
◆ peek()
| const Edge & ompl::geometric::eitstar::ReverseQueue::peek | ( | ) | const |
Get a reference to the top edge in the queue.
Definition at line 117 of file ReverseQueue.cpp.
◆ peekEffort()
| unsigned int ompl::geometric::eitstar::ReverseQueue::peekEffort | ( | ) | const |
Get the effort corresponding to the top edge of the queue.
Definition at line 129 of file ReverseQueue.cpp.
◆ pop()
| Edge ompl::geometric::eitstar::ReverseQueue::pop | ( | ) |
Returns and deletes the top element of the queue.
Definition at line 299 of file ReverseQueue.cpp.
◆ rebuild()
| void ompl::geometric::eitstar::ReverseQueue::rebuild | ( | ) |
Rebuilds the queue.
Definition at line 362 of file ReverseQueue.cpp.
◆ removeOutgoingEdges()
| void ompl::geometric::eitstar::ReverseQueue::removeOutgoingEdges | ( | const std::shared_ptr< Vertex > & | vertex | ) |
Removes the outgoing edges of a vertex from the queue.
Definition at line 369 of file ReverseQueue.cpp.
◆ setCostQueueOrder()
| void ompl::geometric::eitstar::ReverseQueue::setCostQueueOrder | ( | const bool | isQueueCostOrdered | ) |
Updates the queue ordering depending on the given suboptimality factor.
Definition at line 99 of file ReverseQueue.cpp.
◆ size()
| std::size_t ompl::geometric::eitstar::ReverseQueue::size | ( | ) | const |
Returns the number of elements in the queue.
Definition at line 64 of file ReverseQueue.cpp.
The documentation for this class was generated from the following files:
- ompl/geometric/planners/informedtrees/eitstar/ReverseQueue.h
- ompl/geometric/planners/informedtrees/eitstar/src/ReverseQueue.cpp