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

CongruenceByPairs
=================

.. doxygenclass:: libsemigroups::CongruenceByPairs
   :project: libsemigroups

Aliases
-------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__class_index_type
       libsemigroups__congruencebypairs__const_iterator
       libsemigroups__congruencebypairs__const_reference
       libsemigroups__congruencebypairs__element_type
       libsemigroups__congruencebypairs__non_trivial_class_iterator
       libsemigroups__congruencebypairs__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__congruencebypairs
       libsemigroups__congruencebypairs__congruencebypairs_congruencebypairs_const__
       libsemigroups__congruencebypairs__congruencebypairs_congruencebypairs___
       libsemigroups__congruencebypairs__congruencebypairs_congruence_type__t_const__
       libsemigroups__congruencebypairs__congruencebypairs_congruence_type__std__shared_ptr_froidurepinbase__
       libsemigroups__congruencebypairs__operator__congruencebypairs_const__
       libsemigroups__congruencebypairs__operator__congruencebypairs___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruencebypairs__add_pair_word_type_const___word_type_const__
       libsemigroups__congruencebypairs__nr_generators
       libsemigroups__congruencebypairs__set_nr_generators

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__report
       libsemigroups__congruencebypairs__report_every_tinttype_
       libsemigroups__congruencebypairs__report_every_std__chrono__nanoseconds_
       libsemigroups__congruencebypairs__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__kill
       libsemigroups__congruencebypairs__run
       libsemigroups__congruencebypairs__run_for_tinttype_
       libsemigroups__congruencebypairs__run_for_std__chrono__nanoseconds_
       libsemigroups__congruencebypairs__run_until

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__const_contains
       libsemigroups__congruencebypairs__contains
       libsemigroups__congruencebypairs__less
       libsemigroups__congruencebypairs__non_trivial_classes
       libsemigroups__congruencebypairs__nr_classes
       libsemigroups__congruencebypairs__nr_generating_pairs
       libsemigroups__congruencebypairs__nr_non_trivial_classes

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__has_parent_froidure_pin
       libsemigroups__congruencebypairs__has_quotient_froidure_pin
       libsemigroups__congruencebypairs__is_quotient_obviously_finite
       libsemigroups__congruencebypairs__is_quotient_obviously_infinite
       libsemigroups__congruencebypairs__parent_froidure_pin
       libsemigroups__congruencebypairs__quotient_froidure_pin

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__class_index_to_word
       libsemigroups__congruencebypairs__word_to_class_index

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__dead
       libsemigroups__congruencebypairs__finished
       libsemigroups__congruencebypairs__kind
       libsemigroups__congruencebypairs__running
       libsemigroups__congruencebypairs__started
       libsemigroups__congruencebypairs__stopped
       libsemigroups__congruencebypairs__stopped_by_predicate
       libsemigroups__congruencebypairs__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairs__cbegin_generating_pairs
       libsemigroups__congruencebypairs__cbegin_ntc
       libsemigroups__congruencebypairs__cend_generating_pairs
       libsemigroups__congruencebypairs__cend_ntc
