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

Runner
======

.. doxygenclass:: libsemigroups::Runner
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::Runner


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

   * - :cpp:member:`Runner() <Runner::Runner()>`
     - 
   * - :cpp:member:`Runner(Runner const&)`
     - 
   * - :cpp:member:`Runner(Runner&&)`
     - 
   * - :cpp:member:`operator=(Runner const&)`
     - 
   * - :cpp:member:`operator=(Runner&&)`
     - 

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

   * - :cpp:member:`report() const`
     - 
   * - :cpp:member:`report_every() const noexcept`
     - 
   * - :cpp:member:`report_every(TIntType) <template <typename TIntType> void report_every(TIntType)>`
     - 
   * - :cpp:member:`report_every(std::chrono::nanoseconds)`
     - 
   * - :cpp:member:`report_why_we_stopped() const`
     - 

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

   * - :cpp:member:`dead() const noexcept`
     - 
   * - :cpp:member:`finished() const`
     - 
   * - :cpp:member:`running() const noexcept`
     - 
   * - :cpp:member:`started() const`
     - 
   * - :cpp:member:`stopped() const`
     - 
   * - :cpp:member:`stopped_by_predicate() const`
     - 
   * - :cpp:member:`timed_out() const`
     - 

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

   * - :cpp:member:`kill() noexcept`
     - 
   * - :cpp:member:`run()`
     - 
   * - :cpp:member:`run_for(TIntType) <template <typename TIntType> void run_for(TIntType)>`
     - 
   * - :cpp:member:`run_for(std::chrono::nanoseconds)`
     - 
   * - :cpp:member:`run_until(T&&) <template <typename T> void run_until(T&&)>`
     - 
   * - :cpp:member:`run_until(bool(*)())`
     - 
   * - :cpp:member:`running_for() const noexcept`
     - 
   * - :cpp:member:`running_until() const noexcept`
     - 

.. toctree::
   :hidden:

   libsemigroups__runner__constructors.rst
   libsemigroups__runner__reporting.rst
   libsemigroups__runner__state.rst
   libsemigroups__runner__operators.rst
