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

Congruence
==========

.. doxygenclass:: libsemigroups::Congruence
   :project: libsemigroups

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__policy

Enums
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__policy__runners

Aliases
-------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__class_index_type
       libsemigroups__congruence__const_iterator
       libsemigroups__congruence__non_trivial_class_iterator
       libsemigroups__congruence__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__congruence__
       libsemigroups__congruence__congruence_congruence_const__
       libsemigroups__congruence__congruence_congruence___
       libsemigroups__congruence__congruence_congruence_type__fpsemigroup__
       libsemigroups__congruence__congruence_congruence_type__t_const__
       libsemigroups__congruence__congruence_congruence_type__policy__runners_
       libsemigroups__congruence__congruence_congruence_type__std__shared_ptr_froidurepinbase__
       libsemigroups__congruence__operator__congruence_const__
       libsemigroups__congruence__operator__congruence___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruence__add_pair_word_type_const___word_type_const__
       libsemigroups__congruence__nr_generating_pairs
       libsemigroups__congruence__nr_generators
       libsemigroups__congruence__set_nr_generators

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__report
       libsemigroups__congruence__report_every_tinttype_
       libsemigroups__congruence__report_every_std__chrono__nanoseconds_
       libsemigroups__congruence__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__kill
       libsemigroups__congruence__run
       libsemigroups__congruence__run_for_tinttype_
       libsemigroups__congruence__run_for_std__chrono__nanoseconds_
       libsemigroups__congruence__run_until_t___
       libsemigroups__congruence__run_until_bool_____

Numbers of classes, and comparisons
-----------------------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__const_contains
       libsemigroups__congruence__contains
       libsemigroups__congruence__less
       libsemigroups__congruence__non_trivial_classes
       libsemigroups__congruence__nr_classes
       libsemigroups__congruence__nr_non_trivial_classes

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__has_parent_froidure_pin
       libsemigroups__congruence__has_quotient_froidure_pin
       libsemigroups__congruence__is_quotient_obviously_finite
       libsemigroups__congruence__is_quotient_obviously_infinite
       libsemigroups__congruence__parent_froidure_pin
       libsemigroups__congruence__quotient_froidure_pin

Related algorithms
------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__has_knuth_bendix
       libsemigroups__congruence__has_todd_coxeter
       libsemigroups__congruence__knuth_bendix
       libsemigroups__congruence__todd_coxeter

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__class_index_to_word
       libsemigroups__congruence__word_to_class_index

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__dead
       libsemigroups__congruence__finished
       libsemigroups__congruence__kind
       libsemigroups__congruence__running
       libsemigroups__congruence__started
       libsemigroups__congruence__stopped
       libsemigroups__congruence__stopped_by_predicate
       libsemigroups__congruence__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__cbegin_generating_pairs
       libsemigroups__congruence__cbegin_ntc
       libsemigroups__congruence__cend_generating_pairs
       libsemigroups__congruence__cend_ntc
