| Stan Math Library 2.6.3 probability, sampling & optimization

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros
student_t_cdf_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_STUDENT_T_CDF_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_STUDENT_T_CDF_LOG_HPP
3
4 #include <boost/random/student_t_distribution.hpp>
5 #include <boost/random/variate_generator.hpp>
6 #include <stan/math/prim/scal/meta/OperandsAndPartials.hpp>
7 #include <stan/math/prim/scal/err/check_consistent_sizes.hpp>
8 #include <stan/math/prim/scal/err/check_finite.hpp>
9 #include <stan/math/prim/scal/err/check_not_nan.hpp>
10 #include <stan/math/prim/scal/err/check_positive_finite.hpp>
11 #include <stan/math/prim/scal/fun/constants.hpp>
12 #include <stan/math/prim/scal/fun/square.hpp>
13 #include <stan/math/prim/scal/fun/value_of.hpp>
14 #include <stan/math/prim/scal/fun/lbeta.hpp>
15 #include <stan/math/prim/scal/fun/lgamma.hpp>
16 #include <stan/math/prim/scal/fun/digamma.hpp>
17 #include <stan/math/prim/scal/meta/length.hpp>
18 #include <stan/math/prim/scal/fun/grad_reg_inc_beta.hpp>
19 #include <stan/math/prim/scal/fun/inc_beta.hpp>
20 #include <stan/math/prim/scal/meta/include_summand.hpp>
21 #include <stan/math/prim/scal/meta/VectorBuilder.hpp>
22 #include <limits>
23 #include <cmath>
24
25 namespace stan {
26
27 namespace math {
28
29 template <typename T_y, typename T_dof, typename T_loc, typename T_scale>
30 typename return_type<T_y, T_dof, T_loc, T_scale>::type
31 student_t_cdf_log(const T_y& y, const T_dof& nu, const T_loc& mu,
32 const T_scale& sigma) {
33 typedef typename
34 stan::partials_return_type<T_y, T_dof, T_loc, T_scale>::type
35 T_partials_return;
36
37 // Size checks
38 if (!(stan::length(y) && stan::length(nu) && stan::length(mu)
39 && stan::length(sigma)))
40 return 0.0;
41
42 static const char* function("stan::math::student_t_cdf_log");
43
44 using stan::math::check_positive_finite;
45 using stan::math::check_finite;
46 using stan::math::check_not_nan;
47 using stan::math::check_consistent_sizes;
48 using stan::math::value_of;
49 using std::exp;
50
51 T_partials_return P(0.0);
52
53 check_not_nan(function, "Random variable", y);
54 check_positive_finite(function, "Degrees of freedom parameter", nu);
55 check_finite(function, "Location parameter", mu);
56 check_positive_finite(function, "Scale parameter", sigma);
57
58 // Wrap arguments in vectors
59 VectorView<const T_y> y_vec(y);
60 VectorView<const T_dof> nu_vec(nu);
61 VectorView<const T_loc> mu_vec(mu);
62 VectorView<const T_scale> sigma_vec(sigma);
63 size_t N = max_size(y, nu, mu, sigma);
64
65 OperandsAndPartials<T_y, T_dof, T_loc, T_scale>
66 operands_and_partials(y, nu, mu, sigma);
67
68 // Explicit return for extreme values
69 // The gradients are technically ill-defined, but treated as zero
70 for (size_t i = 0; i < stan::length(y); i++) {
71 if (value_of(y_vec[i]) == -std::numeric_limits<double>::infinity())
72 return operands_and_partials.to_var(stan::math::negative_infinity(),
73 y, nu, mu, sigma);
74 }
75
76 using stan::math::digamma;
77 using stan::math::lbeta;
78 using stan::math::inc_beta;
79 using std::pow;
80 using std::exp;
81 using std::log;
82
83 // Cache a few expensive function calls if nu is a parameter
84 T_partials_return digammaHalf = 0;
85
86 VectorBuilder<!is_constant_struct<T_dof>::value,
87 T_partials_return, T_dof>
88 digamma_vec(stan::length(nu));
89 VectorBuilder<!is_constant_struct<T_dof>::value,
90 T_partials_return, T_dof>
91 digammaNu_vec(stan::length(nu));
92 VectorBuilder<!is_constant_struct<T_dof>::value,
93 T_partials_return, T_dof>
94 digammaNuPlusHalf_vec(stan::length(nu));
95
96 if (!is_constant_struct<T_dof>::value) {
97 digammaHalf = digamma(0.5);
98
99 for (size_t i = 0; i < stan::length(nu); i++) {
100 const T_partials_return nu_dbl = value_of(nu_vec[i]);
101
102 digammaNu_vec[i] = digamma(0.5 * nu_dbl);
103 digammaNuPlusHalf_vec[i] = digamma(0.5 + 0.5 * nu_dbl);
104 }
105 }
106
107 // Compute vectorized cdf_log and gradient
108 for (size_t n = 0; n < N; n++) {
109 // Explicit results for extreme values
110 // The gradients are technically ill-defined, but treated as zero
111 if (value_of(y_vec[n]) == std::numeric_limits<double>::infinity()) {
112 continue;
113 }
114
115 const T_partials_return sigma_inv = 1.0 / value_of(sigma_vec[n]);
116 const T_partials_return t = (value_of(y_vec[n]) - value_of(mu_vec[n]))
117 * sigma_inv;
118 const T_partials_return nu_dbl = value_of(nu_vec[n]);
119 const T_partials_return q = nu_dbl / (t * t);
120 const T_partials_return r = 1.0 / (1.0 + q);
121 const T_partials_return J = 2 * r * r * q / t;
122 const T_partials_return betaNuHalf = exp(lbeta(0.5, 0.5 * nu_dbl));
123 T_partials_return zJacobian = t > 0 ? - 0.5 : 0.5;
124
125 if (q < 2) {
126 T_partials_return z
127 = inc_beta(0.5 * nu_dbl, (T_partials_return)0.5, 1.0 - r);
128 const T_partials_return Pn = t > 0 ? 1.0 - 0.5 * z : 0.5 * z;
129 const T_partials_return d_ibeta = pow(r, -0.5)
130 * pow(1.0 - r, 0.5*nu_dbl - 1) / betaNuHalf;
131
132 P += log(Pn);
133
134 if (!is_constant_struct<T_y>::value)
135 operands_and_partials.d_x1[n]
136 += - zJacobian * d_ibeta * J * sigma_inv / Pn;
137
138 if (!is_constant_struct<T_dof>::value) {
139 T_partials_return g1 = 0;
140 T_partials_return g2 = 0;
141
142 stan::math::grad_reg_inc_beta(g1, g2, 0.5 * nu_dbl,
143 (T_partials_return)0.5, 1.0 - r,
144 digammaNu_vec[n], digammaHalf,
145 digammaNuPlusHalf_vec[n],
146 betaNuHalf);
147
148 operands_and_partials.d_x2[n]
149 += zJacobian * (d_ibeta * (r / t) * (r / t) + 0.5 * g1) / Pn;
150 }
151
152 if (!is_constant_struct<T_loc>::value)
153 operands_and_partials.d_x3[n]
154 += zJacobian * d_ibeta * J * sigma_inv / Pn;
155 if (!is_constant_struct<T_scale>::value)
156 operands_and_partials.d_x4[n]
157 += zJacobian * d_ibeta * J * sigma_inv * t / Pn;
158
159 } else {
160 T_partials_return z = 1.0 - inc_beta((T_partials_return)0.5,
161 0.5*nu_dbl, r);
162 zJacobian *= -1;
163
164 const T_partials_return Pn = t > 0 ? 1.0 - 0.5 * z : 0.5 * z;
165
166 T_partials_return d_ibeta = pow(1.0-r, 0.5*nu_dbl-1) * pow(r, -0.5)
167 / betaNuHalf;
168
169 P += log(Pn);
170
171 if (!is_constant_struct<T_y>::value)
172 operands_and_partials.d_x1[n]
173 += zJacobian * d_ibeta * J * sigma_inv / Pn;
174
175 if (!is_constant_struct<T_dof>::value) {
176 T_partials_return g1 = 0;
177 T_partials_return g2 = 0;
178
179 stan::math::grad_reg_inc_beta(g1, g2, (T_partials_return)0.5,
180 0.5 * nu_dbl, r,
181 digammaHalf, digammaNu_vec[n],
182 digammaNuPlusHalf_vec[n],
183 betaNuHalf);
184
185 operands_and_partials.d_x2[n]
186 += zJacobian * (- d_ibeta * (r / t) * (r / t) + 0.5 * g2) / Pn;
187 }
188
189 if (!is_constant_struct<T_loc>::value)
190 operands_and_partials.d_x3[n]
191 += - zJacobian * d_ibeta * J * sigma_inv / Pn;
192 if (!is_constant_struct<T_scale>::value)
193 operands_and_partials.d_x4[n]
194 += - zJacobian * d_ibeta * J * sigma_inv * t / Pn;
195 }
196 }
197
198 return operands_and_partials.to_var(P, y, nu, mu, sigma);
199 }
200 }
201 }
202 #endif
check_not_nan.hpp
lgamma.hpp
stan::math::check_not_nan
bool check_not_nan(const char *function, const char *name, const T_y &y)
Return true if y is not NaN.
Definition: check_not_nan.hpp:63
check_positive_finite.hpp
stan::math::value_of
T value_of(const fvar< T > &v)
Return the value of the specified variable.
Definition: value_of.hpp:16
stan::math::lbeta
fvar< T > lbeta(const fvar< T > &x1, const fvar< T > &x2)
Definition: lbeta.hpp:16
digamma.hpp
stan::math::log
fvar< T > log(const fvar< T > &x)
Definition: log.hpp:15
square.hpp
stan::length
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
stan::math::OperandsAndPartials::to_var
T_return_type to_var(T_partials_return logp, const T1 &x1=0, const T2 &x2=0, const T3 &x3=0, const T4 &x4=0, const T5 &x5=0, const T6 &x6=0)
Definition: OperandsAndPartials.hpp:322
stan::math::student_t_cdf_log
return_type< T_y, T_dof, T_loc, T_scale >::type student_t_cdf_log(const T_y &y, const T_dof &nu, const T_loc &mu, const T_scale &sigma)
Definition: student_t_cdf_log.hpp:31
include_summand.hpp
stan::math::OperandsAndPartials::d_x1
VectorView< T_partials_return, is_vector< T1 >::value, is_constant_struct< T1 >::value > d_x1
Definition: OperandsAndPartials.hpp:253
stan::is_constant_struct
Metaprogram to determine if a type has a base scalar type that can be assigned to type double...
Definition: is_constant_struct.hpp:16
stan::math::inc_beta
fvar< T > inc_beta(const fvar< T > &a, const fvar< T > &b, const fvar< T > &x)
Definition: inc_beta.hpp:20
stan::math::exp
fvar< T > exp(const fvar< T > &x)
Definition: exp.hpp:10
stan::math::OperandsAndPartials::d_x3
VectorView< T_partials_return, is_vector< T3 >::value, is_constant_struct< T3 >::value > d_x3
Definition: OperandsAndPartials.hpp:259
stan::math::OperandsAndPartials::d_x4
VectorView< T_partials_return, is_vector< T4 >::value, is_constant_struct< T4 >::value > d_x4
Definition: OperandsAndPartials.hpp:262
stan::math::OperandsAndPartials
A variable implementation that stores operands and derivatives with respect to the variable...
Definition: OperandsAndPartials.hpp:238
OperandsAndPartials.hpp
stan::max_size
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
VectorBuilder.hpp
length.hpp
grad_reg_inc_beta.hpp
stan::math::check_finite
bool check_finite(const char *function, const char *name, const T_y &y)
Return true if y is finite.
Definition: check_finite.hpp:62
stan::VectorBuilder
Definition: VectorBuilder.hpp:61
constants.hpp
stan::math::check_consistent_sizes
bool check_consistent_sizes(const char *function, const char *name1, const T1 &x1, const char *name2, const T2 &x2)
Return true if the dimension of x1 is consistent with x2.
Definition: check_consistent_sizes.hpp:31
check_finite.hpp
lbeta.hpp
stan::math::OperandsAndPartials::d_x2
VectorView< T_partials_return, is_vector< T2 >::value, is_constant_struct< T2 >::value > d_x2
Definition: OperandsAndPartials.hpp:256
inc_beta.hpp
stan::math::pow
fvar< T > pow(const fvar< T > &x1, const fvar< T > &x2)
Definition: pow.hpp:18
value_of.hpp
stan::VectorView
VectorView is a template metaprogram that takes its argument and allows it to be used like a vector...
Definition: VectorView.hpp:41
stan::partials_return_type::type
boost::math::tools::promote_args< typename partials_type< typename scalar_type< T1 >::type >::type, typename partials_type< typename scalar_type< T2 >::type >::type, typename partials_type< typename scalar_type< T3 >::type >::type, typename partials_type< typename scalar_type< T4 >::type >::type, typename partials_type< typename scalar_type< T5 >::type >::type, typename partials_type< typename scalar_type< T6 >::type >::type >::type type
Definition: partials_return_type.hpp:26
stan::math::grad_reg_inc_beta
void grad_reg_inc_beta(T &g1, T &g2, T a, T b, T z, T digammaA, T digammaB, T digammaSum, T betaAB)
Definition: grad_reg_inc_beta.hpp:14
check_consistent_sizes.hpp
stan::math::check_positive_finite
bool check_positive_finite(const char *function, const char *name, const T_y &y)
Return true if y is positive and finite.
Definition: check_positive_finite.hpp:28
stan::math::negative_infinity
double negative_infinity()
Return negative infinity.
Definition: constants.hpp:132
stan::math::digamma
fvar< T > digamma(const fvar< T > &x)
Definition: digamma.hpp:16

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