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

CongruenceByPairsHelper
=======================

.. doxygenclass:: libsemigroups::CongruenceByPairsHelper
   :project: libsemigroups

Aliases
-------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__class_index_type
       libsemigroups__congruencebypairshelper__const_iterator
       libsemigroups__congruencebypairshelper__const_reference
       libsemigroups__congruencebypairshelper__element_type
       libsemigroups__congruencebypairshelper__non_trivial_class_iterator
       libsemigroups__congruencebypairshelper__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__congruencebypairshelper
       libsemigroups__congruencebypairshelper__congruencebypairshelper_congruencebypairshelper_const__
       libsemigroups__congruencebypairshelper__congruencebypairshelper_congruencebypairshelper___
       libsemigroups__congruencebypairshelper__congruencebypairshelper_congruence_type__t_const__
       libsemigroups__congruencebypairshelper__congruencebypairshelper_congruence_type__std__shared_ptr_froidurepinbase__
       libsemigroups__congruencebypairshelper__operator__congruencebypairshelper_const__
       libsemigroups__congruencebypairshelper__operator__congruencebypairshelper___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruencebypairshelper__add_pair_word_type_const___word_type_const__
       libsemigroups__congruencebypairshelper__nr_generators
       libsemigroups__congruencebypairshelper__set_nr_generators

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__report
       libsemigroups__congruencebypairshelper__report_every_tinttype_
       libsemigroups__congruencebypairshelper__report_every_std__chrono__nanoseconds_
       libsemigroups__congruencebypairshelper__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__kill
       libsemigroups__congruencebypairshelper__run
       libsemigroups__congruencebypairshelper__run_for_tinttype_
       libsemigroups__congruencebypairshelper__run_for_std__chrono__nanoseconds_
       libsemigroups__congruencebypairshelper__run_until_t___
       libsemigroups__congruencebypairshelper__run_until_bool_____

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__const_contains
       libsemigroups__congruencebypairshelper__contains
       libsemigroups__congruencebypairshelper__less
       libsemigroups__congruencebypairshelper__non_trivial_classes
       libsemigroups__congruencebypairshelper__nr_classes
       libsemigroups__congruencebypairshelper__nr_generating_pairs
       libsemigroups__congruencebypairshelper__nr_non_trivial_classes

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__has_parent_froidure_pin
       libsemigroups__congruencebypairshelper__has_quotient_froidure_pin
       libsemigroups__congruencebypairshelper__is_quotient_obviously_finite
       libsemigroups__congruencebypairshelper__is_quotient_obviously_infinite
       libsemigroups__congruencebypairshelper__parent_froidure_pin
       libsemigroups__congruencebypairshelper__quotient_froidure_pin

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__class_index_to_word
       libsemigroups__congruencebypairshelper__word_to_class_index

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__dead
       libsemigroups__congruencebypairshelper__finished
       libsemigroups__congruencebypairshelper__kind
       libsemigroups__congruencebypairshelper__running
       libsemigroups__congruencebypairshelper__started
       libsemigroups__congruencebypairshelper__stopped
       libsemigroups__congruencebypairshelper__stopped_by_predicate
       libsemigroups__congruencebypairshelper__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencebypairshelper__cbegin_generating_pairs
       libsemigroups__congruencebypairshelper__cbegin_ntc
       libsemigroups__congruencebypairshelper__cend_generating_pairs
       libsemigroups__congruencebypairshelper__cend_ntc
