Low-index congruences

This file contains documentation for the functionality in libsemigroups related to the version of low-index congruence algorithms described in [5]

Namespaces
namespace	libsemigroups::sims
	Helper functions for low-index congruences.

Classes
class	MinimalRepOrc
	For computing the minimal degree of a transformation representation arising from a right congruences of a finite semigroup or monoid. More...
class	RepOrc
	For computing small degree transformation representations of a finite semigroup or monoid. More...
class	Sims1
	For computing finite index right congruences of a finitely presented semigroup or monoid. More...
class	Sims2
	For computing finite index two-sided congruences of a finitely presented semigroup or monoid. More...
class	SimsRefinerFaithful
	For pruning the search tree when looking for congruences arising from right or two-sided congruences representing faithful actions. More...
class	SimsRefinerIdeals
	For pruning the search tree when looking for congruences arising from right or two-sided ideals. More...
class	SimsSettings< Subclass >
	For setting the presentation and various runtime parameters of the Sims low index algorithm. More...
class	SimsStats
	For keeping track of various statistics arising during the runtime of the low index algorithm. More...

Functions
std::string	to_human_readable_repr (MinimalRepOrc const &x)
	Return a human readable representation of a MinimalRepOrc object.
std::string	to_human_readable_repr (RepOrc const &x)
	Return a human readable representation of a RepOrc object.
std::string	to_human_readable_repr (Sims1 const &x)
	Return a human readable representation of a Sims1 object.
std::string	to_human_readable_repr (Sims2 const &x)
	Return a human readable representation of a Sims2 object.
std::string	to_human_readable_repr (SimsRefinerFaithful const &x)
	Return a human readable representation of a SimsRefinerFaithful object.
std::string	to_human_readable_repr (SimsRefinerIdeals const &x)
	Return a human readable representation of a SimsRefinerIdeals object.
std::string	to_human_readable_repr (SimsStats const &x)
	Return a human readable representation of a SimsStats object.

Function Documentation

to_human_readable_repr() [1/7]

std::string to_human_readable_repr ( MinimalRepOrc const & x )

nodiscard

Return a human readable representation of a MinimalRepOrc object.

Parameters

x	the MinimalRepOrc object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [2/7]

std::string to_human_readable_repr ( RepOrc const & x )

nodiscard

Return a human readable representation of a RepOrc object.

Parameters

x	the RepOrc object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [3/7]

std::string to_human_readable_repr ( Sims1 const & x )

nodiscard

Return a human readable representation of a Sims1 object.

Parameters

x	the Sims1 object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [4/7]

std::string to_human_readable_repr ( Sims2 const & x )

nodiscard

Return a human readable representation of a Sims2 object.

Parameters

x	the Sims2 object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [5/7]

std::string to_human_readable_repr ( SimsRefinerFaithful const & x )

nodiscard

Return a human readable representation of a SimsRefinerFaithful object.

Parameters

x	the SimsRefinerIdeals object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [6/7]

std::string to_human_readable_repr ( SimsRefinerIdeals const & x )

nodiscard

Return a human readable representation of a SimsRefinerIdeals object.

Parameters

x	the SimsRefinerIdeals object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.

to_human_readable_repr() [7/7]

std::string to_human_readable_repr ( SimsStats const & x )

nodiscard

Return a human readable representation of a SimsStats object.

Parameters

x	the SimsStats object.

Exceptions

This function guarantees not to throw a LibsemigroupsException.