.. Copyright (c) 2019-22, J. D. Mitchell

   Distributed under the terms of the GPL license version 3.

   The full license is in the file LICENSE, distributed with this software.

   This file was auto-generated by docs/generate_from_yml.py, do not edit.

DynamicPTransf
==============

.. doxygenclass:: libsemigroups::DynamicPTransf
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::DynamicPTransf


Member types
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`const_iterator`
     - Type of const iterators point to image values.


   * - :cpp:member:`container_type`
     - Type of the underlying container.


   * - :cpp:member:`iterator`
     - Type of iterators point to image values.


   * - :cpp:member:`value_type`
     - Type of the image values.



Constructors
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`DynamicPTransf(size_t)`
     - Construct with given degree.



Static member functions
-----------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`identity() const`
     - Returns the identity transformation on :cpp:member:`degree()`  points.


   * - :cpp:member:`identity(size_t)`
     - Returns the identity transformation on the given number of points.


   * - :cpp:member:`make(TContainerAgain &&)`
     - Construct from a container and validates.


   * - :cpp:member:`make(std::initializer_list< value_type > const &)`
     - Construct from an initializer list.



Modifiers and accessors
-----------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`at(size_t)`
     - Get a reference to the image of a point.


   * - :cpp:member:`at(size_t) const`
     - Get a const reference to the image of a point.


   * - :cpp:member:`increase_degree_by(size_t)`
     - Increase the degree in-place.


   * - :cpp:member:`operator[](size_t)`
     - Get a reference to the image of a point.


   * - :cpp:member:`operator[](size_t) const`
     - Get a const reference to the image of a point.


   * - :cpp:member:`swap(PTransfBase &) noexcept`
     -  :cpp:any:`Swap`  with another partial transformation.



Iterators
---------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`begin() const noexcept`
     - Returns a :cpp:member:`const_iterator`  (random access iterator) pointing at the first image value.


   * - :cpp:member:`begin() noexcept`
     - Returns an :cpp:member:`iterator`  (random access iterator) pointing at the first image value.


   * - :cpp:member:`cbegin() const noexcept`
     - Returns a :cpp:member:`const_iterator`  (random access iterator) pointing at the first image value.


   * - :cpp:member:`cend() const noexcept`
     - Returns a :cpp:member:`const_iterator`  (random access iterator) pointing one past the last image value.


   * - :cpp:member:`end() const noexcept`
     - Returns a :cpp:member:`const_iterator`  (random access iterator) pointing one past the last image value.


   * - :cpp:member:`end() noexcept`
     - Returns an :cpp:member:`iterator`  (random access iterator) pointing one past the last image value.



Operators
---------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`operator!=(PTransfBase const &) const`
     - Compare for inequality.


   * - :cpp:member:`operator*(TSubclass const &) const`
     - Multiply by another partial transformation.


   * - :cpp:member:`operator<(PTransfBase const &) const`
     - Compare for less.


   * - :cpp:member:`operator<=(PTransfBase const &) const`
     - Compare for less than or equal.


   * - :cpp:member:`operator==(PTransfBase const &) const`
     - Compare for equality.


   * - :cpp:member:`operator>(PTransfBase const &) const`
     - Compare for greater.


   * - :cpp:member:`operator>=(PTransfBase const &) const`
     - Compare for greater than or equal.



Other member functions
----------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`degree() const noexcept`
     - Returns the degree of a partial transformation.


   * - :cpp:member:`hash_value() const`
     - Returns a hash value.


   * - :cpp:member:`rank() const`
     - Returns the number of distinct image values.


   * - :cpp:member:`undef() noexcept`
     - Returns the value used to represent "undefined".



.. toctree::
   :hidden:

   libsemigroups__dynamicptransf__member_types.rst
   libsemigroups__dynamicptransf__constructors.rst
   libsemigroups__dynamicptransf__static_member_functions.rst
   libsemigroups__dynamicptransf__modifiers_and_accessors.rst
   libsemigroups__dynamicptransf__iterators.rst
   libsemigroups__dynamicptransf__operators.rst
   libsemigroups__dynamicptransf__other_member_functions.rst
