All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros
gamma_cdf_log.hpp
Go to the documentation of this file.
#ifndef STAN_MATH_PRIM_SCAL_PROB_GAMMA_CDF_LOG_HPP
#define STAN_MATH_PRIM_SCAL_PROB_GAMMA_CDF_LOG_HPP
#include <boost/random/gamma_distribution.hpp>
#include <boost/random/variate_generator.hpp>
#include <stan/math/prim/scal/meta/OperandsAndPartials.hpp>
#include <stan/math/prim/scal/err/check_consistent_sizes.hpp>
#include <stan/math/prim/scal/err/check_greater_or_equal.hpp>
#include <stan/math/prim/scal/err/check_less_or_equal.hpp>
#include <stan/math/prim/scal/err/check_nonnegative.hpp>
#include <stan/math/prim/scal/err/check_not_nan.hpp>
#include <stan/math/prim/scal/err/check_positive_finite.hpp>
#include <stan/math/prim/scal/fun/constants.hpp>
#include <stan/math/prim/scal/fun/multiply_log.hpp>
#include <stan/math/prim/scal/fun/value_of.hpp>
#include <stan/math/prim/scal/fun/gamma_p.hpp>
#include <stan/math/prim/scal/fun/digamma.hpp>
#include <stan/math/prim/scal/meta/length.hpp>
#include <stan/math/prim/scal/meta/is_constant_struct.hpp>
#include <stan/math/prim/scal/meta/VectorView.hpp>
#include <stan/math/prim/scal/meta/VectorBuilder.hpp>
#include <stan/math/prim/scal/meta/partials_return_type.hpp>
#include <stan/math/prim/scal/meta/return_type.hpp>
#include <stan/math/prim/scal/meta/include_summand.hpp>
#include <stan/math/prim/scal/fun/grad_reg_inc_gamma.hpp>
#include <cmath>
#include <limits>
namespace stan {
namespace math {
template <typename T_y, typename T_shape, typename T_inv_scale>
typename return_type<T_y, T_shape, T_inv_scale>::type
gamma_cdf_log(const T_y& y, const T_shape& alpha, const T_inv_scale& beta) {
// Size checks
if (!(stan::length(y) && stan::length(alpha) && stan::length(beta)))
return 0.0;
typedef typename stan::partials_return_type<T_y, T_shape,
T_inv_scale>::type
T_partials_return;
// Error checks
static const char* function("stan::math::gamma_cdf_log");
using stan::math::check_positive_finite;
using stan::math::check_not_nan;
using stan::math::check_consistent_sizes;
using stan::math::check_greater_or_equal;
using stan::math::check_less_or_equal;
using stan::math::check_nonnegative;
using stan::math::value_of;
using boost::math::tools::promote_args;
using std::exp;
T_partials_return P(0.0);
check_positive_finite(function, "Shape parameter", alpha);
check_positive_finite(function, "Scale parameter", beta);
check_not_nan(function, "Random variable", y);
check_nonnegative(function, "Random variable", y);
check_consistent_sizes(function,
"Random variable", y,
"Shape parameter", alpha,
"Scale Parameter", beta);
// Wrap arguments in vectors
VectorView<const T_y> y_vec(y);
VectorView<const T_shape> alpha_vec(alpha);
VectorView<const T_inv_scale> beta_vec(beta);
size_t N = max_size(y, alpha, beta);
OperandsAndPartials<T_y, T_shape, T_inv_scale>
operands_and_partials(y, alpha, beta);
// Explicit return for extreme values
// The gradients are technically ill-defined, but treated as zero
for (size_t i = 0; i < stan::length(y); i++) {
if (value_of(y_vec[i]) == 0)
return operands_and_partials.to_var(stan::math::negative_infinity(),
y, alpha, beta);
}
// Compute cdf_log and its gradients
using stan::math::gamma_p;
using stan::math::digamma;
using boost::math::tgamma;
using std::exp;
using std::pow;
using std::log;
// Cache a few expensive function calls if nu is a parameter
VectorBuilder<!is_constant_struct<T_shape>::value,
T_partials_return, T_shape> gamma_vec(stan::length(alpha));
VectorBuilder<!is_constant_struct<T_shape>::value,
T_partials_return, T_shape>
digamma_vec(stan::length(alpha));
if (!is_constant_struct<T_shape>::value) {
for (size_t i = 0; i < stan::length(alpha); i++) {
const T_partials_return alpha_dbl = value_of(alpha_vec[i]);
gamma_vec[i] = tgamma(alpha_dbl);
digamma_vec[i] = digamma(alpha_dbl);
}
}
// Compute vectorized cdf_log and gradient
for (size_t n = 0; n < N; n++) {
// Explicit results for extreme values
// The gradients are technically ill-defined, but treated as zero
if (value_of(y_vec[n]) == std::numeric_limits<double>::infinity())
return operands_and_partials.to_var(0.0, y, alpha, beta);
// Pull out values
const T_partials_return y_dbl = value_of(y_vec[n]);
const T_partials_return alpha_dbl = value_of(alpha_vec[n]);
const T_partials_return beta_dbl = value_of(beta_vec[n]);
// Compute
const T_partials_return Pn = gamma_p(alpha_dbl, beta_dbl * y_dbl);
P += log(Pn);
if (!is_constant_struct<T_y>::value)
operands_and_partials.d_x1[n] += beta_dbl * exp(-beta_dbl * y_dbl)
* pow(beta_dbl * y_dbl, alpha_dbl-1) / tgamma(alpha_dbl) / Pn;
if (!is_constant_struct<T_shape>::value)
operands_and_partials.d_x2[n]
-= stan::math::grad_reg_inc_gamma(alpha_dbl, beta_dbl
* y_dbl, gamma_vec[n],
digamma_vec[n]) / Pn;
if (!is_constant_struct<T_inv_scale>::value)
operands_and_partials.d_x3[n] += y_dbl * exp(-beta_dbl * y_dbl)
* pow(beta_dbl * y_dbl, alpha_dbl-1) / tgamma(alpha_dbl) / Pn;
}
return operands_and_partials.to_var(P, y, alpha, beta);
}
}
}
#endif
check_not_nan.hpp
stan::math::check_greater_or_equal
bool check_greater_or_equal(const char *function, const char *name, const T_y &y, const T_low &low)
Return true if y is greater or equal than low.
Definition: check_greater_or_equal.hpp:84
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
check_positive_finite.hpp
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::gamma_cdf_log
return_type< T_y, T_shape, T_inv_scale >::type gamma_cdf_log(const T_y &y, const T_shape &alpha, const T_inv_scale &beta)
Definition: gamma_cdf_log.hpp:35
digamma.hpp
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::grad_reg_inc_gamma
T grad_reg_inc_gamma(T a, T z, T g, T dig, T precision=1e-6)
Definition: grad_reg_inc_gamma.hpp:15
return_type.hpp
VectorView.hpp
include_summand.hpp
multiply_log.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
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:16
stan::partials_return_type
Definition: partials_return_type.hpp:16
check_less_or_equal.hpp
stan::math::exp
fvar< T > exp(const fvar< T > &x)
Definition: exp.hpp:10
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
partials_return_type.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
length.hpp
stan::math::gamma_p
fvar< T > gamma_p(const fvar< T > &x1, const fvar< T > &x2)
Definition: gamma_p.hpp:15
gamma_p.hpp
grad_reg_inc_gamma.hpp
stan::VectorBuilder
Definition: VectorBuilder.hpp:61
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
stan::math::OperandsAndPartials::d_x2
VectorView< T_partials_return, is_vector< T2 >::value, is_constant_struct< T2 >::value > d_x2
Definition: OperandsAndPartials.hpp:256
is_constant_struct.hpp
stan::math::pow
fvar< T > pow(const fvar< T > &x1, const fvar< T > &x2)
Definition: pow.hpp:18
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:66
check_greater_or_equal.hpp
value_of.hpp
stan::math::tgamma
fvar< T > tgamma(const fvar< T > &x)
Definition: tgamma.hpp:15
stan::VectorView
VectorView is a template metaprogram that takes its argument and allows it to be used like a vector...
Definition: VectorView.hpp:41
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::negative_infinity
double negative_infinity()
Return negative infinity.
Definition: constants.hpp:132
stan::math::digamma
fvar< T > digamma(const fvar< T > &x)
Definition: digamma.hpp:16

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