..
    Copyright (c) 2024 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.

.. currentmodule:: libsemigroups_pybind11

The FroidurePin class
=====================

.. autoclass:: FroidurePin
    :doc-only:

Contents
--------

.. autosummary::
    :signatures: short

    ~FroidurePin
    FroidurePin.add_generator
    FroidurePin.add_generators
    FroidurePin.batch_size
    FroidurePin.closure
    FroidurePin.contains
    FroidurePin.contains_one
    FroidurePin.copy
    FroidurePin.copy_add_generators
    FroidurePin.copy_closure
    FroidurePin.current_elements
    FroidurePin.current_left_cayley_graph
    FroidurePin.current_length
    FroidurePin.current_max_word_length
    FroidurePin.current_number_of_rules
    FroidurePin.current_position
    FroidurePin.current_right_cayley_graph
    FroidurePin.current_size
    FroidurePin.currently_contains_one
    FroidurePin.degree
    FroidurePin.enumerate
    FroidurePin.fast_product
    FroidurePin.final_letter
    FroidurePin.first_letter
    FroidurePin.generator
    FroidurePin.idempotents
    FroidurePin.init
    FroidurePin.is_finite
    FroidurePin.is_idempotent
    FroidurePin.left_cayley_graph
    FroidurePin.length
    FroidurePin.number_of_elements_of_length
    FroidurePin.number_of_generators
    FroidurePin.number_of_idempotents
    FroidurePin.number_of_rules
    FroidurePin.position
    FroidurePin.position_of_generator
    FroidurePin.prefix
    FroidurePin.reserve
    FroidurePin.right_cayley_graph
    FroidurePin.size
    FroidurePin.sorted_at
    FroidurePin.sorted_elements
    FroidurePin.sorted_position
    FroidurePin.suffix
    FroidurePin.to_sorted_position

Full API
--------

.. autoclass:: FroidurePin
   :class-doc-from: init
   :members:
   :exclude-members: 
      current_state, dead, finished, kill, last_report, report, report_every,
      report_prefix, report_why_we_stopped, reset_last_report, reset_start_time,
      run, run_for, run_until, running, running_for, running_until, start_time,
      started, state, stopped, stopped_by_predicate, success, timed_out