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

Member functions inherited from FroidurePinBase
===============================================
.. cpp:namespace:: libsemigroups

This page contains a description of the member functions of the :cpp:any:`FroidurePin` class inherited from :cpp:any:`FroidurePinBase`.

.. cpp:namespace-pop::


.. doxygenfunction:: libsemigroups::FroidurePin::batch_size() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::batch_size(size_t) noexcept
   :project: libsemigroups

.. doxygentypedef:: libsemigroups::FroidurePin::cayley_graph_type
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::cbegin_rules() const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::cend_rules() const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::concurrency_threshold() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::concurrency_threshold(size_t) noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_length(element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_max_word_length() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_number_of_rules() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_position(letter_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_position(std::initializer_list< size_t > const &) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_position(word_type const &) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::current_size() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::degree() const noexcept
   :project: libsemigroups

.. doxygentypedef:: libsemigroups::FroidurePin::element_index_type
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::enumerate(size_t)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::factorisation(element_index_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::factorisation(word_type&, element_index_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::final_letter(element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::first_letter(element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::immutable() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::immutable(bool) noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::is_monoid()
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::left(element_index_type,letter_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::left_cayley_graph()
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::length(element_index_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::max_threads() const noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::max_threads(size_t) noexcept
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::minimal_factorisation(element_index_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::minimal_factorisation(word_type &,element_index_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::minimal_factorisation(word_type &,element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::number_of_rules()
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::prefix(element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::product_by_reduction(element_index_type,element_index_type) const
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::right(element_index_type,letter_type)
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::right_cayley_graph()
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::size()
   :project: libsemigroups

.. doxygentypedef:: libsemigroups::FroidurePin::size_type
   :project: libsemigroups

.. doxygenfunction:: libsemigroups::FroidurePin::suffix(element_index_type) const
   :project: libsemigroups
