check_vector_index.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_ERR_CHECK_VECTOR_INDEX_HPP
#define STAN_MATH_PRIM_ERR_CHECK_VECTOR_INDEX_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/err/out_of_range.hpp>
#include <stan/math/prim/fun/Eigen.hpp>
#include <sstream>
#include <string>
 
namespace stan {
namespace math {
 
template <
    typename T,
    require_any_t<is_vector<T>, is_prim_or_rev_kernel_expression<T>>* = nullptr>
inline void check_vector_index(const char* function, const char* name,
                               const T& y, size_t i) {
  STAN_NO_RANGE_CHECKS_RETURN;
  if (!(i >= stan::error_index::value
        && i < static_cast<size_t>(y.size()) + stan::error_index::value)) {
    [&]() STAN_COLD_PATH {
      std::stringstream msg;
      msg << " for size of " << name;
      std::string msg_str(msg.str());
      out_of_range(function, y.rows(), i, msg_str.c_str());
    }();
  }
}
 
}  // namespace math
}  // namespace stan
#endif