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

CongruenceWrapper
=================

.. doxygenclass:: libsemigroups::CongruenceWrapper
   :project: libsemigroups

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__const_iterator
       libsemigroups__congruencewrapper__rule_type
       libsemigroups__congruencewrapper__wrapped_type

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__congruencewrapper__
       libsemigroups__congruencewrapper__congruencewrapper_s_const__
       libsemigroups__congruencewrapper__congruencewrapper_std__shared_ptr_froidurepinbase__

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__congruencewrapper_congruencewrapper_const__
       libsemigroups__congruencewrapper__congruencewrapper_congruencewrapper___
       libsemigroups__congruencewrapper__operator__congruencewrapper_const__
       libsemigroups__congruencewrapper__operator__congruencewrapper___

Underlying congruence
---------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__congruence

Validation
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__validate_letter_char__const
       libsemigroups__congruencewrapper__validate_letter_letter_type__const
       libsemigroups__congruencewrapper__validate_word_std__string_const___const
       libsemigroups__congruencewrapper__validate_word_word_type_const___const

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__add_rule_relation_type_
       libsemigroups__congruencewrapper__add_rule_rule_type_
       libsemigroups__congruencewrapper__add_rule_std__initializer_list_size_t___std__initializer_list_size_t__
       libsemigroups__congruencewrapper__add_rule_std__string_const___std__string_const__
       libsemigroups__congruencewrapper__add_rule_word_type_const___word_type_const__
       libsemigroups__congruencewrapper__add_rules_froidurepinbase__
       libsemigroups__congruencewrapper__add_rules_std__vector_rule_type__const__
       libsemigroups__congruencewrapper__alphabet
       libsemigroups__congruencewrapper__identity
       libsemigroups__congruencewrapper__inverses
       libsemigroups__congruencewrapper__nr_rules
       libsemigroups__congruencewrapper__set_alphabet_size_t_
       libsemigroups__congruencewrapper__set_alphabet_std__string_const__
       libsemigroups__congruencewrapper__set_identity_letter_type_
       libsemigroups__congruencewrapper__set_identity_std__string_const__
       libsemigroups__congruencewrapper__set_inverses

Reporting
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__report
       libsemigroups__congruencewrapper__report_every_tinttype_
       libsemigroups__congruencewrapper__report_every_std__chrono__nanoseconds_
       libsemigroups__congruencewrapper__report_why_we_stopped

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__kill
       libsemigroups__congruencewrapper__run
       libsemigroups__congruencewrapper__run_for_tinttype_
       libsemigroups__congruencewrapper__run_for_std__chrono__nanoseconds_
       libsemigroups__congruencewrapper__run_until

State
-----

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__dead
       libsemigroups__congruencewrapper__finished
       libsemigroups__congruencewrapper__running
       libsemigroups__congruencewrapper__started
       libsemigroups__congruencewrapper__stopped
       libsemigroups__congruencewrapper__stopped_by_predicate
       libsemigroups__congruencewrapper__timed_out

Normal forms and equality testing
---------------------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__equal_to_std__initializer_list_letter_type___std__initializer_list_letter_type__
       libsemigroups__congruencewrapper__equal_to_std__string_const___std__string_const__
       libsemigroups__congruencewrapper__equal_to_word_type_const___word_type_const__
       libsemigroups__congruencewrapper__normal_form_std__initializer_list_letter_type__
       libsemigroups__congruencewrapper__normal_form_std__string_const__
       libsemigroups__congruencewrapper__normal_form_word_type_const__

Words to strings and vice versa
-------------------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__char_to_uint
       libsemigroups__congruencewrapper__string_to_word
       libsemigroups__congruencewrapper__uint_to_char
       libsemigroups__congruencewrapper__word_to_string

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

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__froidure_pin
       libsemigroups__congruencewrapper__has_froidure_pin

Finiteness
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__is_obviously_finite
       libsemigroups__congruencewrapper__is_obviously_infinite
       libsemigroups__congruencewrapper__size

Iterators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__cbegin_rules
       libsemigroups__congruencewrapper__cend_rules

Miscellanea
-----------

.. toctree::
       :maxdepth: 2

       libsemigroups__congruencewrapper__to_gap_string
