| Stan Math Library 2.12.0 reverse mode automatic differentiation

- Main Page
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

skew_normal_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_SKEW_NORMAL_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_SKEW_NORMAL_LOG_HPP
3
4 #include <stan/math/prim/scal/meta/partials_return_type.hpp>
5 #include <stan/math/prim/scal/meta/OperandsAndPartials.hpp>
6 #include <stan/math/prim/scal/err/check_finite.hpp>
7 #include <stan/math/prim/scal/err/check_not_nan.hpp>
8 #include <stan/math/prim/scal/err/check_positive.hpp>
9 #include <stan/math/prim/scal/err/check_consistent_sizes.hpp>
10 #include <stan/math/prim/scal/fun/owens_t.hpp>
11 #include <stan/math/prim/scal/fun/value_of.hpp>
12 #include <stan/math/prim/scal/meta/is_constant_struct.hpp>
13 #include <stan/math/prim/scal/meta/include_summand.hpp>
14 #include <stan/math/prim/scal/fun/constants.hpp>
15 #include <stan/math/prim/scal/meta/VectorBuilder.hpp>
16 #include <stan/math/prim/scal/meta/VectorView.hpp>
17 #include <boost/random/variate_generator.hpp>
18 #include <boost/math/distributions.hpp>
19 #include <cmath>
20
21 namespace stan {
22 namespace math {
23
24 template <bool propto,
25 typename T_y, typename T_loc, typename T_scale, typename T_shape>
26 typename return_type<T_y, T_loc, T_scale, T_shape>::type
27 skew_normal_log(const T_y& y, const T_loc& mu, const T_scale& sigma,
28 const T_shape& alpha) {
29 static const char* function("skew_normal_log");
30 typedef typename stan::partials_return_type<T_y, T_loc,
31 T_scale, T_shape>::type
32 T_partials_return;
33
34 using std::log;
35 using stan::is_constant_struct;
36 using std::exp;
37
38 if (!(stan::length(y)
39 && stan::length(mu)
40 && stan::length(sigma)
41 && stan::length(alpha)))
42 return 0.0;
43
44 T_partials_return logp(0.0);
45
46 check_not_nan(function, "Random variable", y);
47 check_finite(function, "Location parameter", mu);
48 check_finite(function, "Shape parameter", alpha);
49 check_positive(function, "Scale parameter", sigma);
50 check_consistent_sizes(function,
51 "Random variable", y,
52 "Location parameter", mu,
53 "Scale parameter", sigma,
54 "Shape paramter", alpha);
55
56 if (!include_summand<propto, T_y, T_loc, T_scale, T_shape>::value)
57 return 0.0;
58
59 OperandsAndPartials<T_y, T_loc, T_scale, T_shape>
60 operands_and_partials(y, mu, sigma, alpha);
61
62 using boost::math::erfc;
63 using boost::math::erf;
64 using std::log;
65
66 VectorView<const T_y> y_vec(y);
67 VectorView<const T_loc> mu_vec(mu);
68 VectorView<const T_scale> sigma_vec(sigma);
69 VectorView<const T_shape> alpha_vec(alpha);
70 size_t N = max_size(y, mu, sigma, alpha);
71
72 VectorBuilder<true, T_partials_return, T_scale> inv_sigma(length(sigma));
73 VectorBuilder<include_summand<propto, T_scale>::value,
74 T_partials_return, T_scale> log_sigma(length(sigma));
75 for (size_t i = 0; i < length(sigma); i++) {
76 inv_sigma[i] = 1.0 / value_of(sigma_vec[i]);
77 if (include_summand<propto, T_scale>::value)
78 log_sigma[i] = log(value_of(sigma_vec[i]));
79 }
80
81 for (size_t n = 0; n < N; n++) {
82 const T_partials_return y_dbl = value_of(y_vec[n]);
83 const T_partials_return mu_dbl = value_of(mu_vec[n]);
84 const T_partials_return sigma_dbl = value_of(sigma_vec[n]);
85 const T_partials_return alpha_dbl = value_of(alpha_vec[n]);
86
87 const T_partials_return y_minus_mu_over_sigma
88 = (y_dbl - mu_dbl) * inv_sigma[n];
89 const double pi_dbl = pi();
90
91 if (include_summand<propto>::value)
92 logp -= 0.5 * log(2.0 * pi_dbl);
93 if (include_summand<propto, T_scale>::value)
94 logp -= log(sigma_dbl);
95 if (include_summand<propto, T_y, T_loc, T_scale>::value)
96 logp -= y_minus_mu_over_sigma * y_minus_mu_over_sigma / 2.0;
97 if (include_summand<propto, T_y, T_loc, T_scale, T_shape>::value)
98 logp += log(erfc(-alpha_dbl * y_minus_mu_over_sigma
99 / std::sqrt(2.0)));
100
101 T_partials_return deriv_logerf
102 = 2.0 / std::sqrt(pi_dbl)
103 * exp(-alpha_dbl * y_minus_mu_over_sigma / std::sqrt(2.0)
104 * alpha_dbl * y_minus_mu_over_sigma / std::sqrt(2.0))
105 / (1 + erf(alpha_dbl * y_minus_mu_over_sigma
106 / std::sqrt(2.0)));
107 if (!is_constant_struct<T_y>::value)
108 operands_and_partials.d_x1[n]
109 += -y_minus_mu_over_sigma / sigma_dbl
110 + deriv_logerf * alpha_dbl / (sigma_dbl * std::sqrt(2.0));
111 if (!is_constant_struct<T_loc>::value)
112 operands_and_partials.d_x2[n]
113 += y_minus_mu_over_sigma / sigma_dbl
114 + deriv_logerf * -alpha_dbl / (sigma_dbl * std::sqrt(2.0));
115 if (!is_constant_struct<T_scale>::value)
116 operands_and_partials.d_x3[n]
117 += -1.0 / sigma_dbl
118 + y_minus_mu_over_sigma * y_minus_mu_over_sigma / sigma_dbl
119 - deriv_logerf * y_minus_mu_over_sigma * alpha_dbl
120 / (sigma_dbl * std::sqrt(2.0));
121 if (!is_constant_struct<T_shape>::value)
122 operands_and_partials.d_x4[n]
123 += deriv_logerf * y_minus_mu_over_sigma / std::sqrt(2.0);
124 }
125 return operands_and_partials.value(logp);
126 }
127
128 template <typename T_y, typename T_loc, typename T_scale, typename T_shape>
129 inline
130 typename return_type<T_y, T_loc, T_scale, T_shape>::type
131 skew_normal_log(const T_y& y, const T_loc& mu, const T_scale& sigma,
132 const T_shape& alpha) {
133 return skew_normal_log<false>(y, mu, sigma, alpha);
134 }
135
136 }
137 }
138 #endif
139
check_not_nan.hpp
stan::math::OperandsAndPartials::d_x2
VectorView< T_return_type, false, true > d_x2
Definition: OperandsAndPartials.hpp:39
stan::math::skew_normal_log
return_type< T_y, T_loc, T_scale, T_shape >::type skew_normal_log(const T_y &y, const T_loc &mu, const T_scale &sigma, const T_shape &alpha)
Definition: skew_normal_log.hpp:27
stan::math::sqrt
fvar< T > sqrt(const fvar< T > &x)
Definition: sqrt.hpp:14
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:60
check_positive.hpp
stan
Definition: log_sum_exp.hpp:8
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::log
fvar< T > log(const fvar< T > &x)
Definition: log.hpp:14
stan::math::OperandsAndPartials::value
T_return_type value(double value)
Returns a T_return_type with the value specified with the partial derivatves.
Definition: OperandsAndPartials.hpp:67
stan::length
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
stan::math::erf
fvar< T > erf(const fvar< T > &x)
Definition: erf.hpp:14
is_constant_struct.hpp
stan::math::include_summand
Template metaprogram to calculate whether a summand needs to be included in a proportional (log) prob...
Definition: include_summand.hpp:35
stan::return_type::type
boost::math::tools::promote_args< typename scalar_type< T1 >::type, typename scalar_type< T2 >::type, typename scalar_type< T3 >::type, typename scalar_type< T4 >::type, typename scalar_type< T5 >::type, typename scalar_type< T6 >::type >::type type
Definition: return_type.hpp:27
include_summand.hpp
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:13
stan::partials_return_type
Definition: partials_return_type.hpp:16
stan::math::exp
fvar< T > exp(const fvar< T > &x)
Definition: exp.hpp:10
stan::math::OperandsAndPartials
This class builds partial derivatives with respect to a set of operands.
Definition: OperandsAndPartials.hpp:37
VectorView.hpp
stan::math::OperandsAndPartials::d_x3
VectorView< T_return_type, false, true > d_x3
Definition: OperandsAndPartials.hpp:40
stan::math::check_positive
bool check_positive(const char *function, const char *name, const T_y &y)
Return true if y is positive.
Definition: check_positive.hpp:66
owens_t.hpp
stan::max_size
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
VectorBuilder.hpp
partials_return_type.hpp
OperandsAndPartials.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:60
stan::VectorBuilder
VectorBuilder allocates type T1 values to be used as intermediate values.
Definition: VectorBuilder.hpp:28
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
stan::math::erfc
fvar< T > erfc(const fvar< T > &x)
Definition: erfc.hpp:14
stan::math::pi
double pi()
Return the value of pi.
Definition: constants.hpp:85
value_of.hpp
stan::VectorView
VectorView is a template expression that is constructed with a container or scalar, which it then allows to be used as an array using operator[].
Definition: VectorView.hpp:48
check_consistent_sizes.hpp
stan::math::OperandsAndPartials::d_x1
VectorView< T_return_type, false, true > d_x1
Definition: OperandsAndPartials.hpp:38
stan::math::OperandsAndPartials::d_x4
VectorView< T_return_type, false, true > d_x4
Definition: OperandsAndPartials.hpp:41

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