Automatic Differentiation
 
Loading...
Searching...
No Matches
exp_mod_normal_lpdf.hpp
Go to the documentation of this file.
1#ifndef STAN_MATH_PRIM_PROB_EXP_MOD_NORMAL_LPDF_HPP
2#define STAN_MATH_PRIM_PROB_EXP_MOD_NORMAL_LPDF_HPP
3
20#include <cmath>
21
22namespace stan {
23namespace math {
24
25template <bool propto, typename T_y, typename T_loc, typename T_scale,
26 typename T_inv_scale,
28 T_y, T_loc, T_scale, T_inv_scale>* = nullptr>
30 const T_y& y, const T_loc& mu, const T_scale& sigma,
31 const T_inv_scale& lambda) {
33 using T_y_ref = ref_type_if_not_constant_t<T_y>;
34 using T_mu_ref = ref_type_if_not_constant_t<T_loc>;
35 using T_sigma_ref = ref_type_if_not_constant_t<T_scale>;
36 using T_lambda_ref = ref_type_if_not_constant_t<T_inv_scale>;
37 static constexpr const char* function = "exp_mod_normal_lpdf";
38 check_consistent_sizes(function, "Random variable", y, "Location parameter",
39 mu, "Scale parameter", sigma, "Inv_scale paramter",
40 lambda);
41 T_y_ref y_ref = y;
42 T_mu_ref mu_ref = mu;
43 T_sigma_ref sigma_ref = sigma;
44 T_lambda_ref lambda_ref = lambda;
45
46 decltype(auto) y_val = to_ref(as_value_column_array_or_scalar(y_ref));
47 decltype(auto) mu_val = to_ref(as_value_column_array_or_scalar(mu_ref));
48 decltype(auto) sigma_val = to_ref(as_value_column_array_or_scalar(sigma_ref));
49 decltype(auto) lambda_val
51
52 check_not_nan(function, "Random variable", y_val);
53 check_finite(function, "Location parameter", mu_val);
54 check_positive_finite(function, "Scale parameter", sigma_val);
55 check_positive_finite(function, "Inv_scale parameter", lambda_val);
56
57 if (size_zero(y, mu, sigma, lambda)) {
58 return 0.0;
59 }
61 return 0.0;
62 }
63
64 const auto& inv_sigma
65 = to_ref_if<!is_constant_all<T_y, T_loc>::value>(inv(sigma_val));
66 const auto& sigma_sq
67 = to_ref_if<!is_constant_all<T_scale>::value>(square(sigma_val));
68 const auto& lambda_sigma_sq = to_ref(lambda_val * sigma_sq);
69 const auto& mu_minus_y = to_ref(mu_val - y_val);
70 const auto& inner_term
71 = to_ref_if<!is_constant_all<T_y, T_loc, T_scale, T_inv_scale>::value>(
72 (mu_minus_y + lambda_sigma_sq) * INV_SQRT_TWO * inv_sigma);
73 const auto& erfc_calc = to_ref(erfc(inner_term));
74
75 size_t N = max_size(y, mu, sigma, lambda);
76 T_partials_return logp(0.0);
78 logp -= LOG_TWO * N;
79 }
81 logp += sum(log(lambda_val)) * N / math::size(lambda);
82 }
83 const auto& log_erfc_calc = log(erfc_calc);
84 logp
85 += sum(lambda_val * (mu_minus_y + 0.5 * lambda_sigma_sq) + log_erfc_calc);
86
87 auto ops_partials
88 = make_partials_propagator(y_ref, mu_ref, sigma_ref, lambda_ref);
89
91 const auto& exp_m_sq_inner_term = exp(-square(inner_term));
92 const auto& deriv_logerfc = to_ref_if<
95 >= 2>(-SQRT_TWO_OVER_SQRT_PI * exp_m_sq_inner_term / erfc_calc);
97 const auto& deriv = to_ref_if < !is_constant_all<T_y>::value
99 > (lambda_val + deriv_logerfc * inv_sigma);
101 partials<0>(ops_partials) = -deriv;
102 }
104 partials<1>(ops_partials) = deriv;
105 }
106 }
108 edge<2>(ops_partials).partials_
109 = sigma_val * square(lambda_val)
110 + deriv_logerfc * (lambda_val - mu_minus_y / sigma_sq);
111 }
113 partials<3>(ops_partials) = inv(lambda_val) + lambda_sigma_sq + mu_minus_y
114 + deriv_logerfc * sigma_val;
115 }
116 }
117
118 return ops_partials.build(logp);
119}
120
121template <typename T_y, typename T_loc, typename T_scale, typename T_inv_scale>
123 const T_y& y, const T_loc& mu, const T_scale& sigma,
124 const T_inv_scale& lambda) {
125 return exp_mod_normal_lpdf<false>(y, mu, sigma, lambda);
126}
127
128} // namespace math
129} // namespace stan
130#endif
require_all_not_t< is_nonscalar_prim_or_rev_kernel_expression< std::decay_t< Types > >... > require_all_not_nonscalar_prim_or_rev_kernel_expression_t
Require none of the types satisfy is_nonscalar_prim_or_rev_kernel_expression.
return_type_t< T_y_cl, T_loc_cl, T_scale_cl, T_inv_scale_cl > exp_mod_normal_lpdf(const T_y_cl &y, const T_loc_cl &mu, const T_scale_cl &sigma, const T_inv_scale_cl &lambda)
Returns the log PMF of the exp mod normal distribution.
size_t size(const T &m)
Returns the size (number of the elements) of a matrix_cl or var_value<matrix_cl<T>>.
Definition size.hpp:18
typename return_type< Ts... >::type return_type_t
Convenience type for the return type of the specified template parameters.
size_t max_size(const T1 &x1, const Ts &... xs)
Calculate the size of the largest input.
Definition max_size.hpp:19
static constexpr double SQRT_TWO_OVER_SQRT_PI
The square root of 2 divided by the square root of , .
bool size_zero(const T &x)
Returns 1 if input is of length 0, returns 0 otherwise.
Definition size_zero.hpp:19
T to_ref_if(T &&a)
No-op that should be optimized away.
Definition to_ref.hpp:29
fvar< T > log(const fvar< T > &x)
Definition log.hpp:15
static constexpr double INV_SQRT_TWO
The value of 1 over the square root of 2, .
static constexpr double LOG_TWO
The natural logarithm of 2, .
Definition constants.hpp:80
auto as_value_column_array_or_scalar(T &&a)
Extract the value from an object and for eigen vectors and std::vectors convert to an eigen column ar...
void check_consistent_sizes(const char *)
Trivial no input case, this function is a no-op.
fvar< T > sum(const std::vector< fvar< T > > &m)
Return the sum of the entries of the specified standard vector.
Definition sum.hpp:22
ref_type_t< T && > to_ref(T &&a)
This evaluates expensive Eigen expressions.
Definition to_ref.hpp:17
fvar< T > erfc(const fvar< T > &x)
Definition erfc.hpp:15
void check_finite(const char *function, const char *name, const T_y &y)
Return true if all values in y are finite.
void check_not_nan(const char *function, const char *name, const T_y &y)
Check if y is not NaN.
fvar< T > inv(const fvar< T > &x)
Definition inv.hpp:12
auto make_partials_propagator(Ops &&... ops)
Construct an partials_propagator.
void check_positive_finite(const char *function, const char *name, const T_y &y)
Check if y is positive and finite.
fvar< T > square(const fvar< T > &x)
Definition square.hpp:12
fvar< T > exp(const fvar< T > &x)
Definition exp.hpp:13
typename ref_type_if<!is_constant< T >::value, T >::type ref_type_if_not_constant_t
Definition ref_type.hpp:62
typename partials_return_type< Args... >::type partials_return_t
The lgamma implementation in stan-math is based on either the reentrant safe lgamma_r implementation ...
Definition fvar.hpp:9
Extends std::true_type when instantiated with zero or more template parameters, all of which extend t...
Template metaprogram to calculate whether a summand needs to be included in a proportional (log) prob...