Automatic Differentiation
 
Loading...
Searching...
No Matches

◆ check_greater_or_equal() [1/3]

template<typename T_y , typename T_low , require_all_stan_scalar_t< T_y, 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 low.

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

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

Template Parameters
T_yA scalar type
T_lowA scalar type
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
lowLower bound
idxsPack 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_yType 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_lowType 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
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
lowLower bound
idxsPack 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 36 of file check_greater_or_equal.hpp.