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

Konieczny
=========

.. doxygenclass:: libsemigroups::Konieczny
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::Konieczny


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

   * - :cpp:member:`D_class_index_type`
     - 
   * - :cpp:member:`const_d_class_iterator`
     - 
   * - :cpp:member:`const_element_type`
     - The type of const elements.


   * - :cpp:member:`const_iterator`
     - A type for const iterators through elements.


   * - :cpp:member:`const_reference`
     - Type of element const references.


   * - :cpp:member:`const_regular_d_class_iterator`
     - 
   * - :cpp:member:`element_type`
     - The type of elements.


   * - :cpp:member:`lambda_orb_type`
     - The type of the orbit of the lambda values.


   * - :cpp:member:`lambda_value_type`
     - The type of lambda values.


   * - :cpp:member:`rho_orb_type`
     - The type of the orbit of the rho values.


   * - :cpp:member:`rho_value_type`
     - The type of rho values.



Adapter member types
--------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`Degree`
     - 
   * - :cpp:member:`EqualTo`
     - 
   * - :cpp:member:`Lambda`
     - 
   * - :cpp:member:`Less`
     - 
   * - :cpp:member:`One`
     - 
   * - :cpp:member:`Product`
     - 
   * - :cpp:member:`Rank`
     - 
   * - :cpp:member:`Rho`
     - 
   * - :cpp:member:`Swap`
     - 

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

   * - :cpp:member:`Konieczny() <Konieczny::Konieczny()>`
     - 
   * - :cpp:member:`Konieczny(std::vector<element_type> const&)`
     - 

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

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


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


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


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



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

   * - :cpp:member:`add_generator(const_reference)`
     - 
   * - :cpp:member:`add_generators(T const&) <template <typename T> void add_generators(T const&)>`
     - 
   * - :cpp:member:`add_generators(T const&, T const&) <template <typename T> void add_generators(T const&, T const&)>`
     - 
   * - :cpp:member:`add_generators(std::initializer_list<const_element_type>)`
     - 

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

   * - :cpp:member:`contains(const_reference)`
     - 
   * - :cpp:member:`is_regular_element(const_reference)`
     - 

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

   * - :cpp:member:`D_class_of_element(const_reference)`
     - 
   * - :cpp:member:`number_of_D_classes()`
     - 
   * - :cpp:member:`number_of_H_classes()`
     - 
   * - :cpp:member:`number_of_L_classes()`
     - 
   * - :cpp:member:`number_of_R_classes()`
     - 
   * - :cpp:member:`number_of_idempotents()`
     - 
   * - :cpp:member:`number_of_regular_D_classes()`
     - 
   * - :cpp:member:`number_of_regular_L_classes()`
     - 
   * - :cpp:member:`number_of_regular_R_classes()`
     - 
   * - :cpp:member:`number_of_regular_elements()`
     - 
   * - :cpp:member:`size()`
     - 

Const Attributes
----------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`current_number_of_D_classes() const`
     - 
   * - :cpp:member:`current_number_of_H_classes() const`
     - 
   * - :cpp:member:`current_number_of_L_classes() const`
     - 
   * - :cpp:member:`current_number_of_R_classes() const`
     - 
   * - :cpp:member:`current_number_of_idempotents() const`
     - 
   * - :cpp:member:`current_number_of_regular_D_classes() const`
     - 
   * - :cpp:member:`current_number_of_regular_L_classes() const`
     - 
   * - :cpp:member:`current_number_of_regular_R_classes() const`
     - 
   * - :cpp:member:`current_number_of_regular_elements() const`
     - 
   * - :cpp:member:`current_size() const`
     - 
   * - :cpp:member:`degree() const noexcept`
     - 
   * - :cpp:member:`generator(size_t) const`
     - 
   * - :cpp:member:`number_of_generators() const noexcept`
     - 

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

   * - :cpp:member:`cbegin_D_classes() const`
     - 
   * - :cpp:member:`cbegin_generators() const noexcept`
     - 
   * - :cpp:member:`cbegin_rdc() const noexcept`
     - Shorter form of :cpp:member:`cbegin_regular_D_classes` .


   * - :cpp:member:`cbegin_regular_D_classes() const`
     - 
   * - :cpp:member:`cend_D_classes() const noexcept`
     - 
   * - :cpp:member:`cend_generators() const noexcept`
     - 
   * - :cpp:member:`cend_rdc() const`
     - Shorter form of :cpp:member:`cend_regular_D_classes` .


   * - :cpp:member:`cend_regular_D_classes() const noexcept`
     - 

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__konieczny__member_types.rst
   libsemigroups__konieczny__adapter_member_types.rst
   libsemigroups__konieczny__constructors.rst
   libsemigroups__konieczny__deleted_constructors.rst
   libsemigroups__konieczny__initialisation.rst
   libsemigroups__konieczny__elements.rst
   libsemigroups__konieczny__attributes.rst
   libsemigroups__konieczny__const_attributes.rst
   libsemigroups__konieczny__iterators.rst
   libsemigroups__konieczny__member_functions_inherited_from_runner.rst
