Stan Math Library  2.20.0
reverse mode automatic differentiation
corr_free.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_SCAL_FUN_CORR_FREE_HPP
2 #define STAN_MATH_PRIM_SCAL_FUN_CORR_FREE_HPP
3 
6 #include <cmath>
7 
8 namespace stan {
9 namespace math {
10 
27 template <typename T>
28 inline T corr_free(const T& y) {
29  check_bounded("lub_free", "Correlation variable", y, -1.0, 1.0);
30  return atanh(y);
31 }
32 
33 } // namespace math
34 } // namespace stan
35 #endif
fvar< T > atanh(const fvar< T > &x)
Return inverse hyperbolic tangent of specified value.
Definition: atanh.hpp:22
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.
T corr_free(const T &y)
Return the unconstrained scalar that when transformed to a valid correlation produces the specified v...
Definition: corr_free.hpp:28

     [ Stan Home Page ] © 2011–2018, Stan Development Team.