Periphery functions and classes
========================================

Some functions that can be used, for instance, for post-processing of optimal solutions. This includes numerical approximation of the displacement interpolation.

Data structures for couplings and weighted point clouds
---------------------------------------------------------------
First two sparse data structures for storing kernel / coupling matrix information. They are implementations of the scipy.sparse.csr_matrix and coo_matrix formats.
Coupling information in these data structures can usually be obtained from a Sinkhorn solver object after solving by calling the appropriate method.

.. autoclass:: MultiScaleOT.TSparseCSRContainer
   :members:
   :special-members:
.. autoclass:: MultiScaleOT.TSparsePosContainer
   :members:
   :special-members:

The next data structure is for a list of particles. For example, such objects are generated by the displacement interpolation methods from coupling data objects.

.. autoclass:: MultiScaleOT.TParticleContainer
   :members:
   :special-members:

Displacement interpolation
-----------------------------------------------
.. autofunction:: MultiScaleOT.interpolateEuclidean

.. autofunction:: MultiScaleOT.interpolateEuclideanHK

.. autofunction:: MultiScaleOT.projectInterpolation