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

RepOrc
======

.. doxygenclass:: libsemigroups::RepOrc
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::RepOrc


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

   * - :cpp:member:`RepOrc() <RepOrc::RepOrc()>`
     - Default constructor.


   * - :cpp:member:`RepOrc(Sims1Settings\< S > const &) <template <typename S>  RepOrc(Sims1Settings< S > const &)>`
     - Construct from :cpp:any:`Sims1`  or :cpp:any:`MinimalRepOrc` .



Settings in common with Sims1
-----------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`extra() const noexcept`
     - Returns a const reference to the additional defining pairs.


   * - :cpp:member:`extra(P const&)`
     - Set the extra rules.


   * - :cpp:member:`long_rule_length(size_t)`
     - Define the long rule length.


   * - :cpp:member:`long_rules() const noexcept`
     - Returns the current long rules.


   * - :cpp:member:`long_rules(P const&)`
     - Set the long rules.


   * - :cpp:member:`number_of_threads() const noexcept`
     - Returns the current number of threads.


   * - :cpp:member:`number_of_threads(size_t)`
     - Set the number of threads.


   * - :cpp:member:`report_interval() const noexcept`
     - Returns the current report interval.


   * - :cpp:member:`report_interval(size_t) noexcept`
     - Set the report interval.


   * - :cpp:member:`settings() const noexcept`
     - Returns the settings object of *this.


   * - :cpp:member:`settings(Sims1Settings const &)`
     - Copy the settings from ``that`` into ``this``.


   * - :cpp:member:`short_rules() const noexcept`
     - Returns a const reference to the current short rules.


   * - :cpp:member:`short_rules(P const&)`
     - Set the short rules.


   * - :cpp:member:`split_at(size_t)`
     - Split the rules in :cpp:member:`short_rules`  and :cpp:member:`long_rules` .


   * - :cpp:member:`stats() const noexcept`
     - Returns a const reference to the current stats object.



Settings specifically for RepOrc
--------------------------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`digraph() const <template <typename T = uint32_t> ActionDigraph< T > digraph() const>`
     - Get the digraph.


   * - :cpp:member:`max_nodes() const noexcept`
     - The current maximum number of nodes.


   * - :cpp:member:`max_nodes(size_t) noexcept`
     - Set the maximum number of nodes.


   * - :cpp:member:`min_nodes() const noexcept`
     - The current minimum number of nodes.


   * - :cpp:member:`min_nodes(size_t) noexcept`
     - Set the minimum number of nodes.


   * - :cpp:member:`target_size() const noexcept`
     - The current target size.


   * - :cpp:member:`target_size(size_t) noexcept`
     - Set the target size.



.. toctree::
   :hidden:

   libsemigroups__reporc__constructors.rst
   libsemigroups__reporc__settings_in_common_with_sims1.rst
   libsemigroups__reporc__settings_specifically_for_reporc.rst
