check_less_or_equal() [3/3]

template<typename T_y , typename T_high , require_stan_scalar_t< T_y > * = nullptr, require_dense_dynamic_t< T_high > * = nullptr, typename... Idxs>

void stan::math::check_less_or_equal ( const char *  function, const char *  name, const T_y &  y, const T_high &  high, Idxs...  idxs  )

inline

Throw an exception if y is not less than each element of high.

Throw an exception if each element of y is not less than each associated element of high.

Throw an exception if each element of y is not less than the associated element of high.

Throw an exception if each element of y is not less than high.

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	A scalar type
T_high	Type inheriting from Eigen::DenseBase or a var_value with the var's inner type inheriting from Eigen::DenseBase where the compile time number of rows or columns is not equal to one
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	Type inheriting from Eigen::DenseBase or a var_value with the var's inner type inheriting from Eigen::DenseBase where the compile time number of rows or columns is not equal to one
T_high	A scalar type
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	A standard vector or type inheriting from Eigen::DenseBase with compile time rows or columns equal to one and value_type equal to a stan scalar.
T_high	A standard vector or type inheriting from Eigen::DenseBase with compile time rows or columns equal to one and value_type equal to a stan scalar.
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	A standard vector type with a value_type of a standard vector or type inheriting from Eigen::DenseBase
T_high	A scalar or the same value_type of T_y
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	A scalar type or the same value_type of T_high
T_high	A standard vector type with a value_type of a standard vector or type inheriting from Eigen::DenseBase
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

This function is vectorized and will check each element of y against each element of high.

Template Parameters

T_y	A standard vector type whose value_type is a scalar, type inheriting from Eigen::EigenBase, or another standard vector
T_high	A standard vector type whose value_type is a scalar, type inheriting from Eigen::EigenBase, or another standard vector
Idxs	A parameter pack of Integral types

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
y	Variable to check
high	Upper bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not less than high or if any element of y or high is NaN

Definition at line 112 of file check_less_or_equal.hpp.