Library reference
=================

Base classes
------------

.. automodule:: scyseq.sequence
   :no-members:
   :no-undoc-members:

.. autoclass:: Symbol
   :members:
   :undoc-members:
   :special-members: __init__, __eq__

.. autoclass:: Alphabet
   :members:
   :undoc-members:
   :special-members: __init__, __eq__

.. autodata:: scyseq.sequence.boolean_alphabet
   :annotation: instance of Alphabet

.. autodata:: scyseq.sequence.binary_alphabet
   :annotation: instance of Alphabet

.. autoclass:: Sequence
   :members:
   :undoc-members:
   :special-members: __init__, __eq__

Operations
----------

.. automodule:: scyseq.operations
   :members:
   :special-members:

Discretisation and partition
----------------------------

.. automodule:: scyseq.discretize
   :members:
   :special-members:

Algorithmic complexity
----------------------

.. automodule:: scyseq.algorithmic
   :members:
   :special-members:

Stochastic and Markov
---------------------

.. automodule:: scyseq.stochastic
   :members:
   :special-members:

Information theory
------------------

.. automodule:: scyseq.information
   :members:
   :special-members:

Sequence generators
-------------------

.. automodule:: scyseq.generator
   :members:
   :special-members:

Input-output
------------

.. automodule:: scyseq.io
   :members:
   :special-members:

Visualisation
-------------

.. automodule:: scyseq.viz
   :members:
   :special-members:

Exceptions
----------

.. automodule:: scyseq.exceptions
   :members:
   :special-members:

Recurrence quantification
-------------------------

.. automodule:: scyseq.recurrence
   :members:
   :special-members: