Metrics
=======

.. automodule:: skmatter.metrics

.. _GRE-api:

Global Reconstruction Error
---------------------------

.. autofunction:: skmatter.metrics.pointwise_global_reconstruction_error
.. autofunction:: skmatter.metrics.global_reconstruction_error

.. _GRD-api:

Global Reconstruction Distortion
--------------------------------

.. autofunction:: skmatter.metrics.pointwise_global_reconstruction_distortion
.. autofunction:: skmatter.metrics.global_reconstruction_distortion

.. _LRE-api:

Local Reconstruction Error
--------------------------

.. autofunction:: skmatter.metrics.pointwise_local_reconstruction_error
.. autofunction:: skmatter.metrics.local_reconstruction_error

.. _LPR-api:

Local Prediction Rigidity
-------------------------

.. autofunction:: skmatter.metrics.local_prediction_rigidity

.. _CPR-api:

Component-wise Prediction Rigidity
----------------------------------

.. autofunction:: skmatter.metrics.componentwise_prediction_rigidity


.. _pairwise-euclidian-api:

Pairwise Euclidean Distances
----------------------------

.. autofunction:: skmatter.metrics.periodic_pairwise_euclidean_distances

.. _pairwise-mahalanobis-api:

Pairwise Mahalanobis Distance
-----------------------------

.. autofunction:: skmatter.metrics.pairwise_mahalanobis_distances