ott.solvers.linear
==================
.. module:: ott.solvers.linear
.. currentmodule:: ott.solvers.linear

Linear solvers are the bread-and-butter of OT solvers. They can be called on
their own, either the Sinkhorn
:class:`~ott.solvers.linear.sinkhorn.Sinkhorn` or Low-Rank
:class:`~ott.solvers.linear.sinkhorn_lr.LRSinkhorn` solvers, to match two
datasets. They also appear as subroutines for more advanced solvers in the
:mod:`ott.solvers` module, notably :mod:`ott.solvers.quadratic`.

Sinkhorn Solvers
----------------
.. autosummary::
    :toctree: _autosummary

    solve
    solve_semidiscrete
    sinkhorn.Sinkhorn
    sinkhorn.SinkhornState
    sinkhorn.SinkhornOutput
    sinkhorn_lr.LRSinkhorn
    sinkhorn_lr.LRSinkhornState
    sinkhorn_lr.LRSinkhornOutput

Barycenter Solvers
------------------
.. autosummary::
    :toctree: _autosummary

    continuous_barycenter.FreeWassersteinBarycenter
    continuous_barycenter.FreeBarycenterState
    discrete_barycenter.FixedBarycenter
    discrete_barycenter.SinkhornBarycenterOutput

Univariate Solvers
------------------
.. autosummary::
    :toctree: _autosummary

    solve_univariate
    univariate.uniform_solver
    univariate.quantile_solver
    univariate.north_west_solver
    univariate.UnivariateOutput

Semidiscrete Solvers
--------------------
.. autosummary::
    :toctree: _autosummary

    semidiscrete.SemidiscreteSolver
    semidiscrete.SemidiscreteState
    semidiscrete.SemidiscreteOutput
    semidiscrete.HardAssignmentOutput
    semidiscrete.constant_epsilon_scheduler

Sinkhorn Acceleration
---------------------
.. autosummary::
    :toctree: _autosummary

    acceleration.Momentum
    acceleration.AndersonAcceleration

Implicit Differentiation
------------------------
.. autosummary::
    :toctree: _autosummary

    implicit_differentiation.ImplicitDiff
    implicit_differentiation.solve_jax_cg
    lineax_implicit.solve_lineax

Low-rank Sinkhorn Utilities
---------------------------
.. autosummary::
    :toctree: _autosummary

    lr_utils.unbalanced_dykstra_lse
    lr_utils.unbalanced_dykstra_kernel