.. Copyright (c) 2019-22, 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::ToddCoxeter
=======================

.. doxygenclass:: libsemigroups::congruence::ToddCoxeter
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::congruence::ToddCoxeter


Member types
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`class_iterator`
     - 
   * - :cpp:member:`coset_type`
     - Type of cosets stored in the table.


   * - :cpp:member:`froidure_pin_type`
     - 
   * - :cpp:member:`normal_form_iterator`
     - 
   * - :cpp:member:`options`
     - 
   * - :cpp:member:`options::deductions`
     - 
   * - :cpp:member:`options::froidure_pin`
     - 
   * - :cpp:member:`options::lookahead`
     - 
   * - :cpp:member:`options::preferred_defs`
     - 
   * - :cpp:member:`options::strategy`
     - 
   * - :cpp:member:`order`
     - 
   * - :cpp:member:`sort_free_function_type`
     - 
   * - :cpp:member:`sort_function_type`
     - 
   * - :cpp:member:`table_type`
     - 

Constructors
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`ToddCoxeter(ToddCoxeter const&)`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind)`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind, T const&) <template <typename T>  ToddCoxeter(congruence_kind, T const&)>`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind, ToddCoxeter&)`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind, fpsemigroup::KnuthBendix&)`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind, fpsemigroup::ToddCoxeter&)`
     - 
   * - :cpp:member:`ToddCoxeter(congruence_kind, std::shared_ptr<FroidurePinBase>, options::froidure_pin)`
     - 

Deleted constructors
--------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`ToddCoxeter() = delete`
     - Deleted.


   * - :cpp:member:`ToddCoxeter(ToddCoxeter&&) = delete`
     - Deleted.


   * - :cpp:member:`operator=(ToddCoxeter const&) = delete`
     - Deleted.


   * - :cpp:member:`operator=(ToddCoxeter&&) = delete`
     - Deleted.



Initialization
--------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`prefill(table_type const&)`
     - 

Settings
--------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`deduction_policy() const noexcept`
     - 
   * - :cpp:member:`deduction_policy(options::deductions)`
     - 
   * - :cpp:member:`f_defs() const noexcept`
     - 
   * - :cpp:member:`f_defs(size_t)`
     - 
   * - :cpp:member:`froidure_pin_policy() const noexcept`
     - 
   * - :cpp:member:`froidure_pin_policy(options::froidure_pin) noexcept`
     - 
   * - :cpp:member:`hlt_defs() const noexcept`
     - 
   * - :cpp:member:`hlt_defs(size_t)`
     - 
   * - :cpp:member:`large_collapse() const noexcept`
     - 
   * - :cpp:member:`large_collapse(size_t) noexcept`
     - 
   * - :cpp:member:`lookahead() const noexcept`
     - 
   * - :cpp:member:`lookahead(options::lookahead) noexcept`
     - 
   * - :cpp:member:`lookahead_growth_factor() const noexcept`
     - 
   * - :cpp:member:`lookahead_growth_factor(float)`
     - 
   * - :cpp:member:`lookahead_growth_threshold() const noexcept`
     - 
   * - :cpp:member:`lookahead_growth_threshold(size_t) noexcept`
     - 
   * - :cpp:member:`lower_bound() const noexcept`
     - 
   * - :cpp:member:`lower_bound(size_t) noexcept`
     - 
   * - :cpp:member:`max_deductions() const noexcept`
     - 
   * - :cpp:member:`max_deductions(size_t) noexcept`
     - 
   * - :cpp:member:`max_preferred_defs() const noexcept`
     - 
   * - :cpp:member:`max_preferred_defs(size_t) noexcept`
     - 
   * - :cpp:member:`min_lookahead() const noexcept`
     - 
   * - :cpp:member:`min_lookahead(size_t) noexcept`
     - 
   * - :cpp:member:`next_lookahead() const noexcept`
     - 
   * - :cpp:member:`next_lookahead(size_t) noexcept`
     - 
   * - :cpp:member:`preferred_defs() const noexcept`
     - 
   * - :cpp:member:`preferred_defs(options::preferred_defs) noexcept`
     - 
   * - :cpp:member:`random_interval() const noexcept`
     - 
   * - :cpp:member:`random_interval(T) noexcept <template <typename T> ToddCoxeter & random_interval(T) noexcept>`
     - 
   * - :cpp:member:`random_interval(std::chrono::nanoseconds) noexcept`
     - 
   * - :cpp:member:`random_shuffle_generating_pairs()`
     - 
   * - :cpp:member:`remove_duplicate_generating_pairs()`
     - 
   * - :cpp:member:`restandardize() const noexcept`
     - 
   * - :cpp:member:`restandardize(bool) noexcept`
     - 
   * - :cpp:member:`save() const noexcept`
     - 
   * - :cpp:member:`save(bool)`
     - 
   * - :cpp:member:`settings_string() const`
     - 
   * - :cpp:member:`simplify(size_t)`
     - 
   * - :cpp:member:`sort_generating_pairs(sort_free_function_type)`
     - 
   * - :cpp:member:`sort_generating_pairs(sort_function_type)`
     - 
   * - :cpp:member:`standardize() const noexcept`
     - 
   * - :cpp:member:`standardize(bool) noexcept`
     - 
   * - :cpp:member:`strategy() const noexcept`
     - 
   * - :cpp:member:`strategy(options::strategy)`
     - 
   * - :cpp:member:`use_relations_in_extra() const noexcept`
     - 
   * - :cpp:member:`use_relations_in_extra(bool) noexcept`
     - 

Statistics
----------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`stats() const noexcept`
     - 
   * - :cpp:member:`stats_string() const`
     - 

Container-like
--------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`empty() const`
     - 
   * - :cpp:member:`reserve(size_t)`
     - 
   * - :cpp:member:`shrink_to_fit()`
     - 

Standardization
---------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`is_standardized() const noexcept`
     - 
   * - :cpp:member:`standardization_order() const noexcept`
     - 
   * - :cpp:member:`standardize(order)`
     - 

Iterators
---------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`cbegin_class(class_index_type,size_t,size_t) const`
     - 
   * - :cpp:member:`cbegin_class(word_type const &,size_t,size_t)`
     - 
   * - :cpp:member:`cbegin_extra() const noexcept`
     - 
   * - :cpp:member:`cbegin_normal_forms()`
     - 
   * - :cpp:member:`cbegin_relations() const noexcept`
     - 
   * - :cpp:member:`cend_class() const`
     - 
   * - :cpp:member:`cend_extra() const noexcept`
     - 
   * - :cpp:member:`cend_normal_forms()`
     - 
   * - :cpp:member:`cend_relations() const noexcept`
     - 

Properties
----------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`compatible() const noexcept`
     - 
   * - :cpp:member:`complete() const noexcept`
     - 
   * - :cpp:member:`felsch_tree_height()`
     - 
   * - :cpp:member:`felsch_tree_number_of_nodes()`
     - 
   * - :cpp:member:`is_non_trivial(size_t, std::chrono::milliseconds, float)`
     - 
   * - :cpp:member:`length_of_generating_pairs()`
     - 
   * - :cpp:member:`number_of_words(class_index_type) const`
     - 
   * - :cpp:member:`number_of_words(word_type const&)`
     - 
   * - :cpp:member:`to_gap_string()`
     - 

Member functions inherited from CosetManager
--------------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`coset_capacity() const noexcept`
     - 
   * - :cpp:member:`first_free_coset() const noexcept`
     - 
   * - :cpp:member:`growth_factor() const noexcept`
     - 
   * - :cpp:member:`growth_factor(float)`
     - 
   * - :cpp:member:`has_free_cosets() const noexcept`
     - 
   * - :cpp:member:`is_active_coset(coset_type) const`
     - 
   * - :cpp:member:`is_valid_coset(coset_type) const noexcept`
     - 
   * - :cpp:member:`next_active_coset(coset_type) const`
     - 
   * - :cpp:member:`number_of_cosets_active() const noexcept`
     - 
   * - :cpp:member:`number_of_cosets_defined() const noexcept`
     - 
   * - :cpp:member:`number_of_cosets_killed() const noexcept`
     - 

Member functions inherited from CongruenceInterface
---------------------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`add_pair(std::initializer_list<size_t>, std::initializer_list<size_t>)`
     - 
   * - :cpp:member:`add_pair(word_type const&, word_type const&)`
     - 
   * - :cpp:member:`cbegin_generating_pairs() const noexcept`
     - 
   * - :cpp:member:`cbegin_ntc()`
     - 
   * - :cpp:member:`cend_generating_pairs() const noexcept`
     - 
   * - :cpp:member:`cend_ntc()`
     - 
   * - :cpp:member:`class_index_to_word(class_index_type)`
     - 
   * - :cpp:member:`class_index_type`
     - Type for indices of congruence class indices.


   * - :cpp:member:`const_contains(word_type const&, word_type const&) const`
     - 
   * - :cpp:member:`const_iterator`
     - 
   * - :cpp:member:`contains(word_type const&, word_type const&) override`
     - 
   * - :cpp:member:`has_parent_fpsemigroup() const noexcept`
     - 
   * - :cpp:member:`has_parent_froidure_pin() const noexcept`
     - 
   * - :cpp:member:`has_quotient_froidure_pin() const noexcept`
     - 
   * - :cpp:member:`is_quotient_obviously_finite()`
     - 
   * - :cpp:member:`is_quotient_obviously_infinite()`
     - 
   * - :cpp:member:`kind() const noexcept`
     - 
   * - :cpp:member:`less(word_type const&, word_type const&)`
     - 
   * - :cpp:member:`non_trivial_class_iterator`
     - 
   * - :cpp:member:`non_trivial_classes()`
     - 
   * - :cpp:member:`non_trivial_classes_type`
     - 
   * - :cpp:member:`number_of_classes()`
     - 
   * - :cpp:member:`number_of_generating_pairs() const noexcept`
     - 
   * - :cpp:member:`number_of_generators() const noexcept`
     - 
   * - :cpp:member:`number_of_non_trivial_classes()`
     - 
   * - :cpp:member:`parent_fpsemigroup() const`
     - 
   * - :cpp:member:`parent_froidure_pin() const`
     - 
   * - :cpp:member:`quotient_froidure_pin()`
     - 
   * - :cpp:member:`set_number_of_generators(size_t)`
     - 
   * - :cpp:member:`word_to_class_index(word_type const&)`
     - 

Member functions inherited from Runner
--------------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`dead() const noexcept`
     - 
   * - :cpp:member:`finished() const`
     - 
   * - :cpp:member:`kill() noexcept`
     - 
   * - :cpp:member:`report() const`
     - 
   * - :cpp:member:`report_every() const noexcept`
     - 
   * - :cpp:member:`report_every(TIntType) <template <typename TIntType> void report_every(TIntType)>`
     - 
   * - :cpp:member:`report_every(std::chrono::nanoseconds)`
     - 
   * - :cpp:member:`report_why_we_stopped() const`
     - 
   * - :cpp:member:`run()`
     - 
   * - :cpp:member:`run_for(TIntType) <template <typename TIntType> void run_for(TIntType)>`
     - 
   * - :cpp:member:`run_for(std::chrono::nanoseconds)`
     - 
   * - :cpp:member:`run_until(T&&) <template <typename T> void run_until(T&&)>`
     - 
   * - :cpp:member:`run_until(bool(*)())`
     - 
   * - :cpp:member:`running() const noexcept`
     - 
   * - :cpp:member:`running_for() const noexcept`
     - 
   * - :cpp:member:`running_until() const noexcept`
     - 
   * - :cpp:member:`started() const`
     - 
   * - :cpp:member:`stopped() const`
     - 
   * - :cpp:member:`stopped_by_predicate() const`
     - 
   * - :cpp:member:`timed_out() const`
     - 

.. toctree::
   :hidden:

   libsemigroups__congruence__toddcoxeter__member_types.rst
   libsemigroups__congruence__toddcoxeter__constructors.rst
   libsemigroups__congruence__toddcoxeter__deleted_constructors.rst
   libsemigroups__congruence__toddcoxeter__initialization.rst
   libsemigroups__congruence__toddcoxeter__settings.rst
   libsemigroups__congruence__toddcoxeter__statistics.rst
   libsemigroups__congruence__toddcoxeter__container_like.rst
   libsemigroups__congruence__toddcoxeter__standardization.rst
   libsemigroups__congruence__toddcoxeter__iterators.rst
   libsemigroups__congruence__toddcoxeter__properties.rst
   libsemigroups__congruence__toddcoxeter__member_functions_inherited_from_cosetmanager.rst
   libsemigroups__congruence__toddcoxeter__member_functions_inherited_from_congruenceinterface.rst
   libsemigroups__congruence__toddcoxeter__member_functions_inherited_from_runner.rst
