ott.solvers.linear.sinkhorn.Sinkhorn.one_iteration

ott.solvers.linear.sinkhorn.Sinkhorn.one_iteration#

Sinkhorn.one_iteration(ot_prob, state, iteration, compute_error)[source]#

Carries out one Sinkhorn iteration.

Depending on lse_mode, these iterations can be either in:

  • log-space for numerical stability.

  • scaling space, using standard kernel-vector multiply operations.

Parameters:
  • ot_prob (LinearProblem) – the transport problem definition

  • state (SinkhornState) – SinkhornState named tuple.

  • iteration (int) – the current iteration of the Sinkhorn loop.

  • compute_error (bool) – flag to indicate this iteration computes/stores an error

Return type:

SinkhornState

Returns:

The updated state.