Automatic Differentiation
 
Loading...
Searching...
No Matches
lognormal_lccdf.hpp
Go to the documentation of this file.
1#ifndef STAN_MATH_OPENCL_PRIM_LOGNORMAL_LCCDF_HPP
2#define STAN_MATH_OPENCL_PRIM_LOGNORMAL_LCCDF_HPP
3#ifdef STAN_OPENCL
4
12
13namespace stan {
14namespace math {
15
29template <
30 typename T_y_cl, typename T_loc_cl, typename T_scale_cl,
32 T_scale_cl>* = nullptr,
33 require_any_not_stan_scalar_t<T_y_cl, T_loc_cl, T_scale_cl>* = nullptr>
35 const T_y_cl& y, const T_loc_cl& mu, const T_scale_cl& sigma) {
36 static constexpr const char* function = "lognormal_lccdf(OpenCL)";
38 using std::isfinite;
39 using std::isnan;
40
41 check_consistent_sizes(function, "Random variable", y, "Location parameter",
42 mu, "Scale parameter", sigma);
43 const size_t N = max_size(y, mu, sigma);
44 if (N == 0) {
45 return 0.0;
46 }
47
48 const auto& y_col = as_column_vector_or_scalar(y);
49 const auto& mu_col = as_column_vector_or_scalar(mu);
50 const auto& sigma_col = as_column_vector_or_scalar(sigma);
51
52 const auto& y_val = value_of(y_col);
53 const auto& mu_val = value_of(mu_col);
54 const auto& sigma_val = value_of(sigma_col);
55
56 auto check_y_nonnegative
57 = check_cl(function, "Random variable", y_val, "nonnegative");
58 auto y_nonnegative = 0.0 <= y_val;
59 auto check_mu_finite
60 = check_cl(function, "Location parameter", mu_val, "finite");
61 auto mu_finite_expr = isfinite(mu_val);
62 auto check_sigma_positive_finite
63 = check_cl(function, "Scale parameter", sigma_val, "positive finite");
64 auto sigma_positive_finite_expr = 0 < sigma_val && isfinite(sigma_val);
65
66 auto any_y_zero = colwise_max(cast<char>(y_val == 0.0));
67 auto log_y = log(y_val);
68 auto scaled_diff = elt_divide(log_y - mu_val, sigma_val * SQRT_TWO);
69 auto erfc_calc = erfc(scaled_diff);
70 auto lccdf_expr = colwise_sum(log(erfc_calc));
71 auto mu_deriv = elt_divide(SQRT_TWO_OVER_SQRT_PI * exp(-square(scaled_diff)),
72 elt_multiply(sigma_val, erfc_calc));
73 auto y_deriv = elt_divide(mu_deriv, -y_val);
74 auto sigma_deriv = elt_multiply(mu_deriv, scaled_diff * SQRT_TWO);
75
76 matrix_cl<char> any_y_zero_cl;
77 matrix_cl<double> lccdf_cl;
78 matrix_cl<double> y_deriv_cl;
79 matrix_cl<double> mu_deriv_cl;
80 matrix_cl<double> sigma_deriv_cl;
81
82 results(check_y_nonnegative, check_mu_finite, check_sigma_positive_finite,
83 any_y_zero_cl, lccdf_cl, y_deriv_cl, mu_deriv_cl, sigma_deriv_cl)
84 = expressions(y_nonnegative, mu_finite_expr, sigma_positive_finite_expr,
85 any_y_zero, lccdf_expr,
89
90 if (from_matrix_cl(any_y_zero_cl).maxCoeff()) {
91 return 0.0;
92 }
93
94 T_partials_return lccdf = N * LOG_HALF + sum(from_matrix_cl(lccdf_cl));
95
96 auto ops_partials = make_partials_propagator(y_col, mu_col, sigma_col);
97
99 partials<0>(ops_partials) = std::move(y_deriv_cl);
100 }
102 partials<1>(ops_partials) = std::move(mu_deriv_cl);
103 }
105 partials<2>(ops_partials) = std::move(sigma_deriv_cl);
106 }
107 return ops_partials.build(lccdf);
108}
109
110} // namespace math
111} // namespace stan
112#endif
113#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.
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
return_type_t< T_y_cl, T_loc_cl, T_scale_cl > lognormal_lccdf(const T_y_cl &y, const T_loc_cl &mu, const T_scale_cl &sigma)
Returns the lognormal log complementary cumulative distribution function for the given location,...
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.
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 LOG_HALF
The natural logarithm of 0.5, .
Definition constants.hpp:92
static constexpr double SQRT_TWO_OVER_SQRT_PI
The square root of 2 divided by the square root of , .
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:15
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.
fvar< T > sum(const std::vector< fvar< T > > &m)
Return the sum of the entries of the specified standard vector.
Definition sum.hpp:22
fvar< T > erfc(const fvar< T > &x)
Definition erfc.hpp:15
auto make_partials_propagator(Ops &&... ops)
Construct an partials_propagator.
fvar< T > square(const fvar< T > &x)
Definition square.hpp:12
fvar< T > exp(const fvar< T > &x)
Definition exp.hpp:13
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
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 ...