Stan Math Library  2.8.0
reverse mode automatic differentiation
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros Groups
check_corr_matrix.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_MAT_ERR_CHECK_CORR_MATRIX_HPP
2 #define STAN_MATH_PRIM_MAT_ERR_CHECK_CORR_MATRIX_HPP
3 
13 #include <sstream>
14 #include <string>
15 
16 namespace stan {
17 
18  namespace math {
19  using Eigen::Dynamic;
44  template <typename T_y>
45  inline bool
46  check_corr_matrix(const char* function,
47  const char* name,
48  const Eigen::Matrix<T_y, Dynamic, Dynamic>& y) {
49  using Eigen::Matrix;
51 
52  typedef typename index_type<Matrix<T_y, Dynamic, Dynamic> >::type size_t;
53 
54  check_size_match(function,
55  "Rows of correlation matrix", y.rows(),
56  "columns of correlation matrix", y.cols());
57  check_positive_size(function, name, "rows", y.rows());
58  check_symmetric(function, "y", y);
59 
60  for (size_t k = 0; k < y.rows(); ++k) {
61  if (!(fabs(y(k, k) - 1.0) <= CONSTRAINT_TOLERANCE)) {
62  std::ostringstream msg;
63  msg << "is not a valid correlation matrix. "
64  << name << "(" << stan::error_index::value + k
65  << "," << stan::error_index::value + k
66  << ") is ";
67  std::string msg_str(msg.str());
68  domain_error(function, name, y(k, k),
69  msg_str.c_str(),
70  ", but should be near 1.0");
71  return false;
72  }
73  }
74  stan::math::check_pos_definite(function, "y", y);
75  return true;
76  }
77 
78  }
79 }
80 #endif
fvar< T > fabs(const fvar< T > &x)
Definition: fabs.hpp:14
bool check_positive_size(const char *function, const char *name, const char *expr, const int size)
Return true if size is positive.
bool check_symmetric(const char *function, const char *name, const Eigen::Matrix< T_y, Dynamic, Dynamic > &y)
Return true if the specified matrix is symmetric.
const double CONSTRAINT_TOLERANCE
The tolerance for checking arithmetic bounds In rank and in simplexes.
bool check_pos_definite(const char *function, const char *name, const Eigen::Matrix< T_y, Dynamic, Dynamic > &y)
Return true if the specified square, symmetric matrix is positive definite.
Primary template class for the metaprogram to compute the index type of a container.
Definition: index_type.hpp:19
bool check_size_match(const char *function, const char *name_i, T_size1 i, const char *name_j, T_size2 j)
Return true if the provided sizes match.
void domain_error(const char *function, const char *name, const T &y, const char *msg1, const char *msg2)
Throw a domain error with a consistently formatted message.
bool check_corr_matrix(const char *function, const char *name, const Eigen::Matrix< T_y, Dynamic, Dynamic > &y)
Return true if the specified matrix is a valid correlation matrix.

     [ Stan Home Page ] © 2011–2015, Stan Development Team.