bundles / scipy latest / scipy / stats / _multivariate / random_correlation_frozen / __init__
function
scipy.stats._multivariate:random_correlation_frozen.__init__
Signature
def __init__ ( self , eigs , seed = None , tol = 1e-13 , diag_tol = 1e-07 ) Summary
Create a frozen random correlation matrix distribution.
Parameters
eigs: 1d ndarrayEigenvalues of correlation matrix
seed: {None, int, `numpy.random.Generator`, `numpy.random.RandomState`}, optionalIf
seedis None (ornp.random), the numpy.random.RandomState singleton is used. Ifseedis an int, a newRandomStateinstance is used, seeded withseed. Ifseedis already aGeneratororRandomStateinstance then that instance is used.tol: float, optionalTolerance for input parameter checks
diag_tol: float, optionalTolerance for deviation of the diagonal of the resulting matrix. Default: 1e-7
Returns
rvs: ndarray or scalarRandom size N-dimensional matrices, dimension (size, dim, dim), each having eigenvalues eigs.
Raises
: RuntimeErrorFloating point error prevented generating a valid correlation matrix.
Aliases
-
scipy.stats._multivariate.random_correlation_frozen.__init__