moscot.base.output.BaseDiscreteSolverOutput.pull¶

BaseDiscreteSolverOutput.pull(x, scale_by_marginals=False)[source]¶

Pull mass through the transport_matrix.

It is equivalent to \(T x\) but without instantiating the transport matrix \(T\), if possible.

Parameters:

x (Union[ndarray[tuple[int, ...], dtype[floating]], Array]) – Array of shape [m,] or [m, d] to pull.
scale_by_marginals (bool) – Whether to scale by the target marginals b.

Return type:

Returns:

: Array of shape [n,] or [n, d], depending on the shape of x.