Automatic Differentiation
 
Loading...
Searching...
No Matches
weibull_cdf.hpp
Go to the documentation of this file.
1#ifndef STAN_MATH_PRIM_PROB_WEIBULL_CDF_HPP
2#define STAN_MATH_PRIM_PROB_WEIBULL_CDF_HPP
3
17#include <cmath>
18
19namespace stan {
20namespace math {
21
36template <typename T_y, typename T_shape, typename T_scale,
38 T_y, T_shape, T_scale>* = nullptr>
40 const T_shape& alpha,
41 const T_scale& sigma) {
42 using T_partials_return = partials_return_t<T_y, T_shape, T_scale>;
43 using T_y_ref = ref_type_if_not_constant_t<T_y>;
44 using T_alpha_ref = ref_type_if_not_constant_t<T_shape>;
45 using T_sigma_ref = ref_type_if_not_constant_t<T_scale>;
46 static constexpr const char* function = "weibull_cdf";
47
48 T_y_ref y_ref = y;
49 T_alpha_ref alpha_ref = alpha;
50 T_sigma_ref sigma_ref = sigma;
51
52 decltype(auto) y_val = to_ref(as_value_column_array_or_scalar(y_ref));
53 decltype(auto) alpha_val = to_ref(as_value_column_array_or_scalar(alpha_ref));
54 decltype(auto) sigma_val = to_ref(as_value_column_array_or_scalar(sigma_ref));
55
56 check_nonnegative(function, "Random variable", y_val);
57 check_positive_finite(function, "Shape parameter", alpha_val);
58 check_positive_finite(function, "Scale parameter", sigma_val);
59
60 if (size_zero(y, alpha, sigma)) {
61 return 1.0;
62 }
63
64 auto ops_partials = make_partials_propagator(y_ref, alpha_ref, sigma_ref);
65 if (any(value_of_rec(y_val) == 0)) {
66 return ops_partials.build(0.0);
67 }
68
69 constexpr bool any_derivs = !is_constant_all<T_y, T_shape, T_scale>::value;
70 const auto& log_y = to_ref_if<any_derivs>(log(y_val));
71 const auto& log_sigma = to_ref_if<any_derivs>(log(sigma_val));
72 const auto& log_y_div_sigma = to_ref_if<any_derivs>(log_y - log_sigma);
73 const auto& log_pow_n = to_ref_if<any_derivs>(alpha_val * log_y_div_sigma);
74 const auto& pow_n = to_ref_if<any_derivs>(exp(log_pow_n));
75 const auto& log_cdf_n = to_ref_if<any_derivs>(log1m_exp(-pow_n));
76
77 T_partials_return log_cdf = sum(log_cdf_n);
78
79 if (any_derivs) {
80 const auto& log_rep_deriv = to_ref(log_pow_n + log_cdf - log_cdf_n - pow_n);
82 const auto& log_deriv_y_sigma = to_ref(log_rep_deriv + log(alpha_val));
84 partials<0>(ops_partials) = exp(log_deriv_y_sigma - log_y);
85 }
87 partials<2>(ops_partials) = -exp(log_deriv_y_sigma - log_sigma);
88 }
89 }
91 partials<1>(ops_partials) = exp(log_rep_deriv) * log_y_div_sigma;
92 }
93 }
94 return ops_partials.build(exp(log_cdf));
95}
96
97} // namespace math
98} // namespace stan
99#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_shape_cl, T_scale_cl > weibull_cdf(const T_y_cl &y, const T_shape_cl &alpha, const T_scale_cl &sigma)
Returns the weibull cumulative distribution function for the given location, and scale.
typename return_type< Ts... >::type return_type_t
Convenience type for the return type of the specified template parameters.
double value_of_rec(const fvar< T > &v)
Return the value of the specified variable.
void check_nonnegative(const char *function, const char *name, const T_y &y)
Check if y is non-negative.
bool size_zero(const T &x)
Returns 1 if input is of length 0, returns 0 otherwise.
Definition size_zero.hpp:19
fvar< T > log1m_exp(const fvar< T > &x)
Return the natural logarithm of one minus the exponentiation of the specified argument.
Definition log1m_exp.hpp:22
constexpr bool any(T x)
Return true if any values in the input are true.
Definition any.hpp:21
fvar< T > log(const fvar< T > &x)
Definition log.hpp:18
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...
ref_type_t< T && > to_ref(T &&a)
This evaluates expensive Eigen expressions.
Definition to_ref.hpp:17
auto sum(const std::vector< T > &m)
Return the sum of the entries of the specified standard vector.
Definition sum.hpp:23
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 > exp(const fvar< T > &x)
Definition exp.hpp:15
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 ...
Extends std::true_type when instantiated with zero or more template parameters, all of which extend t...