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

◆ check_less() [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 ( const char *  function,
const char *  name,
const T_y &  y,
const T_high &  high,
Idxs...  idxs 
)
inline

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

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

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

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

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

Template Parameters
T_yA scalar type
T_highType 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
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`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_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_highA scalar type
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`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_yA 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_highA 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.
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`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_yA standard vector type with a value_type of a standard vector or type inheriting from Eigen::DenseBase
T_highA scalar type or the same type as the inner type of T_high
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`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_yA scalar type or the same type as the inner type of T_high
T_highA standard vector type with a value_type of a standard vector or type inheriting from Eigen::DenseBase
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`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_yA standard vector type whose value_type is a scalar, type inheriting from Eigen::DenseBase, or another standard vector
T_highA standard vector type whose value_type is a scalar, type inheriting from Eigen::DenseBase, or another standard vector
IdxsA parameter pack of Integral types
Parameters
functionFunction name (for error messages)
nameVariable name (for error messages)
yVariable to check
highUpper bound
idxsPack of integral types to construct lazily construct the error message indices
Exceptions
`domain_error`if y is not less than high or if any element of y or high is NaN

Definition at line 107 of file check_less.hpp.