Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

3.12.4. nistats.utils.full_rank

nistats.utils.full_rank(X, cmax=1000000000000000.0)

Computes the condition number of X and if it is larger than cmax, returns a matrix with a condition number smaller than cmax.

Parameters

Xarray of shape (nrows, ncols)

input array

cmaxfloat, optional (default:1.e15),

tolerance for condition number

Returns

Xarray of shape (nrows, ncols)

output array

condfloat,

actual condition number