A State of a ProductGraph represents a vertex in the graph-based Cartesian product represented by the ProductGraph. A State is simply a tuple consisting of a PropositionalDecomposition region, a co-safe Automaton state, and a safe Automaton state. More...
#include <ompl/control/planners/ltl/ProductGraph.h>
Public Member Functions | |
State ()=default | |
Creates a State without any assigned PropositionalDecomposition region or Automaton states. All of these values are initialized to -1. | |
State (const State &s)=default | |
Basic copy constructor for State. | |
bool | operator== (const State &s) const |
Returns whether this State is equivalent to a given State, by comparing their PropositionalDecomposition regions and Automaton states. | |
bool | isValid () const |
Returns whether this State is valid. A State is valid if and only if none of its Automaton states are dead states (a dead state has value -1). | |
int | getDecompRegion () const |
Returns this State's PropositionalDecomposition region component. | |
int | getCosafeState () const |
Returns this State's co-safe Automaton state component. | |
int | getSafeState () const |
Returns this State's safe Automaton state component. |
Friends | |
class | ProductGraph |
struct | HashState |
std::ostream & | operator<< (std::ostream &out, const State &s) |
Helper function to print this State to a given output stream. |
Detailed Description
A State of a ProductGraph represents a vertex in the graph-based Cartesian product represented by the ProductGraph. A State is simply a tuple consisting of a PropositionalDecomposition region, a co-safe Automaton state, and a safe Automaton state.
Definition at line 83 of file ProductGraph.h.
Member Function Documentation
◆ getCosafeState()
int ompl::control::ProductGraph::State::getCosafeState | ( | ) | const |
Returns this State's co-safe Automaton state component.
Definition at line 94 of file ProductGraph.cpp.
◆ getDecompRegion()
int ompl::control::ProductGraph::State::getDecompRegion | ( | ) | const |
Returns this State's PropositionalDecomposition region component.
Definition at line 89 of file ProductGraph.cpp.
◆ getSafeState()
int ompl::control::ProductGraph::State::getSafeState | ( | ) | const |
Returns this State's safe Automaton state component.
Definition at line 99 of file ProductGraph.cpp.
◆ isValid()
bool ompl::control::ProductGraph::State::isValid | ( | ) | const |
Returns whether this State is valid. A State is valid if and only if none of its Automaton states are dead states (a dead state has value -1).
Definition at line 63 of file ProductGraph.cpp.
◆ operator==()
bool ompl::control::ProductGraph::State::operator== | ( | const State & | s | ) | const |
Returns whether this State is equivalent to a given State, by comparing their PropositionalDecomposition regions and Automaton states.
Definition at line 58 of file ProductGraph.cpp.
Friends And Related Symbol Documentation
◆ HashState
|
friend |
Definition at line 105 of file ProductGraph.h.
◆ operator<<
|
friend |
Helper function to print this State to a given output stream.
Definition at line 80 of file ProductGraph.cpp.
◆ ProductGraph
|
friend |
Definition at line 85 of file ProductGraph.h.
The documentation for this class was generated from the following files:
- ompl/control/planners/ltl/ProductGraph.h
- ompl/control/planners/ltl/src/ProductGraph.cpp