torch.linalg.lu_factor_ex

torch.linalg.lu_factor_ex(A, *, pivot=True, check_errors=False, out=None)

This is a version of lu_factor() that does not perform error checks unless check_errors= True. It also returns the info tensor returned by LAPACK’s getrf.

Note

When the inputs are on a CUDA device, this function synchronizes only when check_errors= True.

Warning

This function is “experimental” and it may change in a future PyTorch release.

Parameters:

A (Tensor) – tensor of shape (*, m, n) where * is zero or more batch dimensions.

Keyword Arguments:

• pivot (bool, optional) – Whether to compute the LU decomposition with partial pivoting, or the regular LU decomposition. pivot= False not supported on CPU. Default: True.

• check_errors (bool, optional) – controls whether to check the content of infos and raise an error if it is non-zero. Default: False.

• out (tuple, optional) – tuple of three tensors to write the output to. Ignored if None. Default: None.

Returns:

A named tuple (LU, pivots, info).