ott.solvers.linear.sinkhorn.SinkhornState

class ott.solvers.linear.sinkhorn.SinkhornState(errors=None, fu=None, gv=None, old_fus=None, old_mapped_fus=None)

Holds the state variables used to solve OT with Sinkhorn.

Methods

count(value, /)	Return number of occurrences of value.
ent_reg_cost(ot_prob, lse_mode)	param ot_prob:
index(value[, start, stop])	Return first index of value.
recenter(f, g, ot_prob)	Re-center dual potentials.
set(**kwargs)	Return a copy of self, with potential overwrites.
solution_error(ot_prob, norm_error, *, ...)	State dependent function to return error.

Attributes

errors	Alias for field number 0
fu	Alias for field number 1
gv	Alias for field number 2
old_fus	Alias for field number 3
old_mapped_fus	Alias for field number 4

Parameters:

• errors (Optional[Array]) –

• fu (Optional[Array]) –

• gv (Optional[Array]) –

• old_fus (Optional[Array]) –

• old_mapped_fus (Optional[Array]) –