API
===

Descriptions
------------

.. _description_api_doc:

Description
~~~~~~~~~~~

.. autoclass:: pyparcs.Description
    :members:

Random Description
~~~~~~~~~~~~~~~~~~

.. autoclass:: pyparcs.RandomDescription
    :show-inheritance:
    :members:

Temporal Description
~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyparcs.temporal.TemporalDescription
    :show-inheritance:

Guidelines
----------

Guideline
~~~~~~~~~

.. autoclass:: pyparcs.Guideline

Guideline Iterator
~~~~~~~~~~~~~~~~~~

.. autoclass:: pyparcs.GuidelineIterator
    :members: get_guidelines

Graph
-----

.. autoclass:: pyparcs.Graph
    :members:


Misc
----

The following API doc describes the misc functions and classes, used in the backend of PARCS. They will not be directly used in PARCS codes. The API doc is provided as a support for understanding the PARCS algorithm.


Distribution Parameter
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyparcs.api.output_distributions.DistParam
    :members:

PARCS Distribution
~~~~~~~~~~~~~~~~~~

.. autoclass:: pyparcs.api.output_distributions.PARCSDistribution
    :members: