check_stochastic_column.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_ERR_CHECK_STOCHASTIC_COLUMN_HPP
#define STAN_MATH_PRIM_ERR_CHECK_STOCHASTIC_COLUMN_HPP
 
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/err/check_nonzero_size.hpp>
#include <stan/math/prim/err/constraint_tolerance.hpp>
#include <stan/math/prim/err/make_iter_name.hpp>
#include <stan/math/prim/err/throw_domain_error.hpp>
#include <stan/math/prim/fun/to_ref.hpp>
#include <stan/math/prim/fun/value_of_rec.hpp>
#include <sstream>
#include <string>
#include <iostream>
namespace stan {
namespace math {
 
template <typename T, require_matrix_t<T>* = nullptr>
void check_stochastic_column(const char* function, const char* name,
                             const T& theta) {
  using std::fabs;
  check_nonzero_size(function, name, theta);
  auto&& theta_ref = to_ref(value_of_rec(theta));
  for (Eigen::Index j = 0; j < theta_ref.cols(); ++j) {
    value_type_t<decltype(theta_ref)> vec_sum = 0.0;
    for (Eigen::Index i = 0; i < theta_ref.rows(); ++i) {
      if (!(theta_ref.coeff(i, j) >= 0)) {
        [&]() STAN_COLD_PATH {
          std::ostringstream msg;
          msg << "is not a valid column stochastic matrix. " << name << "["
              << std::to_string(i + stan::error_index::value) << ", "
              << std::to_string(i + stan::error_index::value) << "]"
              << " = ";
          std::string msg_str(msg.str());
          throw_domain_error(function, name, theta_ref.coeff(i, j),
                             msg_str.c_str(),
                             ", but should be greater than or equal to 0");
        }();
      }
      vec_sum += theta_ref.coeff(i, j);
    }
    if (!(fabs(1.0 - vec_sum) <= CONSTRAINT_TOLERANCE)) {
      [&]() STAN_COLD_PATH {
        std::stringstream msg;
        msg << "is not a valid column stochastic matrix.";
        msg.precision(10);
        msg << " sum(" << name << "[:, " << std::to_string(j + 1)
            << "]) = " << vec_sum << ", but should be ";
        std::string msg_str(msg.str());
        throw_domain_error(function, name, 1.0, msg_str.c_str());
      }();
    }
  }
}
 
template <typename T, require_std_vector_t<T>* = nullptr>
void check_stochastic_column(const char* function, const char* name,
                             const T& theta) {
  for (size_t i = 0; i < theta.size(); ++i) {
    check_stochastic_column(function, internal::make_iter_name(name, i).c_str(),
                            theta[i]);
  }
}
 
}  // namespace math
}  // namespace stan
#endif