check_sorted.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_ERR_CHECK_SORTED_HPP
#define STAN_MATH_PRIM_ERR_CHECK_SORTED_HPP
 
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/err/throw_domain_error.hpp>
#include <stan/math/prim/fun/to_ref.hpp>
#include <sstream>
#include <string>
#include <vector>
 
namespace stan {
namespace math {
 
template <typename EigVec, require_eigen_vector_t<EigVec>* = nullptr>
inline void check_sorted(const char* function, const char* name,
                         const EigVec& y) {
  const auto& y_ref = to_ref(y);
  for (Eigen::Index n = 1; n < y_ref.size(); n++) {
    if (!(y_ref[n] >= y_ref[n - 1])) {
      std::ostringstream msg1;
      msg1 << "is not a valid sorted vector."
           << " The element at " << stan::error_index::value + n << " is ";
      std::string msg1_str(msg1.str());
      std::ostringstream msg2;
      msg2 << ", but should be greater than or equal to the previous element, "
           << y_ref[n - 1];
      std::string msg2_str(msg2.str());
      throw_domain_error(function, name, y_ref[n], msg1_str.c_str(),
                         msg2_str.c_str());
    }
  }
}
 
template <typename T_y>
inline void check_sorted(const char* function, const char* name,
                         const std::vector<T_y>& y) {
  for (size_t n = 1; n < y.size(); n++) {
    if (!(y[n] >= y[n - 1])) {
      std::ostringstream msg1;
      msg1 << "is not a valid sorted vector."
           << " The element at " << stan::error_index::value + n << " is ";
      std::string msg1_str(msg1.str());
      std::ostringstream msg2;
      msg2 << ", but should be greater than or equal to the previous element, "
           << y[n - 1];
      std::string msg2_str(msg2.str());
      throw_domain_error(function, name, y[n], msg1_str.c_str(),
                         msg2_str.c_str());
    }
  }
}
 
}  // namespace math
}  // namespace stan
#endif