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

KnuthBendixCongruenceByPairs
============================

.. doxygenclass:: libsemigroups::KnuthBendixCongruenceByPairs
   :project: libsemigroups

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

.. toctree::
       :maxdepth: 2


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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__knuthbendixcongruencebypairs_congruence_type__knuthbendix_const__
       libsemigroups__knuthbendixcongruencebypairs__knuthbendixcongruencebypairs_congruence_type__std__shared_ptr_knuthbendix__

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__knuthbendixcongruencebypairs__
       libsemigroups__knuthbendixcongruencebypairs__knuthbendixcongruencebypairs_knuthbendixcongruencebypairs_const__
       libsemigroups__knuthbendixcongruencebypairs__knuthbendixcongruencebypairs_knuthbendixcongruencebypairs___
       libsemigroups__knuthbendixcongruencebypairs__operator__knuthbendixcongruencebypairs_const__
       libsemigroups__knuthbendixcongruencebypairs__operator__knuthbendixcongruencebypairs___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__class_index_type
       libsemigroups__knuthbendixcongruencebypairs__const_iterator
       libsemigroups__knuthbendixcongruencebypairs__non_trivial_class_iterator
       libsemigroups__knuthbendixcongruencebypairs__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__knuthbendixcongruencebypairs__add_pair_word_type_const___word_type_const__
       libsemigroups__knuthbendixcongruencebypairs__nr_generating_pairs
       libsemigroups__knuthbendixcongruencebypairs__nr_generators
       libsemigroups__knuthbendixcongruencebypairs__set_nr_generators

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__report
       libsemigroups__knuthbendixcongruencebypairs__report_every_tinttype_
       libsemigroups__knuthbendixcongruencebypairs__report_every_std__chrono__nanoseconds_
       libsemigroups__knuthbendixcongruencebypairs__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__kill
       libsemigroups__knuthbendixcongruencebypairs__run
       libsemigroups__knuthbendixcongruencebypairs__run_for_tinttype_
       libsemigroups__knuthbendixcongruencebypairs__run_for_std__chrono__nanoseconds_
       libsemigroups__knuthbendixcongruencebypairs__run_until_t___
       libsemigroups__knuthbendixcongruencebypairs__run_until_bool_____

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__const_contains
       libsemigroups__knuthbendixcongruencebypairs__contains
       libsemigroups__knuthbendixcongruencebypairs__less
       libsemigroups__knuthbendixcongruencebypairs__non_trivial_classes
       libsemigroups__knuthbendixcongruencebypairs__nr_classes
       libsemigroups__knuthbendixcongruencebypairs__nr_non_trivial_classes

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__has_parent_froidure_pin
       libsemigroups__knuthbendixcongruencebypairs__has_quotient_froidure_pin
       libsemigroups__knuthbendixcongruencebypairs__is_quotient_obviously_finite
       libsemigroups__knuthbendixcongruencebypairs__is_quotient_obviously_infinite
       libsemigroups__knuthbendixcongruencebypairs__parent_froidure_pin
       libsemigroups__knuthbendixcongruencebypairs__quotient_froidure_pin

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

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__class_index_to_word
       libsemigroups__knuthbendixcongruencebypairs__word_to_class_index

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__dead
       libsemigroups__knuthbendixcongruencebypairs__finished
       libsemigroups__knuthbendixcongruencebypairs__kind
       libsemigroups__knuthbendixcongruencebypairs__running
       libsemigroups__knuthbendixcongruencebypairs__started
       libsemigroups__knuthbendixcongruencebypairs__stopped
       libsemigroups__knuthbendixcongruencebypairs__stopped_by_predicate
       libsemigroups__knuthbendixcongruencebypairs__timed_out

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__knuthbendixcongruencebypairs__cbegin_generating_pairs
       libsemigroups__knuthbendixcongruencebypairs__cbegin_ntc
       libsemigroups__knuthbendixcongruencebypairs__cend_generating_pairs
       libsemigroups__knuthbendixcongruencebypairs__cend_ntc
