The ``constrainedrandom`` package
=================================

This is the documentation generated from the code. It is intended as developer-facing documentation.

User-facing classes
-------------------

These classes are user-facing and the API should remain the same. If changes are necessary, this should result in a major version increment.

.. autoclass:: constrainedrandom.RandObj
   :members:
   :undoc-members:
   :show-inheritance:

Internal classes
----------------

These classes are internal-facing and the design can change if required.

.. automodule:: constrainedrandom.internal.randvar
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: constrainedrandom.internal.multivar
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: constrainedrandom.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: constrainedrandom.random
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: constrainedrandom.debug
   :members:
   :undoc-members:
   :show-inheritance: