Class index to word

This page contains documentation for the member functions of ToddCoxeter that can be used to convert the index of a congruence class to a representative word belonging to that class.

See also

Word to class index for the inverses of the functions described on this page.

This page contains documentation for the member functions of ToddCoxeter that can be used to convert the index of a congruence class to a representative word belonging to that congruence class.

See also

Word to class index for the inverses of the functions described on this page.

Functions
template<typename OutputIterator>
OutputIterator	current_word_of (OutputIterator d_first, index_type i) const
	Insert a current word representing a class with given index into an output iterator.
template<typename OutputIterator>
OutputIterator	current_word_of (OutputIterator d_first, index_type i) const
	Insert a current word representing a class with given index into an output iterator.
template<typename OutputIterator>
OutputIterator	current_word_of_no_checks (OutputIterator d_first, index_type i) const
	Insert a current word representing a class with given index into an output iterator.
template<typename OutputIterator>
OutputIterator	current_word_of_no_checks (OutputIterator d_first, index_type i) const
	Insert a current word representing a class with given index into an output iterator.
template<typename Iterator>
Iterator	word_of (Iterator d_first, index_type i)
	Insert the word representing a class with given index into an output iterator.
template<typename Iterator>
Iterator	word_of (Iterator d_first, index_type i)
	Insert the word representing a class with given index into an output iterator.
template<typename Iterator>
Iterator	word_of_no_checks (Iterator d_first, index_type i)
	Insert the word representing a class with given index into an output iterator.
template<typename Iterator>
Iterator	word_of_no_checks (Iterator d_first, index_type i)
	Insert the word representing a class with given index into an output iterator.

Function Documentation

current_word_of() [1/2]

template<typename OutputIterator>

OutputIterator current_word_of	(	OutputIterator	d_first,
		index_type	i ) const

This function appends a current word representing the class with index i to the output iterator d_first. No enumeration is triggered by calls to this function, but current_word_graph is standardized (using Order::shortlex) if it is not already standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Exceptions

LibsemigroupsException

if i is out of bounds.

current_word_of() [2/2]

template<typename Word>

template<typename OutputIterator>

OutputIterator current_word_of ( OutputIterator d_first, index_type i ) const

inline

This function appends a current word representing the class with index i to the output iterator d_first. No enumeration is triggered by calls to this function, but current_word_graph is standardized (using Order::shortlex) if it is not already standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Exceptions

LibsemigroupsException

if i is out of bounds.

current_word_of_no_checks() [1/2]

template<typename OutputIterator>

OutputIterator current_word_of_no_checks	(	OutputIterator	d_first,
		index_type	i ) const

This function appends a current word representing the class with index i to the output iterator d_first. No enumeration is triggered by calls to this function, but current_word_graph is standardized (using Order::shortlex) if it is not already standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Warning

This function does not check its arguments. In particular, it is assumed that i is a valid index of a current class.

current_word_of_no_checks() [2/2]

template<typename Word>

template<typename OutputIterator>

OutputIterator current_word_of_no_checks ( OutputIterator d_first, index_type i ) const

inline

This function appends a current word representing the class with index i to the output iterator d_first. No enumeration is triggered by calls to this function, but current_word_graph is standardized (using Order::shortlex) if it is not already standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Warning

This function does not check its arguments. In particular, it is assumed that i is a valid index of a current class.

word_of() [1/2]

template<typename Iterator>

Iterator word_of ( Iterator d_first, index_type i )

inline

This function appends the word representing the class with index i to the output iterator d_first. A full enumeration is triggered by calls to this function, and current_word_graph is standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Warning

This function does not check its arguments. In particular, it is assumed that i is a valid index of a current class.

word_of() [2/2]

template<typename Word>

template<typename Iterator>

Iterator word_of ( Iterator d_first, index_type i )

inline

This function appends the word representing the class with index i to the output iterator d_first. A full enumeration is triggered by calls to this function, and current_word_graph is standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Warning

This function does not check its arguments. In particular, it is assumed that i is a valid index of a current class.

word_of_no_checks() [1/2]

template<typename Iterator>

Iterator word_of_no_checks ( Iterator d_first, index_type i )

inline

This function appends the word representing the class with index i to the output iterator d_first. A full enumeration is triggered by calls to this function, and current_word_graph is standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Exceptions

LibsemigroupsException

if i is out of bounds.

word_of_no_checks() [2/2]

template<typename Word>

template<typename Iterator>

Iterator word_of_no_checks ( Iterator d_first, index_type i )

inline

This function appends the word representing the class with index i to the output iterator d_first. A full enumeration is triggered by calls to this function, and current_word_graph is standardized.

The word appended to d_first is obtained by following a path in current_spanning_tree from the node corresponding to index i back to the root of that tree.

Template Parameters

OutputIterator

the type of the first argument.

Parameters

d_first	output iterator pointing at the first letter of the destination.
i	the index of the class.

Returns

An output iterator pointing one beyond the last letter of the output word.

Exceptions

LibsemigroupsException

if i is out of bounds.