An N-best lattice path iterator. More...

#include <n_best_iterator.hpp>

Inheritance diagram for tetengo::lattice::n_best_iterator:

Collaboration diagram for tetengo::lattice::n_best_iterator:

Public Member Functions
	n_best_iterator ()
	Creates an iterator.

	n_best_iterator (const lattice &lattice_, node eos_node, std::unique_ptr< constraint > &&p_constraint)
	Creates an iterator.

const path &	operator* () const
	Dereferences the iterator.

path &	operator* ()
	Dereferences the iterator.

const path *	operator-> () const
	Returns the pointer to the value.

path *	operator-> ()
	Returns the pointer to the value.

n_best_iterator &	operator++ ()
	Increments the iterator.

n_best_iterator	operator++ (int)
	Postincrements the iterator.

Friends
bool	operator== (const n_best_iterator &one, const n_best_iterator &another)
	Returns true when one iterator is equal to another.

Detailed Description

An N-best lattice path iterator.

Constructor & Destructor Documentation

◆ n_best_iterator() [1/2]

tetengo::lattice::n_best_iterator::n_best_iterator ( )

Creates an iterator.

It points to the last of the paths.

◆ n_best_iterator() [2/2]

tetengo::lattice::n_best_iterator::n_best_iterator	(	const lattice &	lattice_,
		node	eos_node,
		std::unique_ptr< constraint > &&	p_constraint
	)

Creates an iterator.

Parameters

lattice_	A lattice.
eos_node	An EOS node.
p_constraint	A unique pointer to a constraint.

Exceptions

std::invalid_argument When p_constraint is nullptr.

Member Function Documentation

◆ operator*() [1/2]

path & tetengo::lattice::n_best_iterator::operator* ( )

Dereferences the iterator.

Returns: The dereferenced value.

◆ operator*() [2/2]

const path & tetengo::lattice::n_best_iterator::operator* ( ) const

Dereferences the iterator.

Returns: The dereferenced value.

◆ operator++() [1/2]

n_best_iterator & tetengo::lattice::n_best_iterator::operator++ ( )

Increments the iterator.

Returns: This iterator.

◆ operator++() [2/2]

n_best_iterator tetengo::lattice::n_best_iterator::operator++ ( int )

Postincrements the iterator.

Returns: The iterator before the incrementation.

◆ operator->() [1/2]

path * tetengo::lattice::n_best_iterator::operator-> ( )

Returns the pointer to the value.

Returns: The pointer to the value.

◆ operator->() [2/2]

const path * tetengo::lattice::n_best_iterator::operator-> ( ) const

Returns the pointer to the value.

Returns: The pointer to the value.

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const n_best_iterator &	one,
		const n_best_iterator &	another
	)

friend

Returns true when one iterator is equal to another.