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

FroidurePinBase
===============

.. doxygenclass:: libsemigroups::FroidurePinBase
   :project: libsemigroups

Type aliases
------------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__cayley_graph_type
       libsemigroups__froidurepinbase__element_index_type
       libsemigroups__froidurepinbase__size_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__froidurepinbase__
       libsemigroups__froidurepinbase__froidurepinbase_froidurepinbase_const__
       libsemigroups__froidurepinbase__froidurepinbase_froidurepinbase___
       libsemigroups__froidurepinbase__operator__froidurepinbase_const__
       libsemigroups__froidurepinbase__operator__froidurepinbase___

Settings
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__batch_size___const
       libsemigroups__froidurepinbase__batch_size_size_t_
       libsemigroups__froidurepinbase__concurrency_threshold___const
       libsemigroups__froidurepinbase__concurrency_threshold_size_t_
       libsemigroups__froidurepinbase__immutable_bool_
       libsemigroups__froidurepinbase__max_threads___const
       libsemigroups__froidurepinbase__max_threads_size_t_
       libsemigroups__froidurepinbase__reserve

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__report
       libsemigroups__froidurepinbase__report_every_tinttype_
       libsemigroups__froidurepinbase__report_every_std__chrono__nanoseconds_
       libsemigroups__froidurepinbase__report_why_we_stopped

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

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__enumerate
       libsemigroups__froidurepinbase__kill
       libsemigroups__froidurepinbase__run
       libsemigroups__froidurepinbase__run_for_tinttype_
       libsemigroups__froidurepinbase__run_for_std__chrono__nanoseconds_
       libsemigroups__froidurepinbase__run_until_t___
       libsemigroups__froidurepinbase__run_until_bool_____

Attributes
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__current_nr_rules
       libsemigroups__froidurepinbase__current_size
       libsemigroups__froidurepinbase__degree
       libsemigroups__froidurepinbase__is_finite
       libsemigroups__froidurepinbase__is_idempotent
       libsemigroups__froidurepinbase__is_monoid
       libsemigroups__froidurepinbase__nr_generators
       libsemigroups__froidurepinbase__nr_idempotents
       libsemigroups__froidurepinbase__size

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

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__left
       libsemigroups__froidurepinbase__left_cayley_graph
       libsemigroups__froidurepinbase__right
       libsemigroups__froidurepinbase__right_cayley_graph

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

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__current_max_word_length
       libsemigroups__froidurepinbase__equal_to
       libsemigroups__froidurepinbase__factorisation_element_index_type_
       libsemigroups__froidurepinbase__factorisation_word_type___element_index_type_
       libsemigroups__froidurepinbase__length_const
       libsemigroups__froidurepinbase__length_non_const
       libsemigroups__froidurepinbase__letter_to_pos
       libsemigroups__froidurepinbase__minimal_factorisation_element_index_type_
       libsemigroups__froidurepinbase__minimal_factorisation_word_type___element_index_type_
       libsemigroups__froidurepinbase__nr_rules
       libsemigroups__froidurepinbase__position_to_sorted_position
       libsemigroups__froidurepinbase__word_to_pos

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

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__final_letter
       libsemigroups__froidurepinbase__first_letter
       libsemigroups__froidurepinbase__prefix
       libsemigroups__froidurepinbase__suffix

Products
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__fast_product
       libsemigroups__froidurepinbase__product_by_reduction

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__dead
       libsemigroups__froidurepinbase__finished
       libsemigroups__froidurepinbase__running
       libsemigroups__froidurepinbase__started
       libsemigroups__froidurepinbase__stopped
       libsemigroups__froidurepinbase__stopped_by_predicate
       libsemigroups__froidurepinbase__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__froidurepinbase__cbegin_rules
       libsemigroups__froidurepinbase__cend_rules
