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

congruence::ToddCoxeter
=======================

.. doxygenclass:: libsemigroups::congruence::ToddCoxeter
   :project: libsemigroups

Enums
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__order
       libsemigroups__congruence__toddcoxeter__policy__froidure_pin
       libsemigroups__congruence__toddcoxeter__policy__lookahead
       libsemigroups__congruence__toddcoxeter__policy__strategy

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__class_index_type
       libsemigroups__congruence__toddcoxeter__const_iterator
       libsemigroups__congruence__toddcoxeter__coset_type
       libsemigroups__congruence__toddcoxeter__non_trivial_class_iterator
       libsemigroups__congruence__toddcoxeter__non_trivial_classes_type
       libsemigroups__congruence__toddcoxeter__normal_form_iterator

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__policy

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__toddcoxeter__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_toddcoxeter_const__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_toddcoxeter___
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type_
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type__t_const__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type__toddcoxeter__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type__fpsemigroup__knuthbendix__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type__fpsemigroup__toddcoxeter__
       libsemigroups__congruence__toddcoxeter__toddcoxeter_congruence_type__std__shared_ptr_froidurepinbase___policy__froidure_pin_
       libsemigroups__congruence__toddcoxeter__operator__toddcoxeter_const__
       libsemigroups__congruence__toddcoxeter__operator__toddcoxeter___

Initialization
--------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruence__toddcoxeter__add_pair_word_type_const___word_type_const__
       libsemigroups__congruence__toddcoxeter__nr_generating_pairs
       libsemigroups__congruence__toddcoxeter__nr_generators
       libsemigroups__congruence__toddcoxeter__prefill_froidurepinbase__
       libsemigroups__congruence__toddcoxeter__prefill_table_const__
       libsemigroups__congruence__toddcoxeter__set_nr_generators

Settings
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__froidure_pin_policy_policy__froidure_pin_
       libsemigroups__congruence__toddcoxeter__lookahead
       libsemigroups__congruence__toddcoxeter__lower_bound
       libsemigroups__congruence__toddcoxeter__next_lookahead
       libsemigroups__congruence__toddcoxeter__random_interval_t_
       libsemigroups__congruence__toddcoxeter__random_interval_std__chrono__nanoseconds_
       libsemigroups__congruence__toddcoxeter__save
       libsemigroups__congruence__toddcoxeter__standardize_bool_
       libsemigroups__congruence__toddcoxeter__strategy___const
       libsemigroups__congruence__toddcoxeter__strategy_policy__strategy_

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__report
       libsemigroups__congruence__toddcoxeter__report_every_tinttype_
       libsemigroups__congruence__toddcoxeter__report_every_std__chrono__nanoseconds_
       libsemigroups__congruence__toddcoxeter__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__kill
       libsemigroups__congruence__toddcoxeter__run
       libsemigroups__congruence__toddcoxeter__run_for_tinttype_
       libsemigroups__congruence__toddcoxeter__run_for_std__chrono__nanoseconds_
       libsemigroups__congruence__toddcoxeter__run_until

Container-like
--------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__const_contains
       libsemigroups__congruence__toddcoxeter__contains
       libsemigroups__congruence__toddcoxeter__empty
       libsemigroups__congruence__toddcoxeter__less
       libsemigroups__congruence__toddcoxeter__non_trivial_classes
       libsemigroups__congruence__toddcoxeter__nr_classes
       libsemigroups__congruence__toddcoxeter__nr_non_trivial_classes
       libsemigroups__congruence__toddcoxeter__reserve
       libsemigroups__congruence__toddcoxeter__shrink_to_fit

Related semigroups
------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__has_parent_froidure_pin
       libsemigroups__congruence__toddcoxeter__has_quotient_froidure_pin
       libsemigroups__congruence__toddcoxeter__is_quotient_obviously_finite
       libsemigroups__congruence__toddcoxeter__is_quotient_obviously_infinite
       libsemigroups__congruence__toddcoxeter__parent_froidure_pin
       libsemigroups__congruence__toddcoxeter__quotient_froidure_pin

Words and class indices
-----------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__class_index_to_word
       libsemigroups__congruence__toddcoxeter__word_to_class_index

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__compatible
       libsemigroups__congruence__toddcoxeter__complete
       libsemigroups__congruence__toddcoxeter__dead
       libsemigroups__congruence__toddcoxeter__finished
       libsemigroups__congruence__toddcoxeter__kind
       libsemigroups__congruence__toddcoxeter__running
       libsemigroups__congruence__toddcoxeter__started
       libsemigroups__congruence__toddcoxeter__stopped
       libsemigroups__congruence__toddcoxeter__stopped_by_predicate
       libsemigroups__congruence__toddcoxeter__timed_out

Standardization
---------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__is_standardized
       libsemigroups__congruence__toddcoxeter__standardize_order_

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__toddcoxeter__cbegin_generating_pairs
       libsemigroups__congruence__toddcoxeter__cbegin_normal_forms
       libsemigroups__congruence__toddcoxeter__cbegin_ntc
       libsemigroups__congruence__toddcoxeter__cend_generating_pairs
       libsemigroups__congruence__toddcoxeter__cend_normal_forms
       libsemigroups__congruence__toddcoxeter__cend_ntc
