Member functions inherited from CosetManager¶

This page contains a description of the member functions of the ToddCoxeter class inherited from CosetManager.

inline size_t libsemigroups::congruence::ToddCoxeter::coset_capacity() const noexcept¶

Returns the capacity of the coset table.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type size_t.

inline coset_type libsemigroups::congruence::ToddCoxeter::first_free_coset() const noexcept¶

Returns the first free coset.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type CosetManager::coset_type

inline float libsemigroups::congruence::ToddCoxeter::growth_factor() const noexcept¶

The current value of the growth factor setting.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type float.

CosetManager &libsemigroups::congruence::ToddCoxeter::growth_factor(float val)¶

Set the value of the growth factor setting.

This setting is used to determine the factor by which the number of cosets in the table is increased, when more cosets are required.

The default value of this setting is 2.0.

inline bool libsemigroups::congruence::ToddCoxeter::has_free_cosets() const noexcept¶

Check if there are any free cosets.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type bool.

inline bool libsemigroups::congruence::ToddCoxeter::is_active_coset(coset_type c) const¶

Check if the given coset is active or not.

Parameters: c – the coset to check.
Throws: (None) – This function guarantees not to throw a LibsemigroupsException.
Returns: A value of type bool.

inline bool libsemigroups::congruence::ToddCoxeter::is_valid_coset(coset_type c) const noexcept¶

Check if the given coset is valid.

Parameters: c – the coset to check.
Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type bool.

inline coset_type libsemigroups::congruence::ToddCoxeter::next_active_coset(coset_type c) const¶

Returns the next active coset after the given coset.

Parameters: c – the coset.
Throws: (None) – This function guarantees not to throw a LibsemigroupsException.
Returns: A value of type CosetManager::coset_type

inline size_t libsemigroups::congruence::ToddCoxeter::number_of_cosets_active() const noexcept¶

Returns the number of active cosets.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type size_t.

inline size_t libsemigroups::congruence::ToddCoxeter::number_of_cosets_defined() const noexcept¶

Returns the total number of cosets defined so far.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type size_t.

inline size_t libsemigroups::congruence::ToddCoxeter::number_of_cosets_killed() const noexcept¶

Returns the total number of cosets that have been killed so far.

Throws: (None) – This function is noexcept and is guaranteed never to throw.
Returns: A value of type size_t.