moscot.base.output.MatrixSolverOutput.pull#

MatrixSolverOutput.pull(x, scale_by_marginals=False)#

Pull mass through the transport_matrix.

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

Parameters:
  • x (ndarray[Any, dtype[float64]]) – Array of shape [m,] or [m, d] to pull.

  • scale_by_marginals (bool) – Whether to scale by the target marginals b.

Return type:

ndarray[Any, dtype[float64]]

Returns:

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