Transformations¶
Overview¶
Defined in element.hpp
.
This page contains the documentation for the class template
libsemigroups::Transformation
.
Full API¶
-
template<typename TValueType>
class libsemigroups::Transformation : public libsemigroups::detail::TransfBase<TValueType, Transformation<TValueType>>¶ Template class for transformations.
The value of the template parameter
T
can be used to reduce the amount of memory required by instances of this class; see PartialTransformation for more details.A transformation \(f\) is just a function defined on the whole of \(\{0, 1, \ldots, n - 1\}\) for some integer \(n\) called the degree of \(f\). A transformation is stored as a vector of the images of \(\{0, 1, \ldots, n - 1\}\), i.e. \(\{(0)f, (1)f, \ldots, (n - 1)f\}\).
Public Functions
-
inline explicit Transformation(std::vector<TValueType> const &vec)¶
A constructor.
Constructs a Transformation f of degree
vec.size()
fromvec
, where the image of a point i is given byvec
[i].
-
inline explicit Transformation(std::vector<TValueType> &&vec)¶
A constructor.
The parameter
vector
should be a rvalue reference to defining data of the transformation.Returns an transformation whose defining data is
vec
. This constructor moves the data fromvec
, meaning thatvec
is changed by this constructor.
-
inline Transformation(std::initializer_list<TValueType> imgs)¶
A constructor.
Constructs a Transformation f of degree
imgs.size()
fromimgs
, where the image of a point i is given byimgs
[i].
-
inline Transformation(Transformation<TValueType> const ©)¶
A copy constructor.
Constructs a Transformation which is mathematically equal to
copy
.
-
inline void validate() const¶
Validates the data defining
this
.This member function throws a libsemigroups::LibsemigroupsException if any value of
this
is out of bounds (i.e. greater than or equal tothis->degree()
).
-
inline virtual void increase_degree_by(size_t m) override¶
Increases the degree of
this
bydeg
.This does not make sense for all subclasses of Element.
-
inline virtual size_t complexity() const override¶
Returns the approximate time complexity of multiplying two partial transformations.
The approximate time complexity of multiplying partial transformations is just their degree.
-
inline virtual size_t degree() const final¶
Returns the degree of a partial transformation.
The degree of a partial transformation is the number of points used in its definition.
-
inline size_t crank() const¶
Returns the rank of a partial transformation.
The rank of a partial transformation is the number of its distinct image values, not including libsemigroups::UNDEFINED. This function recomputes the return value every time it is called.
-
inline TSubclass identity() const override¶
Returns the identity transformation with same degree as
this
.This member function returns a new partial transformation with degree equal to the degree of
this
that fixes every value from 0 to the degree ofthis
.
-
virtual bool operator==(Element const&) const = 0¶
Returns
true
ifthis
equalsthat
.This member function checks the mathematical equality of two Element objects in the same subclass of Element.
-
virtual bool operator<(Element const&) const = 0¶
Returns
true
ifthis
is less thanthat
.This member function defines a total order on the set of objects in a given subclass of Element with a given Element::degree. The definition of this total order depends on the member function for the operator < in the subclass.
-
inline bool operator>(Element const &that) const¶
Returns
true
ifthis
is greater thanthat
.This member function returns
true
ifthis
is greater thanthat
, under the ordering defined by the operator <.
-
inline bool operator!=(Element const &that) const¶
Returns
true
ifthis
is not equal tothat
.This member function returns
true
ifthis
is mathematically not equal tothat
.
-
inline bool operator<=(Element const &that) const¶
Returns
true
ifthis
is less than or equal tothat
.This member function returns
true
ifthis
is less than (under the order defined by the operator <) or mathematically equal tothat
.
-
inline bool operator>=(Element const &that) const¶
Returns
true
ifthis
is less than or equal tothat
.This member function returns
true
ifthis
is greater than (under the order defined by the operator <) or mathematically equal tothat
.
-
inline size_t hash_value() const¶
Return the hash value of an Element.
This member function returns a hash value for an object in a subclass of Element. This value is only computed the first time this member function is called.
-
virtual void swap(Element&) = 0¶
Swap another Element with
this
.This member function swaps the defining data of
x
andthis
.
-
inline virtual void redefine(Element const &x, Element const &y)¶
Multiplies
x
andy
and stores the result inthis
.Redefine
this
to be the product ofx
andy
. This is in-place multiplication to avoid allocation of memory for products which do not need to be stored for future use.The implementation of this member function in the Element base class simply calls the 3 parameter version with third parameter 0. Any subclass of Element can implement either a two or three parameter version of this member function and the base class member function implements the other member function.
-
inline void redefine(Element const *x, Element const *y)¶
Multiplies
x
andy
and stores the result inthis
.This version of the member function takes const pointers rather than const references, but otherwise behaves like the other Element::redefine.
-
inline virtual void redefine(Element const &x, Element const &y, size_t)¶
Multiplies
x
andy
and stores the result inthis
.Redefine
this
to be the product ofx
andy
. This is in-place multiplication to avoid allocation of memory for products which do not need to be stored for future use.The implementation of this member function in the Element base class simply calls the 2 parameter version and ignores the third parameter
thread_id
. Any subclass of Element can implement either a two or three parameter version of this member function and the base class member function implements the other member function.The parameter
thread_id
is required in some derived classes of Element because some temporary storage is required to find the product ofx
andy
.Note that if different threads call this member function on a derived class of Element where static temporary storage is used in the redefine member function with the same value of
thread_id
, then bad things may happen.
-
inline void redefine(Element const *x, Element const *y, size_t)¶
Multiplies
x
andy
and stores the result inthis
.This member function differs from the the previous only in taking pointers instead of references.
-
virtual Element *heap_copy() const = 0¶
Returns a new element completely independent of
this
.This member function really copies an Element. To minimise the amount of copying when Element objects are inserted in a std::unordered_map and other containers, an Element behaves somewhat like a pointer, in that the actual data in an Element is only copied when this member function is called. Otherwise, if an Element is copied, then its defining data is only stored once.
-
virtual Element *heap_identity() const = 0¶
Returns an independent copy of the identity.
This member function returns a copy of the identity element (in the appropriate semigroup) which is independent from previous copies.
Public Static Functions
-
static inline TSubclass identity(size_t n)¶
Returns the identity transformation with
n
.This member function returns a new partial transformation with degree equal to
n
and that fixes every value from 0 ton
.
-
inline explicit Transformation(std::vector<TValueType> const &vec)¶