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

FroidurePinTraits
=================

.. doxygenstruct:: libsemigroups::FroidurePinTraits
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::FroidurePinTraits


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

   * - :cpp:member:`element_type`
     - The type of the elements of a :cpp:any:`FroidurePin`  instance.


   * - :cpp:member:`state_type`
     - The type of the state (if any).



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

   * - :cpp:member:`Complexity`
     - Adapter for the complexity of multiplication.


   * - :cpp:member:`Degree`
     - Adapter for the degree of an element.


   * - :cpp:member:`EqualTo`
     - Adapter for testing equality.


   * - :cpp:member:`Hash`
     - Adapter for hashing.


   * - :cpp:member:`IncreaseDegree`
     - Adapter for increasing the degree of an element.


   * - :cpp:member:`Less`
     - Adapter for comparisons.


   * - :cpp:member:`One`
     - Adapter for the identity element of the given type.


   * - :cpp:member:`Product`
     - Adapter for the product of two elements.


   * - :cpp:member:`Swap`
     - Adapter for swapping.



.. toctree::
   :hidden:

   libsemigroups__froidurepintraits__member_types.rst
   libsemigroups__froidurepintraits__adapters.rst
