.. 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.

FroidurePin
===========

.. doxygenclass:: libsemigroups::FroidurePin
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::FroidurePin


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

   * - :cpp:member:`const_element_type`
     - Type of const elements.


   * - :cpp:member:`const_iterator`
     - Return type of :cpp:member:`cbegin`  and :cpp:member:`cend` .


   * - :cpp:member:`const_iterator_idempotents`
     - Return type of :cpp:member:`cbegin_idempotents`  and :cpp:member:`cend_idempotents` .


   * - :cpp:member:`const_iterator_sorted`
     - Return type of :cpp:member:`cbegin_sorted`  and :cpp:member:`cend_sorted` .


   * - :cpp:member:`const_pointer`
     - Type of element const pointers.


   * - :cpp:member:`const_reference`
     - Type of element const references.


   * - :cpp:member:`const_reverse_iterator`
     - Return type of :cpp:member:`crbegin`  and :cpp:member:`crend` .


   * - :cpp:member:`const_reverse_iterator_sorted`
     - Return type of :cpp:member:`crbegin_sorted`  and :cpp:member:`crend_sorted` .


   * - :cpp:member:`element_type`
     - Type of the elements.


   * - :cpp:member:`reference`
     - Type of element references.


   * - :cpp:member:`state_type`
     - Type of the state used for multiplication (if any).


   * - :cpp:member:`value_type`
     - Alias for element_type.



Adapter member types
--------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`Complexity`
     - Adapter for the complexity of multiplication.


   * - :cpp:member:`Degree`
     - Adapter for the degree of an element.


   * - :cpp:member:`EqualTo`
     - Adapter for testing equality.


   * - :cpp:member:`Hash`
     - Adapter for hashing.


   * - :cpp:member:`IncreaseDegree`
     - Adapter for increasing the degree of an element.


   * - :cpp:member:`Less`
     - Adapter for comparisons.


   * - :cpp:member:`One`
     - Adapter for the identity element of the given type.


   * - :cpp:member:`Product`
     - Adapter for the product of two elements.


   * - :cpp:member:`Swap`
     - Adapter for swapping.



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

   * - :cpp:member:`FroidurePin() <FroidurePin::FroidurePin()>`
     - Default constructor.


   * - :cpp:member:`FroidurePin(FroidurePin &&) = default`
     - Default move constructor.


   * - :cpp:member:`FroidurePin(FroidurePin const&)`
     - Copy constructor.


   * - :cpp:member:`FroidurePin(T const &) <template <typename T, typename = EnableIfIsState<T>>  FroidurePin(T const &)>`
     - Construct from const reference to state.


   * - :cpp:member:`FroidurePin(std::initializer_list<element_type>)`
     - Construct from generators.


   * - :cpp:member:`FroidurePin(std::shared_ptr\<T>) <template <typename T, typename = EnableIfIsState<T>>  FroidurePin(std::shared_ptr<T>)>`
     - Construct from `std::shared_ptr <https://en.cppreference.com/w/cpp/memory/shared_ptr>`_ to state.


   * - :cpp:member:`FroidurePin(std::vector<element_type> const&)`
     - Construct from generators.



Deleted constructors
--------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`operator=(FroidurePin &&) = delete`
     - Deleted.


   * - :cpp:member:`operator=(FroidurePin const &) = delete`
     - Deleted.



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

   * - :cpp:member:`add_generator(const_reference)`
     - Add a copy of an element to the generators.


   * - :cpp:member:`add_generators(T const&) <template <typename T> void add_generators(T const&)>`
     - Add collection of generators via const reference.


   * - :cpp:member:`add_generators(T const&, T const&) <template <typename T> void add_generators(T const&, T const&)>`
     - Add collection of generators via iterators.


   * - :cpp:member:`add_generators(std::initializer_list<const_element_type>)`
     - Add collection of generators via initializer list.


   * - :cpp:member:`closure(T const&) <template <typename T> void closure(T const&)>`
     - Add non-redundant generators in collection.


   * - :cpp:member:`closure(std::initializer_list<const_element_type>)`
     - Add non-redundant generators in collection.


   * - :cpp:member:`copy_add_generators(T const &) const <template <typename T> FroidurePin copy_add_generators(T const &) const>`
     - Copy and add a collection of generators.


   * - :cpp:member:`copy_add_generators(std::initializer_list< element_type >)`
     - Copy and add a collection of generators.


   * - :cpp:member:`copy_closure(T const &) <template <typename T> FroidurePin copy_closure(T const &)>`
     - Copy and add non-redundant generators.


   * - :cpp:member:`copy_closure(std::initializer_list< element_type >)`
     - Copy and add non-redundant generators.


   * - :cpp:member:`state() const`
     - Returns a `std::shared_ptr <https://en.cppreference.com/w/cpp/memory/shared_ptr>`_ to the state (if any).



Factorisation and relations
---------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`factorisation(const_reference)`
     - Factorise an element as a word in the generators.


   * - :cpp:member:`minimal_factorisation(const_reference)`
     - Factorise an element as a word in the generators.


   * - :cpp:member:`word_to_element(word_type const &) const`
     - Convert a word in the generators to an element.



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

   * - :cpp:member:`at(element_index_type)`
     - Access element specified by index with bound checks.


   * - :cpp:member:`contains(const_reference)`
     - Test membership of an element.


   * - :cpp:member:`current_position(const_reference) const`
     - Find the position of an element with no enumeration.


   * - :cpp:member:`generator(letter_type) const`
     - Returns the generator with specified index.


   * - :cpp:member:`operator[](element_index_type) const`
     - Access element specified by index.


   * - :cpp:member:`position(const_reference)`
     - Find the position of an element with enumeration if necessary.


   * - :cpp:member:`sorted_at(element_index_type)`
     - Access element specified by sorted index with bound checks.


   * - :cpp:member:`sorted_position(const_reference)`
     - Returns the sorted index of an element.



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

   * - :cpp:member:`begin() const`
     - Returns a const iterator pointing to the first element (ordered by discovery).


   * - :cpp:member:`cbegin() const`
     - Returns a const iterator pointing to the first element (ordered by discovery).


   * - :cpp:member:`cbegin_idempotents()`
     - Returns a const iterator pointing at the first idempotent.


   * - :cpp:member:`cbegin_sorted()`
     - Returns a const iterator pointing to the first element (sorted by :cpp:any:`Less`  ).


   * - :cpp:member:`cend() const`
     - Returns a const iterator pointing to one past the last known element.


   * - :cpp:member:`cend_idempotents()`
     - Returns a const iterator pointing one past the last idempotent.


   * - :cpp:member:`cend_sorted()`
     - Returns a const iterator pointing one past the last element (sorted by :cpp:any:`Less`  ).


   * - :cpp:member:`crbegin() const`
     - Returns a const reverse iterator pointing to the last known element.


   * - :cpp:member:`crbegin_sorted()`
     - Returns a const iterator pointing to the last element (sorted by :cpp:any:`Less`  ).


   * - :cpp:member:`crend() const`
     - Returns a const reverse iterator pointing one before the first element.


   * - :cpp:member:`crend_sorted()`
     - Returns a const reverse iterator pointing one before the first element (sorted by :cpp:any:`Less`  ).


   * - :cpp:member:`end() const`
     - Returns a const iterator pointing one past the last known element.



Virtual functions from FroidurePinBase
--------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`equal_to(word_type const &,word_type const &) const override`
     - Check equality of words in the generators.


   * - :cpp:member:`fast_product(element_index_type,element_index_type) const override`
     - Multiply elements via their indices.


   * - :cpp:member:`is_finite() const override`
     - Check finiteness.


   * - :cpp:member:`is_idempotent(element_index_type) override`
     - Check if an element is an idempotent via its index.


   * - :cpp:member:`number_of_generators() const noexcept override`
     - Returns the number of generators.


   * - :cpp:member:`number_of_idempotents() override`
     - Returns the number of idempotents.


   * - :cpp:member:`position_to_sorted_position(element_index_type) override`
     - Returns the sorted index of an element via its index.


   * - :cpp:member:`reserve(size_t) override`
     - Requests the given capacity for elements.



Member functions inherited from FroidurePinBase
-----------------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`batch_size() const noexcept`
     - Returns the current value of the batch size.


   * - :cpp:member:`batch_size(size_t) noexcept`
     - Set a new value for the batch size.


   * - :cpp:member:`cayley_graph_type`
     - Type for a left or right Cayley graph.


   * - :cpp:member:`cbegin_rules() const`
     - Returns a forward iterator pointing to the first rule (if any).


   * - :cpp:member:`cend_rules() const`
     - Returns a forward iterator pointing one past the last rule (if any).


   * - :cpp:member:`concurrency_threshold() const noexcept`
     - Returns the current value of the concurrency threshold.


   * - :cpp:member:`concurrency_threshold(size_t) noexcept`
     - Set the threshold for concurrency to be used by member functions.


   * - :cpp:member:`current_length(element_index_type) const`
     - Returns the length of the short-lex least word.


   * - :cpp:member:`current_max_word_length() const noexcept`
     - Returns the maximum length of a word in the generators so far computed.


   * - :cpp:member:`current_number_of_rules() const noexcept`
     - Returns the number of relations that have been found so far.


   * - :cpp:member:`current_position(letter_type) const`
     - Returns the position in of the generator with specified index.


   * - :cpp:member:`current_position(std::initializer_list< size_t > const &) const`
     - Returns the position corresponding to a word.


   * - :cpp:member:`current_position(word_type const &) const`
     - Returns the position corresponding to a word.


   * - :cpp:member:`current_size() const noexcept`
     - Returns the number of elements so far enumerated.


   * - :cpp:member:`degree() const noexcept`
     - Returns the degree of any and all elements.


   * - :cpp:member:`element_index_type`
     - Type for the index of an element.


   * - :cpp:member:`enumerate(size_t)`
     - Enumerate until at least a specified number of elements are found.


   * - :cpp:member:`factorisation(element_index_type)`
     - Returns a word representing an element given by index.


   * - :cpp:member:`factorisation(word_type&, element_index_type)`
     - Obtain a word representing an element given by index.


   * - :cpp:member:`final_letter(element_index_type) const`
     - Returns the last letter of the element with specified index.


   * - :cpp:member:`first_letter(element_index_type) const`
     - Returns the first letter of the element with specified index.


   * - :cpp:member:`immutable() const noexcept`
     - Returns the current immutability.


   * - :cpp:member:`immutable(bool) noexcept`
     - Set immutability.


   * - :cpp:member:`is_monoid()`
     - Check if the semigroup is a monoid.


   * - :cpp:member:`left(element_index_type,letter_type)`
     - Returns the index of the product of a generator and an element.


   * - :cpp:member:`left_cayley_graph()`
     - Returns a const reference to the left Cayley graph.


   * - :cpp:member:`length(element_index_type)`
     - Returns the length of the short-lex least word.


   * - :cpp:member:`max_threads() const noexcept`
     - Returns the current value of the maximum number of threads.


   * - :cpp:member:`max_threads(size_t) noexcept`
     - Set the maximum number of threads.


   * - :cpp:member:`minimal_factorisation(element_index_type)`
     - Returns a short-lex least word representing an element given by index.


   * - :cpp:member:`minimal_factorisation(word_type &,element_index_type)`
     - Obtain a short-lex least word representing an element given by index.


   * - :cpp:member:`minimal_factorisation(word_type &,element_index_type) const`
     - Obtain a short-lex least word representing an element given by index.


   * - :cpp:member:`number_of_rules()`
     - Returns the total number of relations in the presentation.


   * - :cpp:member:`prefix(element_index_type) const`
     - Returns the position of the longest proper prefix.


   * - :cpp:member:`product_by_reduction(element_index_type,element_index_type) const`
     - Compute a product using the Cayley graph.


   * - :cpp:member:`right(element_index_type,letter_type)`
     - Returns the index of the product of an element and a generator.


   * - :cpp:member:`right_cayley_graph()`
     - Returns a const reference to the right Cayley graph.


   * - :cpp:member:`size()`
     - Returns the size.


   * - :cpp:member:`size_type`
     - Unsigned integer type.


   * - :cpp:member:`suffix(element_index_type) const`
     - Returns the position of the longest proper suffix.



Member functions inherited from Runner
--------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`dead() const noexcept`
     - Check if the runner is dead.


   * - :cpp:member:`finished() const`
     - Check if :cpp:member:`run`  has been run to completion or not.


   * - :cpp:member:`kill() noexcept`
     - Stop :cpp:member:`run`  from running (thread-safe).


   * - :cpp:member:`report() const`
     - Check if it is time to report.


   * - :cpp:member:`report_every() const noexcept`
     - Get the minimum elapsed time between reports.


   * - :cpp:member:`report_every(TIntType) <template <typename TIntType> void report_every(TIntType)>`
     - Set the minimum elapsed time between reports.


   * - :cpp:member:`report_every(std::chrono::nanoseconds)`
     - Set the minimum elapsed time between reports.


   * - :cpp:member:`report_why_we_stopped() const`
     - Report why :cpp:member:`run`  stopped.


   * - :cpp:member:`run()`
     - Run until :cpp:member:`finished` .


   * - :cpp:member:`run_for(TIntType) <template <typename TIntType> void run_for(TIntType)>`
     - Run for a specified amount of time.


   * - :cpp:member:`run_for(std::chrono::nanoseconds)`
     - Run for a specified amount of time.


   * - :cpp:member:`run_until(T&&) <template <typename T> void run_until(T&&)>`
     - Run until a nullary predicate returns ``true`` or :cpp:member:`finished` .


   * - :cpp:member:`run_until(bool(*)())`
     - Run until a nullary predicate returns ``true`` or :cpp:member:`finished` .


   * - :cpp:member:`running() const noexcept`
     - Check if currently running.


   * - :cpp:member:`running_for() const noexcept`
     - Check if the runner is currently running for a particular length of time.


   * - :cpp:member:`running_until() const noexcept`
     - Check if the runner is currently running until a nullary predicate returns ``true``.


   * - :cpp:member:`started() const`
     - Check if :cpp:member:`run`  has been called at least once before.


   * - :cpp:member:`stopped() const`
     - Check if the runner is stopped.


   * - :cpp:member:`stopped_by_predicate() const`
     - Check if the runner was, or should, stop because of the argument for :cpp:member:`run_until` .


   * - :cpp:member:`timed_out() const`
     - Check if the amount of time passed to :cpp:member:`run_for`  has elapsed.



.. toctree::
   :hidden:

   libsemigroups__froidurepin__member_types.rst
   libsemigroups__froidurepin__adapter_member_types.rst
   libsemigroups__froidurepin__constructors.rst
   libsemigroups__froidurepin__deleted_constructors.rst
   libsemigroups__froidurepin__initialisation.rst
   libsemigroups__froidurepin__factorisation_and_relations.rst
   libsemigroups__froidurepin__membership.rst
   libsemigroups__froidurepin__iterators.rst
   libsemigroups__froidurepin__virtual_functions_from_froidurepinbase.rst
   libsemigroups__froidurepin__member_functions_inherited_from_froidurepinbase.rst
   libsemigroups__froidurepin__member_functions_inherited_from_runner.rst
