Stan Math Library  2.11.0
reverse mode automatic differentiation
poisson_ccdf_log.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_PROB_POISSON_CCDF_LOG_HPP
2 #define STAN_MATH_PRIM_SCAL_PROB_POISSON_CCDF_LOG_HPP
3 
15 #include <boost/math/special_functions/fpclassify.hpp>
16 #include <boost/random/poisson_distribution.hpp>
17 #include <boost/random/variate_generator.hpp>
18 #include <cmath>
19 #include <limits>
20 
21 namespace stan {
22 
23  namespace math {
24 
25  template <typename T_n, typename T_rate>
26  typename return_type<T_rate>::type
27  poisson_ccdf_log(const T_n& n, const T_rate& lambda) {
28  static const char* function("stan::math::poisson_ccdf_log");
30  T_partials_return;
31 
36 
37  // Ensure non-zero argument slengths
38  if (!(stan::length(n) && stan::length(lambda)))
39  return 0.0;
40 
41  T_partials_return P(0.0);
42 
43  // Validate arguments
44  check_not_nan(function, "Rate parameter", lambda);
45  check_nonnegative(function, "Rate parameter", lambda);
46  check_consistent_sizes(function,
47  "Random variable", n,
48  "Rate parameter", lambda);
49 
50  // Wrap arguments into vector views
51  VectorView<const T_n> n_vec(n);
52  VectorView<const T_rate> lambda_vec(lambda);
53  size_t size = max_size(n, lambda);
54 
55  // Compute vectorized cdf_log and gradient
58  using boost::math::lgamma;
59  using std::log;
60  using std::exp;
61 
62  OperandsAndPartials<T_rate> operands_and_partials(lambda);
63 
64  // Explicit return for extreme values
65  // The gradients are technically ill-defined, but treated as neg infinity
66  for (size_t i = 0; i < stan::length(n); i++) {
67  if (value_of(n_vec[i]) < 0)
68  return operands_and_partials.value(0.0);
69  }
70 
71  for (size_t i = 0; i < size; i++) {
72  // Explicit results for extreme values
73  // The gradients are technically ill-defined, but treated as zero
74  if (value_of(n_vec[i]) == std::numeric_limits<int>::max())
75  return operands_and_partials.value(stan::math::negative_infinity());
76 
77  const T_partials_return n_dbl = value_of(n_vec[i]);
78  const T_partials_return lambda_dbl = value_of(lambda_vec[i]);
79  const T_partials_return log_Pi = log(gamma_p(n_dbl+1, lambda_dbl));
80 
81  P += log_Pi;
82 
84  operands_and_partials.d_x1[i] += exp(n_dbl * log(lambda_dbl)
85  - lambda_dbl - lgamma(n_dbl+1) - log_Pi);
86  }
87 
88  return operands_and_partials.value(P);
89  }
90  }
91 }
92 #endif
fvar< T > lgamma(const fvar< T > &x)
Definition: lgamma.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
T_return_type value(double value)
Returns a T_return_type with the value specified with the partial derivatves.
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
Metaprogram to determine if a type has a base scalar type that can be assigned to type double...
fvar< T > exp(const fvar< T > &x)
Definition: exp.hpp:10
This class builds partial derivatives with respect to a set of operands.
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
int max(const std::vector< int > &x)
Returns the maximum coefficient in the specified column vector.
Definition: max.hpp:21
fvar< T > gamma_p(const fvar< T > &x1, const fvar< T > &x2)
Definition: gamma_p.hpp:15
int size(const std::vector< T > &x)
Return the size of the specified standard vector.
Definition: size.hpp:17
return_type< T_rate >::type poisson_ccdf_log(const T_n &n, const T_rate &lambda)
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.
bool check_nonnegative(const char *function, const char *name, const T_y &y)
Return true if y is non-negative.
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
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
VectorView< T_return_type, false, true > d_x1
double negative_infinity()
Return negative infinity.
Definition: constants.hpp:132

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