check_bounded.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_ERR_CHECK_BOUNDED_HPP
#define STAN_MATH_PRIM_ERR_CHECK_BOUNDED_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/err/throw_domain_error.hpp>
#include <stan/math/prim/err/throw_domain_error_vec.hpp>
#include <stan/math/prim/fun/get.hpp>
#include <stan/math/prim/fun/max_size.hpp>
#include <stan/math/prim/fun/scalar_seq_view.hpp>
#include <stan/math/prim/fun/size.hpp>
#include <stan/math/prim/fun/size_zero.hpp>
#include <string>
 
namespace stan {
namespace math {
 
namespace internal {
 
// implemented using structs because there is no partial specialization
// for templated functions
// default implementation works for scalar T_y. T_low and T_high can
// be either scalar or vector
// throws if y, low, or high is nan
template <typename T_y, typename T_low, typename T_high, bool y_is_vec>
struct bounded {
  static void check(const char* function, const char* name, const T_y& y,
                    const T_low& low, const T_high& high) {
    scalar_seq_view<T_low> low_vec(low);
    scalar_seq_view<T_high> high_vec(high);
    for (size_t n = 0; n < max_size(low, high); n++) {
      if (!(low_vec[n] <= y && y <= high_vec[n])) {
        std::stringstream msg;
        msg << ", but must be in the interval ";
        msg << "[" << low_vec[n] << ", " << high_vec[n] << "]";
        std::string msg_str(msg.str());
        throw_domain_error(function, name, y, "is ", msg_str.c_str());
      }
    }
  }
};
 
template <typename T_y, typename T_low, typename T_high>
struct bounded<T_y, T_low, T_high, true> {
  static void check(const char* function, const char* name, const T_y& y,
                    const T_low& low, const T_high& high) {
    scalar_seq_view<T_low> low_vec(low);
    scalar_seq_view<T_high> high_vec(high);
    for (size_t n = 0; n < stan::math::size(y); n++) {
      if (!(low_vec[n] <= stan::get(y, n) && stan::get(y, n) <= high_vec[n])) {
        std::stringstream msg;
        msg << ", but must be in the interval ";
        msg << "[" << low_vec[n] << ", " << high_vec[n] << "]";
        std::string msg_str(msg.str());
        throw_domain_error_vec(function, name, y, n, "is ", msg_str.c_str());
      }
    }
  }
};
}  // namespace internal
 
template <typename T_y, typename T_low, typename T_high>
inline void check_bounded(const char* function, const char* name, const T_y& y,
                          const T_low& low, const T_high& high) {
  if (size_zero(y, low, high)) {
    return;
  }
  internal::bounded<T_y, T_low, T_high, is_vector_like<T_y>::value>::check(
      function, name, y, low, high);
}
 
}  // namespace math
}  // namespace stan
#endif