check_cholesky_factor_corr.hpp

Go to the documentation of this file.

#ifndef STAN__MATH__ERROR_HANDLING__MATRIX__CHECK_CHOLESKY_FACTOR_CORR_HPP
#define STAN__MATH__ERROR_HANDLING__MATRIX__CHECK_CHOLESKY_FACTOR_CORR_HPP

#include <stan/math/matrix/Eigen.hpp>
#include <stan/math/error_handling/check_positive.hpp>
#include <stan/math/error_handling/matrix/check_lower_triangular.hpp>
#include <stan/math/error_handling/matrix/check_square.hpp>
#include <stan/math/error_handling/matrix/constraint_tolerance.hpp>
#include <stan/math/error_handling/matrix/check_unit_vector.hpp>

namespace stan {

  namespace math {

    template <typename T_y, typename T_result>
    bool check_cholesky_factor_corr(const char* function,
                    const Eigen::Matrix<T_y,Eigen::Dynamic,Eigen::Dynamic>& y,
                    const char* name,
                    T_result* result) {
      if (!check_square(function,y,name,result))
        return false;
      if (!check_lower_triangular(function,y,name,result))
        return false;
      for (int i = 0; i < y.rows(); ++i)
        if (!check_positive(function, y(i,i), name, result))
          return false;
      for (int i = 0; i < y.rows(); ++i) {
        Eigen::Matrix<T_y,Eigen::Dynamic,1> y_i = y.row(i).transpose();
        if (!check_unit_vector(function, y_i, name, result))
          return false;
      }
      return true;
    }

    template <typename T>
    inline bool check_cholesky_factor_corr(const char* function,
                      const Eigen::Matrix<T,Eigen::Dynamic,Eigen::Dynamic>& y,
                      const char* name,
                      T* result = 0) {
      return check_cholesky_factor_corr<T,T>(function,y,name,result);
    }


    template <typename T_y, typename T_result>
    inline bool check_cholesky_factor_corr(const char* function,
                    const Eigen::Matrix<T_y,Eigen::Dynamic,Eigen::Dynamic>& y,
                    T_result* result) {
      return check_cholesky_factor_corr(function,y,"(internal variable)",
                                        result);
    }

    template <typename T>
    inline bool check_cholesky_factor_corr(const char* function,
                    const Eigen::Matrix<T,Eigen::Dynamic,Eigen::Dynamic>& y,
                    T* result = 0) {
      return check_cholesky_factor_corr<T,T>(function,y,result);
    }

  }
}
#endif