Stan  1.0
probability, sampling & optimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros Pages
multi_student_t.hpp
Go to the documentation of this file.
1 #ifndef __STAN__PROB__DISTRIBUTIONS__MULTI_STUDENT_T_HPP__
2 #define __STAN__PROB__DISTRIBUTIONS__MULTI_STUDENT_T_HPP__
3 
4 #include <cstdlib>
5 
6 #include <stan/prob/constants.hpp>
7 #include <stan/math/matrix_error_handling.hpp>
8 #include <stan/math/error_handling.hpp>
9 #include <stan/math/special_functions.hpp>
10 #include <stan/prob/traits.hpp>
11 #include <stan/prob/distributions/multivariate/continuous/multi_normal.hpp>
12 
13 namespace stan {
14 
15  namespace prob {
16 
23  template <bool propto,
24  typename T_y, typename T_dof, typename T_loc, typename T_scale,
25  class Policy>
26  typename boost::math::tools::promote_args<T_y,T_dof,T_loc,T_scale>::type
27  multi_student_t_log(const Eigen::Matrix<T_y,Eigen::Dynamic,1>& y,
28  const T_dof& nu,
29  const Eigen::Matrix<T_loc,Eigen::Dynamic,1>& mu,
30  const
31  Eigen::Matrix<T_scale,
32  Eigen::Dynamic,Eigen::Dynamic>& Sigma,
33  const Policy&) {
34  static const char* function = "stan::prob::multi_student_t(%1%)";
35 
36  using stan::math::check_size_match;
37  using stan::math::check_finite;
38  using stan::math::check_not_nan;
39  using stan::math::check_symmetric;
40  using stan::math::check_positive;
41  using boost::math::tools::promote_args;
42 
43  typename promote_args<T_y,T_dof,T_loc,T_scale>::type lp(0.0);
44  if (!check_size_match(function, y.size(), mu.size(), &lp, Policy()))
45  return lp;
46  if (!check_size_match(function, y.size(), Sigma.rows(), &lp, Policy()))
47  return lp;
48  if (!check_size_match(function, y.size(), Sigma.cols(), &lp, Policy()))
49  return lp;
50  if (!check_finite(function, mu, "Location parameter", &lp, Policy()))
51  return lp;
52  if (!check_not_nan(function, y, "Random variable", &lp, Policy()))
53  return lp;
54  if (!check_symmetric(function, Sigma, "Scale parameter", &lp, Policy()))
55  return lp;
56 
57  // allows infinities
58  if (!check_not_nan(function, nu,
59  "Degrees of freedom parameter", &lp,
60  Policy()))
61  return lp;
62  if (!check_positive(function, nu,
63  "Degrees of freedom parameter", &lp,
64  Policy()))
65  return lp;
66 
67  using std::isinf;
68 
69  if (isinf(nu)) // already checked nu > 0
70  return multi_normal_log(y,mu,Sigma,Policy());
71 
72  Eigen::LLT< Eigen::Matrix<T_scale,Eigen::Dynamic,Eigen::Dynamic> > LLT = Sigma.llt();
73  if (LLT.info() != Eigen::Success) {
74  lp = stan::math::policies::raise_domain_error<T_scale>(function,
75  "Sigma is not positive definite (%1%)",
76  0,Policy());
77  return lp;
78  }
79  Eigen::Matrix<T_scale,Eigen::Dynamic,Eigen::Dynamic> L = LLT.matrixL();
80 
81  double d = y.size();
82 
83  if (include_summand<propto,T_dof>::value) {
84  lp += lgamma(0.5 * (nu + d));
85  lp -= lgamma(0.5 * nu);
86  lp -= (0.5 * d) * log(nu);
87  }
88 
89  if (include_summand<propto>::value)
90  lp -= (0.5 * d) * LOG_PI;
91 
92  using stan::math::multiply;
93  using stan::math::dot_self;
94  using stan::math::subtract;
95  using Eigen::Array;
96  using stan::math::mdivide_left_tri;
97 
98 
99  if (include_summand<propto,T_scale>::value)
100  lp -= L.diagonal().array().log().sum();
101 
102  if (include_summand<propto,T_y,T_dof,T_loc,T_scale>::value) {
103 // Eigen::Matrix<T_scale,Eigen::Dynamic,Eigen::Dynamic> I(d,d);
104 // I.setIdentity();
105 
106  Eigen::Matrix<typename promote_args<T_y,T_loc>::type,
107  Eigen::Dynamic,
108  1> y_minus_mu = subtract(y,mu);
109  Eigen::Matrix<typename promote_args<T_scale,T_y,T_loc>::type,
110  Eigen::Dynamic,
111  1> half = L = mdivide_left_tri<Eigen::Lower>(L, y_minus_mu);
112  lp -= 0.5
113  * (nu + d)
114  * log(1.0 + dot_self(half) / nu);
115  }
116  return lp;
117  }
118 
119  template <bool propto,
120  typename T_y, typename T_dof, typename T_loc, typename T_scale>
121  inline
122  typename boost::math::tools::promote_args<T_y,T_dof,T_loc,T_scale>::type
123  multi_student_t_log(const Eigen::Matrix<T_y,Eigen::Dynamic,1>& y,
124  const T_dof& nu,
125  const Eigen::Matrix<T_loc,Eigen::Dynamic,1>& mu,
126  const
127  Eigen::Matrix<T_scale,
128  Eigen::Dynamic,Eigen::Dynamic>& Sigma) {
129  return multi_student_t_log<propto>(y,nu,mu,Sigma,
130  stan::math::default_policy());
131  }
132 
133  template <typename T_y, typename T_dof, typename T_loc, typename T_scale,
134  class Policy>
135  inline
136  typename boost::math::tools::promote_args<T_y,T_dof,T_loc,T_scale>::type
137  multi_student_t_log(const Eigen::Matrix<T_y,Eigen::Dynamic,1>& y,
138  const T_dof& nu,
139  const Eigen::Matrix<T_loc,Eigen::Dynamic,1>& mu,
140  const
141  Eigen::Matrix<T_scale,
142  Eigen::Dynamic,Eigen::Dynamic>& Sigma,
143  const Policy&) {
144  return multi_student_t_log<false>(y,nu,mu,Sigma,Policy());
145  }
146 
147 
148 
149  template <typename T_y, typename T_dof, typename T_loc, typename T_scale>
150  inline
151  typename boost::math::tools::promote_args<T_y,T_dof,T_loc,T_scale>::type
152  multi_student_t_log(const Eigen::Matrix<T_y,Eigen::Dynamic,1>& y,
153  const T_dof& nu,
154  const Eigen::Matrix<T_loc,Eigen::Dynamic,1>& mu,
155  const
156  Eigen::Matrix<T_scale,
157  Eigen::Dynamic,Eigen::Dynamic>& Sigma) {
158  return multi_student_t_log<false>(y,nu,mu,Sigma,
159  stan::math::default_policy());
160  }
161 
162 
163 
164  }
165 }
166 #endif
     [ Stan Home Page ] © 2011–2012, Stan Development Team.