Static member functions¶

This page lists the static member functions of PBR.

PBR libsemigroups::PBR::identity() const¶

Returns the identity PBR with degree degree().

This member function returns a new PBR with degree equal to the degree of this where every value is adjacent to its negative. Equivalently, \(i\) is adjacent \(i + n\) and vice versa for every \(i\) less than the degree \(n\).

Parameters: (None)

Throws: (None) – This function guarantees not to throw a LibsemigroupsException.
Returns: A PBR.

static PBR libsemigroups::PBR::identity(size_t n)¶

Returns the identity PBR with specified degree.

This function returns a new PBR with degree equal to n where every value is adjacent to its negative. Equivalently, \(i\) is adjacent \(i + n\) and vice versa for every \(i\) less than the degree \(n\).

Parameters: n – the degree.
Throws: (None) – This function guarantees not to throw a LibsemigroupsException.
Returns: A PBR.

template<typename ...T> static inline PBR libsemigroups::PBR::make(T... args)¶

Construct and validate.

Template Parameters: T – the types of the arguments
Parameters: args – the arguments to forward to the constructor.
Throws: LibsemigroupsException – if libsemigroups::validate(PBR const&) throws when called with the constructed PBR.
Returns: A PBR constructed from args and validated.

static inline PBR libsemigroups::PBR::make(initializer_list_type<int32_t> left, initializer_list_type<int32_t> right)¶

Construct and validate.

Parameters

left – the 1st argument to forward to the constructor.
right – the 2nd argument to forward to the constructor.

Throws

LibsemigroupsException – if libsemigroups::validate(PBR const&) throws when called with the constructed PBR.

Returns

A PBR constructed from args and validated.

static inline PBR libsemigroups::PBR::make(initializer_list_type<uint32_t> args)¶

Construct and validate.

Parameters: args – the arguments to forward to the constructor.
Throws: LibsemigroupsException – if libsemigroups::validate(PBR const&) throws when called with the constructed PBR.
Returns: A PBR constructed from args and validated.