Member functions¶
This page contains the documentation for the Konieczny::DClass
class.

inline bool libsemigroups::Konieczny::DClass::contains(const_reference x)¶
Test membership of an element.
Given an element
x
which may or may not belong toparent
, this function returns whetherx
is an element of the \(\mathscr{D}\)class represented bythis
. This function triggers the computation of most of the frame forthis
, if it is not already known. Parameters
x – the element
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns
A value of type
bool
.

inline bool libsemigroups::Konieczny::DClass::is_regular_D_class() const noexcept¶
Test regularity of a \(\mathscr{D}\)class.
 Parameters
(None)
 Throws
(None) – This function is
noexcept
and is guaranteed never to throw. Returns
A value of type
size_t
.

inline size_t libsemigroups::Konieczny::DClass::number_of_L_classes() const¶
Returns the number of \(\mathscr{L}\)classes.
This function triggers the computation of most of the frame for
this
, if it is not already known. Parameters
(None)
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns
A value of type
size_t
.

inline size_t libsemigroups::Konieczny::DClass::number_of_R_classes() const¶
Returns the number of \(\mathscr{R}\)classes.
This function triggers the computation of most of the frame for
this
, if it is not already known. Parameters
(None)
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns
A value of type
size_t
.

inline virtual size_t libsemigroups::Konieczny::DClass::number_of_idempotents() const¶
Returns the number of idempotents.
This function triggers the computation of most of the frame for
this
, if it is not already known.

inline const_reference libsemigroups::Konieczny::DClass::rep() const¶
Returns a representative of the \(\mathscr{D}\)class.
The frame used to represent \(\mathscr{D}\)classes depends on the choice of representative. This function returns the representative used by a DClass instance. This may not be the same representative as used to construct the instance, but is guaranteed to not change.
 Parameters
(None)
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns

inline size_t libsemigroups::Konieczny::DClass::size() const¶
Returns the size of a \(\mathscr{D}\)class.
This function triggers the computation of most of the frame for
this
, if it is not already known. Parameters
(None)
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns
A value of type
size_t
.

inline size_t libsemigroups::Konieczny::DClass::size_H_class() const¶
Returns the size of the \(\mathscr{H}\)classes.
This function triggers the computation of most of the frame for
this
, if it is not already known. Parameters
(None)
 Throws
(None) – This function guarantees not to throw a
LibsemigroupsException
. Returns
A value of type
size_t
.