Ukkonen::State

The return type of traverse indicating the position reached by following a path in the tree.

Public Member Functions
	State ()=default
	Default constructor.
	State (node_index_type vv, edge_index_type ppos)
	Construct from index and position.
	State (State &&)=default
	Default move constructor.
	State (State const &)=default
	Default copy constructor.
State &	operator= (State &&)=default
	Default move assignment.
State &	operator= (State const &)=default
	Default copy assignment.
bool	operator== (State const &that) const noexcept
	Compare states.

Constructor & Destructor Documentation

State() [1/4]

State ( )

default

Default constructor.

State() [2/4]

State ( State const & )

default

Default copy constructor.

State() [3/4]

State ( State && )

default

Default move constructor.

State() [4/4]

State ( node_index_type vv, edge_index_type ppos )

inline

Construct from index and position.

Parameters

vv	the index of the node reached.
ppos	the position in the edge leading to vv.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

Member Function Documentation

operator=() [1/2]

State & operator= ( State && )

default

Default move assignment.

operator=() [2/2]

State & operator= ( State const & )

default

Default copy assignment.

operator==()

bool operator== ( State const & that ) const

inlinenoexcept

Two states are equal if and only if their data members coincide.

Parameters

that	the state to compare.

Returns

true if that is equal to this, and false otherwise.

Exceptions

This function is noexcept and is guaranteed never to throw.

Complexity

Constant.

Member Data Documentation

pos

edge_index_type pos

The position in the edge leading to the node v reached.

v

node_index_type v

The index in Ukkonen::nodes of the node at the end of the position reached.

---

The documentation for this struct was generated from the following file:

• /Users/jdm/libsemigroups/include/libsemigroups/ukkonen.hpp