.. _api_ref:

.. currentmodule:: mdentropy


API reference
=============

Binning Functions
-----------------

.. autosummary::
    :toctree: generated/

    mdentropy.core.binning.doanes_rule
    mdentropy.core.binning.hist
    mdentropy.core.binning.symbolic

Entropy Calculations
--------------------

.. autosummary::
    :toctree: generated/

    mdentropy.entropy
    mdentropy.centropy

Information Calculations
------------------------

.. autosummary::
    :toctree: generated/

    mdentropy.mutinf
    mdentropy.nmutinf
    mdentropy.cmutinf
    mdentropy.ncmutinf

Feature Metrics
---------------

.. autosummary::
    :toctree: generated/

    mdentropy.metrics.AlphaAngleMutualInformation
    mdentropy.metrics.AlphaAngleTransferEntropy
    mdentropy.metrics.ContactMutualInformation
    mdentropy.metrics.ContactTransferEntropy
    mdentropy.metrics.DihedralMutualInformation
    mdentropy.metrics.DihedralTransferEntropy