PathsFromToRootsCommon

So that doc is generated

Generate doc please doxygen.

Inheritance diagram for PathsFromToRootsCommon:

Public Member Functions
	PathsFromToRootsCommon ()=delete
	Deleted.
	PathsFromToRootsCommon (Forest const &f)
	Construct from a Forest.
	PathsFromToRootsCommon (PathsFromToRootsCommon &&)=default
	Default move constructor.
	PathsFromToRootsCommon (PathsFromToRootsCommon const &)=default
	Default copy constructor.
bool	at_end () const noexcept
	Check if the range is exhausted.
size_type	count () const noexcept
	Get the size of the range.
Forest const &	forest () const noexcept
	Returns the underlying Forest object.
output_type	get () const noexcept
	Returns a reference to the current path.
PathsFromToRootsCommon &	init (Forest const &f)
	Re-initialize from a Forest.
PathsFromToRootsCommon &	operator= (PathsFromToRootsCommon &&)=default
	Default move assignment operator.
PathsFromToRootsCommon &	operator= (PathsFromToRootsCommon const &)=default
	Default copy assignment operator.
size_type	size_hint () const noexcept
	Get the size of the range.
node_type	target () const noexcept
	Get the current target of the path.

Constructor & Destructor Documentation

PathsFromToRootsCommon() [1/2]

PathsFromToRootsCommon ( )

delete

A Forest object is required to construct or initialise a PathsFromToRootsCommon object.

PathsFromToRootsCommon() [2/2]

PathsFromToRootsCommon ( Forest const & f )

explicit

This function constructs a new PathsFromToRootsCommon for the Forest f. The newly constructed object does not copy f and is not valid if f is destroyed.

Parameters

f	the Forest.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

Member Function Documentation

at_end()

bool at_end ( ) const

inlinenodiscardnoexcept

This function returns true if there are no more paths in the range, and false otherwise.

Returns

Whether or not the range is exhausted.

count()

size_type count ( ) const

inlinenodiscardnoexcept

This function returns the number of paths in the range.

Returns

the number of paths in the range.

forest()

Forest const & forest ( ) const

inlinenodiscardnoexcept

This function returns the Forest object used to constructor or initialise a PathsFromToRootsCommon object.

Returns

A const reference to a Forest object.

Exceptions

This function is noexcept and is guaranteed never to throw.

get()

output_type get ( ) const

inlinenodiscardnoexcept

This function returns a const reference to the current path from the root of the tree containing target to target.

Returns

A const reference to the current path.

Exceptions

This function is noexcept and is guaranteed never to throw.

init()

PathsFromToRootsCommon & init

(

Forest const &

f

)

This function re-initializes a PathsFromToRootsCommon so that its underlying Forest object is f. This puts the PathsFromToRootsCommon object back into the same state it would have been in if it had been newly constructed from f.

Parameters

f	the Forest.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

size_hint()

size_type size_hint ( ) const

inlinenodiscardnoexcept

This function returns the number of paths in the range. The output is identical to that of count, and is included for compatibility with rx::ranges.

Returns

the number of paths in the range.

target()

node_type target ( ) const

inlinenodiscardnoexcept

This function returns the current target of the path returned by get.

Returns

The target of the current path.

Exceptions

This function is noexcept and is guaranteed never to throw.

---

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

• /Users/jdm3/libsemigroups/include/libsemigroups/forest.hpp