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

CongruenceInterface
===================

.. doxygenclass:: libsemigroups::CongruenceInterface
   :project: libsemigroups

Aliases and public types
------------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__class_index_type
       libsemigroups__congruenceinterface__const_iterator
       libsemigroups__congruenceinterface__non_trivial_class_iterator
       libsemigroups__congruenceinterface__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__congruenceinterface_congruenceinterface_const__
       libsemigroups__congruenceinterface__congruenceinterface_congruence_type_

Deleted constructors
--------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__congruenceinterface__
       libsemigroups__congruenceinterface__congruenceinterface_congruenceinterface___
       libsemigroups__congruenceinterface__operator__congruenceinterface_const__
       libsemigroups__congruenceinterface__operator__congruenceinterface___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruenceinterface__add_pair_word_type_const___word_type_const__
       libsemigroups__congruenceinterface__nr_generating_pairs
       libsemigroups__congruenceinterface__nr_generators
       libsemigroups__congruenceinterface__set_nr_generators

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__report
       libsemigroups__congruenceinterface__report_every_tinttype_
       libsemigroups__congruenceinterface__report_every_std__chrono__nanoseconds_
       libsemigroups__congruenceinterface__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__kill
       libsemigroups__congruenceinterface__run
       libsemigroups__congruenceinterface__run_for_tinttype_
       libsemigroups__congruenceinterface__run_for_std__chrono__nanoseconds_
       libsemigroups__congruenceinterface__run_until_t___
       libsemigroups__congruenceinterface__run_until_bool_____

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__dead
       libsemigroups__congruenceinterface__finished
       libsemigroups__congruenceinterface__kind
       libsemigroups__congruenceinterface__running
       libsemigroups__congruenceinterface__started
       libsemigroups__congruenceinterface__stopped
       libsemigroups__congruenceinterface__stopped_by_predicate
       libsemigroups__congruenceinterface__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__cbegin_generating_pairs
       libsemigroups__congruenceinterface__cbegin_ntc
       libsemigroups__congruenceinterface__cend_generating_pairs
       libsemigroups__congruenceinterface__cend_ntc

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__class_index_to_word
       libsemigroups__congruenceinterface__word_to_class_index

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__const_contains
       libsemigroups__congruenceinterface__contains
       libsemigroups__congruenceinterface__less
       libsemigroups__congruenceinterface__non_trivial_classes
       libsemigroups__congruenceinterface__nr_classes
       libsemigroups__congruenceinterface__nr_non_trivial_classes

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruenceinterface__has_parent_fpsemigroup
       libsemigroups__congruenceinterface__has_parent_froidure_pin
       libsemigroups__congruenceinterface__has_quotient_froidure_pin
       libsemigroups__congruenceinterface__is_quotient_obviously_finite
       libsemigroups__congruenceinterface__is_quotient_obviously_infinite
       libsemigroups__congruenceinterface__parent_fpsemigroup
       libsemigroups__congruenceinterface__parent_froidure_pin
       libsemigroups__congruenceinterface__quotient_froidure_pin
