Attributes¶
This page contains information about non-const attributes of the SchreierSims
class.
-
inline point_type libsemigroups::SchreierSims::base(index_type index) const¶
Get a base point.
- Complexity
Constant.
- Parameters
index – the index of the base point.
- Throws
LibsemigroupsException – if
index
is out of range.- Returns
the base point with index
index
.
-
inline size_t libsemigroups::SchreierSims::base_size() const noexcept¶
Get the size of the current base.
- Exceptions
This function is
noexcept
and is guaranteed never to throw.- Complexity
Constant.
- Parameters
(None)
- Returns
A
size_t
.
-
inline bool libsemigroups::SchreierSims::empty()¶
Check if any generators have been added so far.
- Parameters
(None)
- Complexity
Constant.
- Exceptions
This function guarantees not to throw a LibsemigroupsException.
- Returns
true
ifnumber_of_generators() == 0
andfalse
otherwise.
-
inline bool libsemigroups::SchreierSims::finished() const¶
Check if the stabiliser chain is fully enumerated.
- Complexity
Constant.
- Parameters
(None)
- Exceptions
This function guarantees not to throw a LibsemigroupsException.
- Returns
true
if the stabiliser chain is fully enumerated andfalse
otherwise.
-
inline const_element_reference libsemigroups::SchreierSims::generator(index_type index) const¶
Get a generator.
- Complexity
Constant.
- Parameters
index – the index of the generator we want.
- Throws
LibsemigroupsException – if the
index
is out of bounds.- Returns
A const reference to the generator of
this
with indexindex
.
-
inline const_element_reference libsemigroups::SchreierSims::identity() const¶
Returns a const reference to the identity.
- Parameters
(None)
- Exceptions
This function guarantees not to throw a LibsemigroupsException.
- Returns
A
bool
.
-
inline size_t libsemigroups::SchreierSims::number_of_generators() const noexcept¶
The number of generators.
- Exceptions
This function is
noexcept
and is guaranteed never to throw.- Complexity
Constant.
- Parameters
(None)
- Returns
The number of generators, a value of
size_t
.
-
inline size_t libsemigroups::SchreierSims::number_of_strong_generators(index_type depth) const noexcept¶
The number of strong generators at a given depth.
- Exceptions
This function is
noexcept
and is guaranteed never to throw.- Complexity
Constant.
- Parameters
(None)
- Parameters
depth – the depth.
- Returns
The number of strong generators, a value of
size_t
, at depthdepth
of the stabiliser chain.
-
inline uint64_t libsemigroups::SchreierSims::size()¶
Returns the size of the group represented by this.
- Parameters
(None)
- Exceptions
This function guarantees not to throw a LibsemigroupsException.
- Returns
the size, a value of
uint64_t
.
-
inline const_element_reference libsemigroups::SchreierSims::strong_generator(index_type depth, index_type index) const¶
Get a strong generator.
- Complexity
Constant.
- Parameters
depth – the depth.
index – the index of the generator we want.
- Throws
LibsemigroupsException – if the
index
is out of bounds.- Returns
A const reference to the strong generator of
this
at depthdepth
and with indexindex
.