is_cholesky_factor()

template<typename EigMat , require_eigen_matrix_dynamic_t< EigMat > * = nullptr>

bool stan::math::is_cholesky_factor ( const EigMat &  y )

inline

Return true if y is a valid Cholesky factor, if number of rows is not less than the number of columns, if there are no 0 columns, and no element in matrix is NaN.

A Cholesky factor is a lower triangular matrix whose diagonal elements are all positive. Note that Cholesky factors need not be square, but require at least as many rows M as columns N (i.e., M >= N).

Template Parameters

EigMat

A type derived from EigenBase with dynamic rows and columns

Parameters

y	Matrix to test

Returns

true if y is a valid Cholesky factor, if number of rows is not less than the number of columns, if there are no 0 columns, and no element in matrix is NaN

Definition at line 29 of file is_cholesky_factor.hpp.