check_cholesky_factor_corr() [1/2]

template<typename Mat , require_matrix_t< Mat > * = nullptr>

void stan::math::check_cholesky_factor_corr	(	const char *	function,
		const char *	name,
		const Mat &	y
	)

Throw an exception if the specified matrix is not a valid Cholesky factor of a correlation matrix.

A Cholesky factor is a lower triangular matrix whose diagonal elements are all positive and each row has unit Euclidean length. Note that Cholesky factors need not be square, but require at least as many rows M as columns N (i.e., M >= N). Tolerance is specified by math::CONSTRAINT_TOLERANCE. Tolerance is specified by math::CONSTRAINT_TOLERANCE.

Template Parameters

Mat	Type inheriting from MatrixBase with neither rows or columns defined at compile time to be equal to 1 or a var_value with the var's inner type inheriting from Eigen::MatrixBase with neither rows or columns defined at compile time to be equal to 1

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Matrix to test

Exceptions

`std::domain_error`

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

Definition at line 37 of file check_cholesky_factor_corr.hpp.