Automatic Differentiation
 
Loading...
Searching...
No Matches
exp_mod_normal_lcdf.hpp
Go to the documentation of this file.
1#ifndef STAN_MATH_OPENCL_PRIM_DOUBLE_EXP_MOD_NORMAL_LCDF_HPP
2#define STAN_MATH_OPENCL_PRIM_DOUBLE_EXP_MOD_NORMAL_LCDF_HPP
3#ifdef STAN_OPENCL
4
12
13namespace stan {
14namespace math {
15
31template <typename T_y_cl, typename T_loc_cl, typename T_scale_cl,
32 typename T_inv_scale_cl,
34 T_y_cl, T_loc_cl, T_scale_cl, T_inv_scale_cl>* = nullptr,
35 require_any_not_stan_scalar_t<T_y_cl, T_loc_cl, T_scale_cl,
36 T_inv_scale_cl>* = nullptr>
38 const T_y_cl& y, const T_loc_cl& mu, const T_scale_cl& sigma,
39 const T_inv_scale_cl& lambda) {
40 static constexpr const char* function = "exp_mod_normal_lcdf(OpenCL)";
41 using T_partials_return
43 using std::isfinite;
44 using std::isnan;
45
46 check_consistent_sizes(function, "Random variable", y, "Location parameter",
47 mu, "Scale parameter", sigma);
48 const size_t N = max_size(y, mu, sigma);
49 if (N == 0) {
50 return 0.0;
51 }
52
53 const auto& y_col = as_column_vector_or_scalar(y);
54 const auto& mu_col = as_column_vector_or_scalar(mu);
55 const auto& sigma_col = as_column_vector_or_scalar(sigma);
56 const auto& lambda_col = as_column_vector_or_scalar(lambda);
57
58 const auto& y_val = value_of(y_col);
59 const auto& mu_val = value_of(mu_col);
60 const auto& sigma_val = value_of(sigma_col);
61 const auto& lambda_val = value_of(lambda_col);
62
63 auto check_y_not_nan
64 = check_cl(function, "Random variable", y_val, "not NaN");
65 auto y_not_nan_expr = !isnan(y_val);
66 auto check_mu_finite
67 = check_cl(function, "Location parameter", mu_val, "finite");
68 auto mu_finite_expr = isfinite(mu_val);
69 auto check_sigma_positive_finite
70 = check_cl(function, "Scale parameter", sigma_val, "positive finite");
71 auto sigma_positive_finite_expr = 0 < sigma_val && isfinite(sigma_val);
72 auto check_lambda_positive_finite
73 = check_cl(function, "Inv_cale parameter", lambda_val, "positive finite");
74 auto lambda_positive_finite_expr = 0 < lambda_val && isfinite(lambda_val);
75
76 auto any_y_neg_inf = colwise_max(cast<char>(y_val == NEGATIVE_INFTY));
77 auto any_y_pos_inf = colwise_max(cast<char>(y_val == INFTY));
78 auto sigma_inv = elt_divide(1.0, sigma_val);
79 auto diff = y_val - mu_val;
80 auto scaled_diff = elt_multiply(diff * INV_SQRT_TWO, sigma_inv);
81 auto v = elt_multiply(lambda_val, sigma_val);
82 auto scaled_diff_diff = scaled_diff - v * INV_SQRT_TWO;
83 auto erf_calc = 0.5 * (1.0 + erf(scaled_diff_diff));
84 auto exp_term = exp(0.5 * square(v) - elt_multiply(lambda_val, diff));
85 auto cdf_n = 0.5 + 0.5 * erf(scaled_diff) - elt_multiply(exp_term, erf_calc);
86 auto cdf_log_expr = colwise_sum(log(cdf_n));
87
88 auto exp_term_2 = exp(-square(scaled_diff_diff));
89 auto deriv_1 = elt_multiply(elt_multiply(lambda_val, exp_term), erf_calc);
90 auto deriv_2 = INV_SQRT_TWO_PI
91 * elt_multiply(elt_multiply(exp_term, exp_term_2), sigma_inv);
92 auto deriv_3
93 = INV_SQRT_TWO_PI * elt_multiply(exp(-square(scaled_diff)), sigma_inv);
94 auto y_deriv = elt_divide(deriv_1 - deriv_2 + deriv_3, cdf_n);
95 auto mu_deriv = -y_deriv;
96 auto sigma_deriv = -elt_divide(
97 elt_multiply(deriv_1 - deriv_2, v)
98 + elt_multiply(deriv_3 - deriv_2, scaled_diff) * SQRT_TWO,
99 cdf_n);
100 auto lambda_deriv = elt_divide(
102 exp_term,
103 INV_SQRT_TWO_PI * elt_multiply(sigma_val, exp_term_2)
104 - elt_multiply(elt_multiply(v, sigma_val) - diff, erf_calc)),
105 cdf_n);
106
107 matrix_cl<char> any_y_neg_inf_cl;
108 matrix_cl<char> any_y_pos_inf_cl;
109 matrix_cl<double> cdf_log_cl;
110 matrix_cl<double> mu_deriv_cl;
111 matrix_cl<double> y_deriv_cl;
112 matrix_cl<double> sigma_deriv_cl;
113 matrix_cl<double> lambda_deriv_cl;
114
115 results(check_y_not_nan, check_mu_finite, check_sigma_positive_finite,
116 check_lambda_positive_finite, any_y_neg_inf_cl, any_y_pos_inf_cl,
117 cdf_log_cl, y_deriv_cl, mu_deriv_cl, sigma_deriv_cl, lambda_deriv_cl)
118 = expressions(y_not_nan_expr, mu_finite_expr, sigma_positive_finite_expr,
119 lambda_positive_finite_expr, any_y_neg_inf, any_y_pos_inf,
120 cdf_log_expr, calc_if<!is_constant<T_y_cl>::value>(y_deriv),
124
125 if (from_matrix_cl(any_y_pos_inf_cl).maxCoeff()) {
126 return 0.0;
127 }
128
129 if (from_matrix_cl(any_y_neg_inf_cl).maxCoeff()) {
130 return NEGATIVE_INFTY;
131 }
132
133 T_partials_return cdf_log = (from_matrix_cl(cdf_log_cl)).sum();
134
135 auto ops_partials
136 = make_partials_propagator(y_col, mu_col, sigma_col, lambda_col);
137
139 partials<0>(ops_partials) = std::move(y_deriv_cl);
140 }
142 partials<1>(ops_partials) = std::move(mu_deriv_cl);
143 }
145 partials<2>(ops_partials) = std::move(sigma_deriv_cl);
146 }
148 partials<3>(ops_partials) = std::move(lambda_deriv_cl);
149 }
150 return ops_partials.build(cdf_log);
151}
152
153} // namespace math
154} // namespace stan
155#endif
156#endif
Represents an arithmetic matrix on the OpenCL device.
Definition matrix_cl.hpp:47
elt_multiply_< as_operation_cl_t< T_a >, as_operation_cl_t< T_b > > elt_multiply(T_a &&a, T_b &&b)
isfinite_< as_operation_cl_t< T > > isfinite(T &&a)
auto check_cl(const char *function, const char *var_name, T &&y, const char *must_be)
Constructs a check on opencl matrix or expression.
Definition check_cl.hpp:219
results_cl< T_results... > results(T_results &&... results)
Deduces types for constructing results_cl object.
auto as_column_vector_or_scalar(T &&a)
as_column_vector_or_scalar of a kernel generator expression.
elt_divide_< as_operation_cl_t< T_a >, as_operation_cl_t< T_b > > elt_divide(T_a &&a, T_b &&b)
auto colwise_max(T &&a)
Column wise max - reduction of a kernel generator expression.
calc_if_< true, as_operation_cl_t< T > > calc_if(T &&a)
Definition calc_if.hpp:121
auto colwise_sum(T &&a)
Column wise sum - reduction of a kernel generator expression.
expressions_cl< T_expressions... > expressions(T_expressions &&... expressions)
Deduces types for constructing expressions_cl object.
return_type_t< T_y_cl, T_loc_cl, T_scale_cl, T_inv_scale_cl > exp_mod_normal_lcdf(const T_y_cl &y, const T_loc_cl &mu, const T_scale_cl &sigma, const T_inv_scale_cl &lambda)
Returns the exp mod normal log cumulative density function.
auto from_matrix_cl(const T &src)
Copies the source matrix that is stored on the OpenCL device to the destination Eigen matrix.
Definition copy.hpp:61
require_all_t< is_prim_or_rev_kernel_expression< std::decay_t< Types > >... > require_all_prim_or_rev_kernel_expression_t
Require type satisfies is_prim_or_rev_kernel_expression.
require_any_not_t< is_stan_scalar< std::decay_t< Types > >... > require_any_not_stan_scalar_t
Require at least one of the types do not satisfy is_stan_scalar.
typename return_type< Ts... >::type return_type_t
Convenience type for the return type of the specified template parameters.
T value_of(const fvar< T > &v)
Return the value of the specified variable.
Definition value_of.hpp:18
fvar< T > log(const fvar< T > &x)
Definition log.hpp:18
fvar< T > erf(const fvar< T > &x)
Definition erf.hpp:16
static constexpr double INV_SQRT_TWO
The value of 1 over the square root of 2, .
static constexpr double INV_SQRT_TWO_PI
The value of 1 over the square root of , .
static constexpr double NEGATIVE_INFTY
Negative infinity.
Definition constants.hpp:51
static constexpr double SQRT_TWO
The value of the square root of 2, .
void check_consistent_sizes(const char *)
Trivial no input case, this function is a no-op.
auto sum(const std::vector< T > &m)
Return the sum of the entries of the specified standard vector.
Definition sum.hpp:23
int64_t max_size(const T1 &x1, const Ts &... xs)
Calculate the size of the largest input.
Definition max_size.hpp:20
auto make_partials_propagator(Ops &&... ops)
Construct an partials_propagator.
static constexpr double INFTY
Positive infinity.
Definition constants.hpp:46
fvar< T > square(const fvar< T > &x)
Definition square.hpp:12
fvar< T > exp(const fvar< T > &x)
Definition exp.hpp:15
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 ...
bool isnan(const stan::math::var &a)
Checks if the given number is NaN.
Definition std_isnan.hpp:18
Metaprogramming struct to detect whether a given type is constant in the mathematical sense (not the ...