| 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
uniform_ccdf_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_UNIFORM_CCDF_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_UNIFORM_CCDF_LOG_HPP
3
4 #include <boost/random/uniform_real_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_greater.hpp>
10 #include <stan/math/prim/scal/err/check_not_nan.hpp>
11 #include <stan/math/prim/scal/fun/constants.hpp>
12 #include <stan/math/prim/scal/fun/value_of.hpp>
13 #include <stan/math/prim/scal/meta/VectorBuilder.hpp>
14 #include <stan/math/prim/scal/meta/include_summand.hpp>
15 #include <cmath>
16
17 namespace stan {
18
19 namespace math {
20
21 template <typename T_y, typename T_low, typename T_high>
22 typename return_type<T_y, T_low, T_high>::type
23 uniform_ccdf_log(const T_y& y, const T_low& alpha, const T_high& beta) {
24 static const char* function("stan::math::uniform_ccdf_log");
25 typedef typename stan::partials_return_type<T_y, T_low, T_high>::type
26 T_partials_return;
27
28 using stan::math::check_not_nan;
29 using stan::math::check_finite;
30 using stan::math::check_greater;
31 using stan::math::value_of;
32 using stan::math::check_consistent_sizes;
33 using std::log;
34
35 // check if any vectors are zero length
36 if (!(stan::length(y)
37 && stan::length(alpha)
38 && stan::length(beta)))
39 return 0.0;
40
41 // set up return value accumulator
42 T_partials_return ccdf_log(0.0);
43 check_not_nan(function, "Random variable", y);
44 check_finite(function, "Lower bound parameter", alpha);
45 check_finite(function, "Upper bound parameter", beta);
46 check_greater(function, "Upper bound parameter", beta, alpha);
47 check_consistent_sizes(function,
48 "Random variable", y,
49 "Lower bound parameter", alpha,
50 "Upper bound parameter", beta);
51
52 VectorView<const T_y> y_vec(y);
53 VectorView<const T_low> alpha_vec(alpha);
54 VectorView<const T_high> beta_vec(beta);
55 size_t N = max_size(y, alpha, beta);
56
57 for (size_t n = 0; n < N; n++) {
58 const T_partials_return y_dbl = value_of(y_vec[n]);
59 if (y_dbl < value_of(alpha_vec[n])
60 || y_dbl > value_of(beta_vec[n]))
61 return 0.0;
62 if (y_dbl == value_of(beta_vec[n]))
63 return LOG_ZERO;
64 }
65
66 OperandsAndPartials<T_y, T_low, T_high>
67 operands_and_partials(y, alpha, beta);
68 for (size_t n = 0; n < N; n++) {
69 const T_partials_return y_dbl = value_of(y_vec[n]);
70 const T_partials_return alpha_dbl = value_of(alpha_vec[n]);
71 const T_partials_return beta_dbl = value_of(beta_vec[n]);
72 const T_partials_return b_min_a = beta_dbl - alpha_dbl;
73 const T_partials_return ccdf_log_ = 1.0 - (y_dbl - alpha_dbl) / b_min_a;
74
75 // ccdf_log
76 ccdf_log += log(ccdf_log_);
77
78 // gradients
79 if (!is_constant_struct<T_y>::value)
80 operands_and_partials.d_x1[n] -= 1.0 / b_min_a / ccdf_log_;
81 if (!is_constant_struct<T_low>::value)
82 operands_and_partials.d_x2[n] -= (y_dbl - beta_dbl) / b_min_a
83 / b_min_a / ccdf_log_;
84 if (!is_constant_struct<T_high>::value)
85 operands_and_partials.d_x3[n] += (y_dbl - alpha_dbl) / b_min_a
86 / b_min_a / ccdf_log_;
87 }
88
89 return operands_and_partials.to_var(ccdf_log, y, alpha, beta);
90 }
91 }
92 }
93 #endif
check_not_nan.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
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:15
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::LOG_ZERO
const double LOG_ZERO
Definition: constants.hpp:175
include_summand.hpp
check_greater.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::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
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
stan::math::uniform_ccdf_log
return_type< T_y, T_low, T_high >::type uniform_ccdf_log(const T_y &y, const T_low &alpha, const T_high &beta)
Definition: uniform_ccdf_log.hpp:23
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
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::OperandsAndPartials::d_x2
VectorView< T_partials_return, is_vector< T2 >::value, is_constant_struct< T2 >::value > d_x2
Definition: OperandsAndPartials.hpp:256
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
check_consistent_sizes.hpp
stan::math::check_greater
bool check_greater(const char *function, const char *name, const T_y &y, const T_low &low)
Return true if y is strictly greater than low.
Definition: check_greater.hpp:84

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