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

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

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

Stateful type aliases
---------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__domain_type
       libsemigroups__schreiersims__element_type
       libsemigroups__schreiersims__index_type
       libsemigroups__schreiersims__point_type

Stateless type aliases
----------------------

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__action
       libsemigroups__schreiersims__degree
       libsemigroups__schreiersims__equalto
       libsemigroups__schreiersims__inverse
       libsemigroups__schreiersims__one
       libsemigroups__schreiersims__product
       libsemigroups__schreiersims__swap

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

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__schreiersims__
       libsemigroups__schreiersims__schreiersims_schreiersims___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__schreiersims_schreiersims_const__
       libsemigroups__schreiersims__operator__schreiersims_const__
       libsemigroups__schreiersims__operator__schreiersims___

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

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__add_base_point
       libsemigroups__schreiersims__add_generator
       libsemigroups__schreiersims__clear

Attributes
----------

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__base
       libsemigroups__schreiersims__base_size
       libsemigroups__schreiersims__empty
       libsemigroups__schreiersims__finished
       libsemigroups__schreiersims__nr_generators
       libsemigroups__schreiersims__nr_strong_generators
       libsemigroups__schreiersims__strong_generator

Operators
---------

.. toctree::
       :maxdepth: 2

       libsemigroups__schreiersims__contains
       libsemigroups__schreiersims__generator
       libsemigroups__schreiersims__identity
       libsemigroups__schreiersims__sift
       libsemigroups__schreiersims__size
