check_greater_or_equal() [3/3]

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

void stan::math::check_greater_or_equal ( const char *  function, const char *  name, const T_y &  y, const T_low &  low, Idxs...  idxs  )

inline

Throw an exception if y is not greater or equal than each element of low.

Throw an exception if each element of y is not greater or equal than the associated element in low.

Throw an exception if each element of y is not greater or equal than low.

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

Template Parameters

T_y	A scalar type
T_low	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
low	Lower bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

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

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_low	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
low	Lower bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

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

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_low	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
low	Lower bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

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

Template Parameters

T_y	A standard vector type with a value_type of a standard vector or type inheriting from Eigen::DenseBase
T_low	A standard vector 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
low	Lower bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

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

Template Parameters

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

Parameters

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

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

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

Template Parameters

T_y	A standard vector type
T_low	A standard vector 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
low	Lower bound
idxs	Pack of integral types to construct lazily construct the error message indices

Exceptions

`std::domain_error`

if y is not greater or equal to low or if any element of y or low is NaN

Definition at line 112 of file check_greater_or_equal.hpp.