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

SchreierSims
============

.. doxygenclass:: libsemigroups::SchreierSims
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::SchreierSims


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

   * - :cpp:member:`domain_type`
     - Type of the object containing all points acted on.


   * - :cpp:member:`element_type`
     - 
   * - :cpp:member:`index_type`
     - Type of indices.


   * - :cpp:member:`point_type`
     - 

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

   * - :cpp:member:`Action`
     - 
   * - :cpp:member:`Degree`
     - 
   * - :cpp:member:`EqualTo`
     - 
   * - :cpp:member:`Inverse`
     - 
   * - :cpp:member:`One`
     - 
   * - :cpp:member:`Product`
     - 
   * - :cpp:member:`Swap`
     - 

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

   * - :cpp:member:`SchreierSims() <SchreierSims::SchreierSims()>`
     - 
   * - :cpp:member:`SchreierSims(SchreierSims &&) = default`
     - Default move constructor.



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

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


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


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



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

   * - :cpp:member:`add_base_point(point_type)`
     - 
   * - :cpp:member:`add_generator(const_element_reference)`
     - 
   * - :cpp:member:`clear()`
     - 

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

   * - :cpp:member:`run()`
     - 

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

   * - :cpp:member:`base(index_type) const`
     - 
   * - :cpp:member:`base_size() const noexcept`
     - 
   * - :cpp:member:`empty()`
     - 
   * - :cpp:member:`finished() const`
     - 
   * - :cpp:member:`generator(index_type) const`
     - 
   * - :cpp:member:`identity() const`
     - 
   * - :cpp:member:`inversal_element(index_type, point_type)`
     - 
   * - :cpp:member:`number_of_generators() const noexcept`
     - 
   * - :cpp:member:`number_of_strong_generators(index_type) const`
     - 
   * - :cpp:member:`orbits_lookup(index_type, point_type)`
     - 
   * - :cpp:member:`size()`
     - 
   * - :cpp:member:`strong_generator(index_type,index_type) const`
     - 
   * - :cpp:member:`transversal_element(index_type, point_type)`
     - 

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

   * - :cpp:member:`contains(const_element_reference)`
     - 
   * - :cpp:member:`sift(const_element_reference)`
     - 

.. toctree::
   :hidden:

   libsemigroups__schreiersims__member_types.rst
   libsemigroups__schreiersims__adapter_types.rst
   libsemigroups__schreiersims__constructors.rst
   libsemigroups__schreiersims__deleted_constructors.rst
   libsemigroups__schreiersims__initialisation.rst
   libsemigroups__schreiersims__running.rst
   libsemigroups__schreiersims__attributes.rst
   libsemigroups__schreiersims__membership.rst
