| Stan Math Library 2.12.0 reverse mode automatic differentiation

- Main Page
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

beta_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_BETA_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_BETA_LOG_HPP
3
4 #include <stan/math/prim/scal/meta/is_constant_struct.hpp>
5 #include <stan/math/prim/scal/meta/partials_return_type.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_less_or_equal.hpp>
9 #include <stan/math/prim/scal/err/check_nonnegative.hpp>
10 #include <stan/math/prim/scal/err/check_not_nan.hpp>
11 #include <stan/math/prim/scal/err/check_positive_finite.hpp>
12 #include <stan/math/prim/scal/fun/log1m.hpp>
13 #include <stan/math/prim/scal/fun/multiply_log.hpp>
14 #include <stan/math/prim/scal/fun/value_of.hpp>
15 #include <stan/math/prim/scal/fun/digamma.hpp>
16 #include <stan/math/prim/scal/fun/lgamma.hpp>
17 #include <stan/math/prim/scal/fun/lbeta.hpp>
18 #include <stan/math/prim/scal/meta/contains_nonconstant_struct.hpp>
19 #include <stan/math/prim/scal/meta/VectorBuilder.hpp>
20 #include <stan/math/prim/scal/fun/constants.hpp>
21 #include <stan/math/prim/scal/meta/include_summand.hpp>
22 #include <stan/math/prim/scal/fun/grad_reg_inc_beta.hpp>
23 #include <stan/math/prim/scal/fun/inc_beta.hpp>
24 #include <boost/math/special_functions/gamma.hpp>
25 #include <boost/random/gamma_distribution.hpp>
26 #include <boost/random/variate_generator.hpp>
27 #include <cmath>
28
29 namespace stan {
30 namespace math {
31
50 template <bool propto,
51 typename T_y, typename T_scale_succ, typename T_scale_fail>
52 typename return_type<T_y, T_scale_succ, T_scale_fail>::type
53 beta_log(const T_y& y,
54 const T_scale_succ& alpha, const T_scale_fail& beta) {
55 static const char* function("beta_log");
56
57 typedef typename stan::partials_return_type<T_y,
58 T_scale_succ,
59 T_scale_fail>::type
60 T_partials_return;
61
62 using stan::is_constant_struct;
63 using stan::is_vector;
64 using std::log;
65
66 if (!(stan::length(y)
67 && stan::length(alpha)
68 && stan::length(beta)))
69 return 0.0;
70
71 T_partials_return logp(0.0);
72
73 check_positive_finite(function, "First shape parameter", alpha);
74 check_positive_finite(function, "Second shape parameter", beta);
75 check_not_nan(function, "Random variable", y);
76 check_consistent_sizes(function,
77 "Random variable", y,
78 "First shape parameter", alpha,
79 "Second shape parameter", beta);
80 check_nonnegative(function, "Random variable", y);
81 check_less_or_equal(function, "Random variable", y, 1);
82
83 if (!include_summand<propto, T_y, T_scale_succ, T_scale_fail>::value)
84 return 0.0;
85
86 VectorView<const T_y> y_vec(y);
87 VectorView<const T_scale_succ> alpha_vec(alpha);
88 VectorView<const T_scale_fail> beta_vec(beta);
89 size_t N = max_size(y, alpha, beta);
90
91 for (size_t n = 0; n < N; n++) {
92 const T_partials_return y_dbl = value_of(y_vec[n]);
93 if (y_dbl < 0 || y_dbl > 1)
94 return LOG_ZERO;
95 }
96
97 OperandsAndPartials<T_y, T_scale_succ, T_scale_fail>
98 operands_and_partials(y, alpha, beta);
99
100 VectorBuilder<include_summand<propto, T_y, T_scale_succ>::value,
101 T_partials_return, T_y>
102 log_y(length(y));
103 VectorBuilder<include_summand<propto, T_y, T_scale_fail>::value,
104 T_partials_return, T_y>
105 log1m_y(length(y));
106
107 for (size_t n = 0; n < length(y); n++) {
108 if (include_summand<propto, T_y, T_scale_succ>::value)
109 log_y[n] = log(value_of(y_vec[n]));
110 if (include_summand<propto, T_y, T_scale_fail>::value)
111 log1m_y[n] = log1m(value_of(y_vec[n]));
112 }
113
114 VectorBuilder<include_summand<propto, T_scale_succ>::value,
115 T_partials_return, T_scale_succ>
116 lgamma_alpha(length(alpha));
117 VectorBuilder<!is_constant_struct<T_scale_succ>::value,
118 T_partials_return, T_scale_succ>
119 digamma_alpha(length(alpha));
120 for (size_t n = 0; n < length(alpha); n++) {
121 if (include_summand<propto, T_scale_succ>::value)
122 lgamma_alpha[n] = lgamma(value_of(alpha_vec[n]));
123 if (!is_constant_struct<T_scale_succ>::value)
124 digamma_alpha[n] = digamma(value_of(alpha_vec[n]));
125 }
126
127 VectorBuilder<include_summand<propto, T_scale_fail>::value,
128 T_partials_return, T_scale_fail>
129 lgamma_beta(length(beta));
130 VectorBuilder<!is_constant_struct<T_scale_fail>::value,
131 T_partials_return, T_scale_fail>
132 digamma_beta(length(beta));
133
134 for (size_t n = 0; n < length(beta); n++) {
135 if (include_summand<propto, T_scale_fail>::value)
136 lgamma_beta[n] = lgamma(value_of(beta_vec[n]));
137 if (!is_constant_struct<T_scale_fail>::value)
138 digamma_beta[n] = digamma(value_of(beta_vec[n]));
139 }
140
141 VectorBuilder<include_summand<propto, T_scale_succ, T_scale_fail>::value,
142 T_partials_return, T_scale_succ, T_scale_fail>
143 lgamma_alpha_beta(max_size(alpha, beta));
144
145 VectorBuilder<contains_nonconstant_struct<T_scale_succ,
146 T_scale_fail>::value,
147 T_partials_return, T_scale_succ, T_scale_fail>
148 digamma_alpha_beta(max_size(alpha, beta));
149
150 for (size_t n = 0; n < max_size(alpha, beta); n++) {
151 const T_partials_return alpha_beta = value_of(alpha_vec[n])
152 + value_of(beta_vec[n]);
153 if (include_summand<propto, T_scale_succ, T_scale_fail>::value)
154 lgamma_alpha_beta[n] = lgamma(alpha_beta);
155 if (contains_nonconstant_struct<T_scale_succ, T_scale_fail>::value)
156 digamma_alpha_beta[n] = digamma(alpha_beta);
157 }
158
159 for (size_t n = 0; n < N; n++) {
160 const T_partials_return y_dbl = value_of(y_vec[n]);
161 const T_partials_return alpha_dbl = value_of(alpha_vec[n]);
162 const T_partials_return beta_dbl = value_of(beta_vec[n]);
163
164 if (include_summand<propto, T_scale_succ, T_scale_fail>::value)
165 logp += lgamma_alpha_beta[n];
166 if (include_summand<propto, T_scale_succ>::value)
167 logp -= lgamma_alpha[n];
168 if (include_summand<propto, T_scale_fail>::value)
169 logp -= lgamma_beta[n];
170 if (include_summand<propto, T_y, T_scale_succ>::value)
171 logp += (alpha_dbl-1.0) * log_y[n];
172 if (include_summand<propto, T_y, T_scale_fail>::value)
173 logp += (beta_dbl-1.0) * log1m_y[n];
174
175 if (!is_constant_struct<T_y>::value)
176 operands_and_partials.d_x1[n] += (alpha_dbl-1)/y_dbl
177 + (beta_dbl-1)/(y_dbl-1);
178 if (!is_constant_struct<T_scale_succ>::value)
179 operands_and_partials.d_x2[n]
180 += log_y[n] + digamma_alpha_beta[n] - digamma_alpha[n];
181 if (!is_constant_struct<T_scale_fail>::value)
182 operands_and_partials.d_x3[n]
183 += log1m_y[n] + digamma_alpha_beta[n] - digamma_beta[n];
184 }
185 return operands_and_partials.value(logp);
186 }
187
188 template <typename T_y, typename T_scale_succ, typename T_scale_fail>
189 inline typename return_type<T_y, T_scale_succ, T_scale_fail>::type
190 beta_log(const T_y& y, const T_scale_succ& alpha,
191 const T_scale_fail& beta) {
192 return beta_log<false>(y, alpha, beta);
193 }
194
195 }
196 }
197 #endif
check_not_nan.hpp
stan::math::OperandsAndPartials::d_x2
VectorView< T_return_type, false, true > d_x2
Definition: OperandsAndPartials.hpp:39
lgamma.hpp
stan::math::lgamma
fvar< T > lgamma(const fvar< T > &x)
Definition: lgamma.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_finite.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::beta_log
return_type< T_y, T_scale_succ, T_scale_fail >::type beta_log(const T_y &y, const T_scale_succ &alpha, const T_scale_fail &beta)
The log of the beta density for the specified scalar(s) given the specified sample size(s)...
Definition: beta_log.hpp:53
digamma.hpp
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
contains_nonconstant_struct.hpp
stan::length
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
is_constant_struct.hpp
stan::math::LOG_ZERO
const double LOG_ZERO
Definition: constants.hpp:172
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::is_vector
Definition: is_vector.hpp:10
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
multiply_log.hpp
check_nonnegative.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
check_less_or_equal.hpp
stan::math::OperandsAndPartials
This class builds partial derivatives with respect to a set of operands.
Definition: OperandsAndPartials.hpp:37
stan::math::OperandsAndPartials::d_x3
VectorView< T_return_type, false, true > d_x3
Definition: OperandsAndPartials.hpp:40
stan::max_size
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
VectorBuilder.hpp
log1m.hpp
partials_return_type.hpp
OperandsAndPartials.hpp
stan::math::check_less_or_equal
bool check_less_or_equal(const char *function, const char *name, const T_y &y, const T_high &high)
Return true if y is less or equal to high.
Definition: check_less_or_equal.hpp:81
stan::contains_nonconstant_struct
Definition: contains_nonconstant_struct.hpp:14
grad_reg_inc_beta.hpp
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
lbeta.hpp
inc_beta.hpp
stan::math::check_nonnegative
bool check_nonnegative(const char *function, const char *name, const T_y &y)
Return true if y is non-negative.
Definition: check_nonnegative.hpp:64
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::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::log1m
fvar< T > log1m(const fvar< T > &x)
Definition: log1m.hpp:15
stan::math::OperandsAndPartials::d_x1
VectorView< T_return_type, false, true > d_x1
Definition: OperandsAndPartials.hpp:38
stan::math::digamma
fvar< T > digamma(const fvar< T > &x)
Definition: digamma.hpp:15

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