check_lower_triangular()

template<typename T_y , require_eigen_t< T_y > * = nullptr>

void stan::math::check_lower_triangular ( const char *  function, const char *  name, const T_y &  y  )

inline

Check if the specified matrix is lower triangular.

A matrix x is not lower triangular if there is a non-zero entry x[m, n] with m < n. This function only inspects the upper triangular portion of the matrix, not including the diagonal.

Template Parameters

T	Type of the matrix

Parameters

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

Exceptions

<code>std::domain_error</code>

if the matrix is not lower triangular or if any element in the upper triangular portion is NaN

Definition at line 27 of file check_lower_triangular.hpp.