ott.solvers.linear.continuous_barycenter.FreeBarycenterState

class ott.solvers.linear.continuous_barycenter.FreeBarycenterState(x, a, costs=None, linear_convergence=None, linear_outputs=None, errors=None)

Holds the state of the Wasserstein barycenter solver.

Parameters:

• x (Array) – Barycenter points.

• a (Array) – Barycenter weights.

• costs (Optional[Array]) – Holds the sequence of regularized costs seen through the outer loop of the solver.

• linear_convergence (Optional[Array]) – Holds the sequence of bool convergence flags of the inner Sinkhorn iterations.

• linear_outputs (Union[SinkhornOutput, LRSinkhornOutput, None]) – Holds latest output objects returned by linear solver when recomputing transport between barycenter vs. each of the input measures.

• errors (Optional[Array]) – Holds sequence of vectors of errors of the Sinkhorn algorithm at each iteration.

Methods

count(value, /)	Return number of occurrences of value.
index(value[, start, stop])	Return first index of value.
set(**kwargs)	Return a copy of self, possibly with overwrites.
update(iteration, bar_prob, linear_solver, ...)	Update the state of the solver.

Attributes

a	Alias for field number 1
costs	Alias for field number 2
errors	Alias for field number 5
linear_convergence	Alias for field number 3
linear_outputs	Alias for field number 4
x	Alias for field number 0