Automatic Differentiation
 
Loading...
Searching...
No Matches
corr_free.hpp
Go to the documentation of this file.
1#ifndef STAN_MATH_PRIM_CONSTRAINT_CORR_FREE_HPP
2#define STAN_MATH_PRIM_CONSTRAINT_CORR_FREE_HPP
3
4#include <stan/math/prim/meta.hpp>
5#include <stan/math/prim/err.hpp>
6#include <stan/math/prim/fun/atanh.hpp>
7
8namespace stan {
9namespace math {
10
27template <typename T>
28inline plain_type_t<T> corr_free(T&& y) {
29 auto&& y_ref = to_ref(std::forward<T>(y));
30 check_bounded("lub_free", "Correlation variable", y_ref, -1.0, 1.0);
31 return atanh(std::forward<decltype(y_ref)>(y_ref));
32}
33
34} // namespace math
35} // namespace stan
36#endif
stan::math::atanh
fvar< T > atanh(const fvar< T > &x)
Return inverse hyperbolic tangent of specified value.
Definition atanh.hpp:26
stan::math::check_bounded
void check_bounded(const char *function, const char *name, const T_y &y, const T_low &low, const T_high &high)
Check if the value is between the low and high values, inclusively.
Definition check_bounded.hpp:75
stan::math::corr_free
plain_type_t< T > corr_free(T &&y)
Return the unconstrained scalar that when transformed to a valid correlation produces the specified v...
Definition corr_free.hpp:28
stan::math::to_ref
ref_type_t< T && > to_ref(T &&a)
This evaluates expensive Eigen expressions.
Definition to_ref.hpp:18
stan::plain_type_t
typename plain_type< std::decay_t< T > >::type plain_type_t
Definition plain_type.hpp:23
stan
The lgamma implementation in stan-math is based on either the reentrant safe lgamma_r implementation ...
Definition unit_vector_constrain.hpp:15