Stan Math Library  2.9.0
reverse mode automatic differentiation
normal_cdf_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_NORMAL_CDF_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_NORMAL_CDF_LOG_HPP
3 
4 #include <boost/random/normal_distribution.hpp>
5 #include <boost/random/variate_generator.hpp>
15 #include <cmath>
16 #include <limits>
17 
18 namespace stan {
19 
20  namespace math {
21 
22  template <typename T_y, typename T_loc, typename T_scale>
23  typename return_type<T_y, T_loc, T_scale>::type
24  normal_cdf_log(const T_y& y, const T_loc& mu, const T_scale& sigma) {
25  static const char* function("stan::math::normal_cdf_log");
27  T_partials_return;
28 
35  using std::log;
36  using std::exp;
37 
38  T_partials_return cdf_log(0.0);
39  // check if any vectors are zero length
40  if (!(stan::length(y)
41  && stan::length(mu)
42  && stan::length(sigma)))
43  return cdf_log;
44 
45  check_not_nan(function, "Random variable", y);
46  check_finite(function, "Location parameter", mu);
47  check_not_nan(function, "Scale parameter", sigma);
48  check_positive(function, "Scale parameter", sigma);
49  check_consistent_sizes(function,
50  "Random variable", y,
51  "Location parameter", mu,
52  "Scale parameter", sigma);
53 
55  operands_and_partials(y, mu, sigma);
56 
57  VectorView<const T_y> y_vec(y);
58  VectorView<const T_loc> mu_vec(mu);
59  VectorView<const T_scale> sigma_vec(sigma);
60  size_t N = max_size(y, mu, sigma);
61 
62  const double SQRT_TWO_OVER_PI = std::sqrt(2.0 / stan::math::pi());
63  for (size_t n = 0; n < N; n++) {
64  const T_partials_return y_dbl = value_of(y_vec[n]);
65  const T_partials_return mu_dbl = value_of(mu_vec[n]);
66  const T_partials_return sigma_dbl = value_of(sigma_vec[n]);
67 
68  const T_partials_return scaled_diff = (y_dbl - mu_dbl)
69  / (sigma_dbl * SQRT_2);
70 
71  T_partials_return one_p_erf;
72  if (scaled_diff < -37.5 * INV_SQRT_2)
73  one_p_erf = 0.0;
74  else if (scaled_diff < -5.0 * INV_SQRT_2)
75  one_p_erf = erfc(-scaled_diff);
76  else if (scaled_diff > 8.25 * INV_SQRT_2)
77  one_p_erf = 2.0;
78  else
79  one_p_erf = 1.0 + erf(scaled_diff);
80 
81  // log cdf
82  cdf_log += LOG_HALF + log(one_p_erf);
83 
84  // gradients
86  const T_partials_return rep_deriv_div_sigma
87  = scaled_diff < -37.5 * INV_SQRT_2
88  ? std::numeric_limits<double>::infinity()
89  : SQRT_TWO_OVER_PI * exp(-scaled_diff * scaled_diff)
90  / sigma_dbl / one_p_erf;
92  operands_and_partials.d_x1[n] += rep_deriv_div_sigma;
94  operands_and_partials.d_x2[n] -= rep_deriv_div_sigma;
96  operands_and_partials.d_x3[n] -= rep_deriv_div_sigma
97  * scaled_diff * stan::math::SQRT_2;
98  }
99  }
100  return operands_and_partials.to_var(cdf_log, y, mu, sigma);
101  }
102  }
103 }
104 #endif
const double LOG_HALF
Definition: constants.hpp:179
fvar< T > sqrt(const fvar< T > &x)
Definition: sqrt.hpp:15
bool check_not_nan(const char *function, const char *name, const T_y &y)
Return true if y is not NaN.
T value_of(const fvar< T > &v)
Return the value of the specified variable.
Definition: value_of.hpp:16
fvar< T > log(const fvar< T > &x)
Definition: log.hpp:15
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
fvar< T > erf(const fvar< T > &x)
Definition: erf.hpp:14
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)
VectorView< T_partials_return, is_vector< T1 >::value, is_constant_struct< T1 >::value > d_x1
Metaprogram to determine if a type has a base scalar type that can be assigned to type double...
const double SQRT_2
The value of the square root of 2, .
Definition: constants.hpp:21
const double INV_SQRT_2
The value of 1 over the square root of 2, .
Definition: constants.hpp:27
fvar< T > exp(const fvar< T > &x)
Definition: exp.hpp:10
VectorView< T_partials_return, is_vector< T3 >::value, is_constant_struct< T3 >::value > d_x3
A variable implementation that stores operands and derivatives with respect to the variable...
bool check_positive(const char *function, const char *name, const T_y &y)
Return true if y is positive.
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
bool check_finite(const char *function, const char *name, const T_y &y)
Return true if y is finite.
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.
return_type< T_y, T_loc, T_scale >::type normal_cdf_log(const T_y &y, const T_loc &mu, const T_scale &sigma)
VectorView< T_partials_return, is_vector< T2 >::value, is_constant_struct< T2 >::value > d_x2
fvar< T > erfc(const fvar< T > &x)
Definition: erfc.hpp:14
double pi()
Return the value of pi.
Definition: constants.hpp:86
VectorView is a template metaprogram that takes its argument and allows it to be used like a vector...
Definition: VectorView.hpp:41
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

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