check_range() [1/3]

void stan::math::check_range ( const char *  function, const char *  name, int  max, int  index, int  nested_level, const char *  error_msg  )

inline

Check if specified index is within range.

This check is 1-indexed by default. This behavior can be changed by setting stan::error_index::value.

Parameters

function	Function name (for error messages)
name	Variable name (for error messages)
max	Maximum size of the variable
index	Index to check
nested_level	Nested level (for error messages)
error_msg	Additional error message (for error messages)

Exceptions

<code>std::out_of_range</code>

if the index is not in range

Definition at line 24 of file check_range.hpp.