.. 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::KnuthBendix
=======================

.. doxygenclass:: libsemigroups::congruence::KnuthBendix
   :project: libsemigroups

Public Types
------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__class_index_type
       libsemigroups__congruence__knuthbendix__const_iterator
       libsemigroups__congruence__knuthbendix__non_trivial_class_iterator
       libsemigroups__congruence__knuthbendix__non_trivial_classes_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__knuthbendix
       libsemigroups__congruence__knuthbendix__knuthbendix_knuthbendix_const__
       libsemigroups__congruence__knuthbendix__knuthbendix_t_const__
       libsemigroups__congruence__knuthbendix__knuthbendix_fpsemigroup__knuthbendix_const__
       libsemigroups__congruence__knuthbendix__knuthbendix_std__shared_ptr_froidurepinbase__
       libsemigroups__congruence__knuthbendix__operator__knuthbendix_const__

Converters
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__class_index_to_word
       libsemigroups__congruence__knuthbendix__word_to_class_index

Initialisation
--------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__add_pair_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruence__knuthbendix__add_pair_word_type_const___word_type_const__
       libsemigroups__congruence__knuthbendix__set_nr_generators

Attributes
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__cbegin_generating_pairs
       libsemigroups__congruence__knuthbendix__cbegin_ntc
       libsemigroups__congruence__knuthbendix__cend_generating_pairs
       libsemigroups__congruence__knuthbendix__cend_ntc
       libsemigroups__congruence__knuthbendix__has_parent_froidure_pin
       libsemigroups__congruence__knuthbendix__has_quotient_froidure_pin
       libsemigroups__congruence__knuthbendix__is_quotient_obviously_finite
       libsemigroups__congruence__knuthbendix__is_quotient_obviously_infinite
       libsemigroups__congruence__knuthbendix__kind
       libsemigroups__congruence__knuthbendix__knuth_bendix
       libsemigroups__congruence__knuthbendix__non_trivial_classes
       libsemigroups__congruence__knuthbendix__nr_classes
       libsemigroups__congruence__knuthbendix__nr_generating_pairs
       libsemigroups__congruence__knuthbendix__nr_generators
       libsemigroups__congruence__knuthbendix__nr_non_trivial_classes
       libsemigroups__congruence__knuthbendix__parent_froidure_pin
       libsemigroups__congruence__knuthbendix__quotient_froidure_pin

Settings
--------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__report
       libsemigroups__congruence__knuthbendix__report_every_tinttype_
       libsemigroups__congruence__knuthbendix__report_every_std__chrono__nanoseconds_
       libsemigroups__congruence__knuthbendix__report_why_we_stopped

Running
-------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__kill
       libsemigroups__congruence__knuthbendix__run
       libsemigroups__congruence__knuthbendix__run_for_tinttype_
       libsemigroups__congruence__knuthbendix__run_for_std__chrono__nanoseconds_
       libsemigroups__congruence__knuthbendix__run_until_t___
       libsemigroups__congruence__knuthbendix__run_until_bool_____

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__dead
       libsemigroups__congruence__knuthbendix__finished
       libsemigroups__congruence__knuthbendix__running
       libsemigroups__congruence__knuthbendix__started
       libsemigroups__congruence__knuthbendix__stopped
       libsemigroups__congruence__knuthbendix__stopped_by_predicate
       libsemigroups__congruence__knuthbendix__timed_out

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruence__knuthbendix__const_contains
       libsemigroups__congruence__knuthbendix__contains
       libsemigroups__congruence__knuthbendix__less
