.. Copyright (c) 2019-20, 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

Public types
------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__cayley_graph_type
       libsemigroups__froidurepin__const_element_type
       libsemigroups__froidurepin__const_iterator
       libsemigroups__froidurepin__const_iterator_idempotents
       libsemigroups__froidurepin__const_iterator_sorted
       libsemigroups__froidurepin__const_pointer
       libsemigroups__froidurepin__const_reference
       libsemigroups__froidurepin__const_reverse_iterator
       libsemigroups__froidurepin__const_reverse_iterator_idempotents
       libsemigroups__froidurepin__const_reverse_iterator_sorted
       libsemigroups__froidurepin__element_index_type
       libsemigroups__froidurepin__element_type
       libsemigroups__froidurepin__reference
       libsemigroups__froidurepin__size_type

Stateless public types
----------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__complexity
       libsemigroups__froidurepin__degree
       libsemigroups__froidurepin__equalto
       libsemigroups__froidurepin__hash
       libsemigroups__froidurepin__increasedegree
       libsemigroups__froidurepin__less
       libsemigroups__froidurepin__one
       libsemigroups__froidurepin__product
       libsemigroups__froidurepin__swap

Constructors
------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__froidurepin
       libsemigroups__froidurepin__froidurepin_froidurepin_const__
       libsemigroups__froidurepin__froidurepin_froidurepin___
       libsemigroups__froidurepin__froidurepin_std__initializer_list_element_type__
       libsemigroups__froidurepin__froidurepin_std__vector_element_type__const___
       libsemigroups__froidurepin__froidurepin_std__vector_element_type__const__
       libsemigroups__froidurepin__operator__froidurepin_const__
       libsemigroups__froidurepin__operator__froidurepin___

Settings
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__batch_size___const
       libsemigroups__froidurepin__batch_size_size_t_
       libsemigroups__froidurepin__concurrency_threshold___const
       libsemigroups__froidurepin__concurrency_threshold_size_t_
       libsemigroups__froidurepin__immutable_bool_
       libsemigroups__froidurepin__max_threads___const
       libsemigroups__froidurepin__max_threads_size_t_
       libsemigroups__froidurepin__reserve

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__report
       libsemigroups__froidurepin__report_every_tinttype_
       libsemigroups__froidurepin__report_every_std__chrono__nanoseconds_
       libsemigroups__froidurepin__report_why_we_stopped

Initialisation
--------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__add_generator
       libsemigroups__froidurepin__add_generators_t_const___t_const__
       libsemigroups__froidurepin__add_generators_tcollection_const__
       libsemigroups__froidurepin__add_generators_std__initializer_list_const_element_type__
       libsemigroups__froidurepin__closure_tcollection_const__
       libsemigroups__froidurepin__closure_std__initializer_list_const_element_type__
       libsemigroups__froidurepin__copy_add_generators
       libsemigroups__froidurepin__copy_closure

Enumerating
-----------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__enumerate
       libsemigroups__froidurepin__kill
       libsemigroups__froidurepin__run
       libsemigroups__froidurepin__run_for_tinttype_
       libsemigroups__froidurepin__run_for_std__chrono__nanoseconds_
       libsemigroups__froidurepin__run_until_t___
       libsemigroups__froidurepin__run_until_bool_____

Attributes
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__current_size
       libsemigroups__froidurepin__degree
       libsemigroups__froidurepin__generator
       libsemigroups__froidurepin__is_idempotent
       libsemigroups__froidurepin__is_monoid
       libsemigroups__froidurepin__nr_generators
       libsemigroups__froidurepin__nr_idempotents
       libsemigroups__froidurepin__size

Cayley graphs
-------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__left
       libsemigroups__froidurepin__left_cayley_graph
       libsemigroups__froidurepin__right
       libsemigroups__froidurepin__right_cayley_graph

Factorisation and relations
---------------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__current_max_word_length
       libsemigroups__froidurepin__current_nr_rules
       libsemigroups__froidurepin__equal_to
       libsemigroups__froidurepin__factorisation_element_index_type_
       libsemigroups__froidurepin__factorisation_word_type___element_index_type_
       libsemigroups__froidurepin__length_const
       libsemigroups__froidurepin__length_non_const
       libsemigroups__froidurepin__letter_to_pos
       libsemigroups__froidurepin__minimal_factorisation_element_index_type_
       libsemigroups__froidurepin__minimal_factorisation_word_type___element_index_type_
       libsemigroups__froidurepin__nr_rules
       libsemigroups__froidurepin__word_to_element
       libsemigroups__froidurepin__word_to_pos

Prefixes and suffixes
---------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__final_letter
       libsemigroups__froidurepin__first_letter
       libsemigroups__froidurepin__prefix
       libsemigroups__froidurepin__suffix

Products
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__fast_product
       libsemigroups__froidurepin__product_by_reduction

Membership
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__at
       libsemigroups__froidurepin__contains
       libsemigroups__froidurepin__current_position
       libsemigroups__froidurepin__operator__
       libsemigroups__froidurepin__position
       libsemigroups__froidurepin__position_to_sorted_position
       libsemigroups__froidurepin__sorted_at
       libsemigroups__froidurepin__sorted_position

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__dead
       libsemigroups__froidurepin__finished
       libsemigroups__froidurepin__running
       libsemigroups__froidurepin__started
       libsemigroups__froidurepin__stopped
       libsemigroups__froidurepin__stopped_by_predicate
       libsemigroups__froidurepin__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepin__begin
       libsemigroups__froidurepin__cbegin
       libsemigroups__froidurepin__cbegin_idempotents
       libsemigroups__froidurepin__cbegin_rules
       libsemigroups__froidurepin__cbegin_sorted
       libsemigroups__froidurepin__cend
       libsemigroups__froidurepin__cend_idempotents
       libsemigroups__froidurepin__cend_rules
       libsemigroups__froidurepin__cend_sorted
       libsemigroups__froidurepin__crbegin
       libsemigroups__froidurepin__crbegin_sorted
       libsemigroups__froidurepin__crend
       libsemigroups__froidurepin__crend_sorted
       libsemigroups__froidurepin__end
