Konieczny< Element, Traits >::DClass

template<typename Element, typename Traits = KoniecznyTraits<Element>>
class libsemigroups::Konieczny< Element, Traits >::DClass

The nested abstract class Konieczny::DClass represents a \(\mathscr{D}\)-class via a frame as described in [40].

As an abstract class, DClass cannot be directly constructed; instead you should obtain a \(\mathscr{D}\)-class by calling Konieczny::D_class_of_element, or through a function like Konieczny::cbegin_current_D_classes.

See also

Konieczny.

Public Member Functions
bool	contains (const_reference x)
	Test membership of an element within a \(\mathscr{D}\)-class.
bool	is_regular_D_class () const noexcept
	Test regularity of a \(\mathscr{D}\)-class.
virtual size_t	number_of_idempotents () const
	Get the number of idempotents of a \(\mathscr{D}\)-class.
size_t	number_of_L_classes () const
	Get the number of \(\mathscr{L}\)-classes within a DClass.
size_t	number_of_R_classes () const
	Get the number of \(\mathscr{R}\)-classes within a DClass.
const_reference	rep () const
	Get the representative of the \(\mathscr{D}\)-class.
size_t	size () const
	Get the size of a \(\mathscr{D}\)-class.
size_t	size_H_class () const
	Get the size of the \(\mathscr{H}\)-classes within a DClass.

Member Function Documentation

contains()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

bool contains

(

const_reference

x

)

Given an element x which may or may not belong to parent, this function returns whether x is an element of the \(\mathscr{D}\)-class represented by this. This function triggers the computation of most of the frame for this, if it is not already known.

Parameters

x	the element.

Returns

A value of type bool.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

is_regular_D_class()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

bool is_regular_D_class ( ) const

inlinenoexcept

Returns

A value of type size_t.

Exceptions

This function is noexcept and is guaranteed never to throw.

number_of_idempotents()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

virtual size_t number_of_idempotents ( ) const

inlinevirtual

This function triggers the computation of most of the frame for this, if it is not already known.

number_of_L_classes()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

size_t number_of_L_classes ( ) const

inline

This function triggers the computation of most of the frame for this, if it is not already known.

Returns

A value of type size_t.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

number_of_R_classes()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

size_t number_of_R_classes ( ) const

inline

This function triggers the computation of most of the frame for this, if it is not already known.

Returns

A value of type size_t.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

rep()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

const_reference rep ( ) const

inline

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.

Returns

A const_reference.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

size()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

size_t size ( ) const

inline

This function triggers the computation of most of the frame for this, if it is not already known.

Returns

A value of type size_t.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

size_H_class()

template<typename Element, typename Traits = KoniecznyTraits<Element>>

size_t size_H_class ( ) const

inline

This function triggers the computation of most of the frame for this, if it is not already known.

Returns

A value of type size_t.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

---

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

• /Users/jdm/libsemigroups/include/libsemigroups/konieczny.hpp