math/corr__free_8hpp_source.html

#ifndef STAN_MATH_PRIM_CONSTRAINT_CORR_FREE_HPP

#define STAN_MATH_PRIM_CONSTRAINT_CORR_FREE_HPP


#include <stan/math/prim/meta.hpp>

#include <stan/math/prim/err.hpp>

#include <stan/math/prim/fun/atanh.hpp>


namespace stan {

namespace math {


template <typename T>

inline plain_type_t<T> corr_free(const T& y) {

  check_bounded("lub_free", "Correlation variable", y, -1.0, 1.0);

  return atanh(y);

}


}  // namespace math

}  // namespace stan

#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(const T &y)
Return the unconstrained scalar that when transformed to a valid correlation produces the specified v...
Definition corr_free.hpp:28

stan::plain_type_t
typename plain_type< T >::type plain_type_t
Definition plain_type.hpp:22

stan
The lgamma implementation in stan-math is based on either the reentrant safe lgamma_r implementation ...
Definition unit_vector_constrain.hpp:15

err.hpp

atanh.hpp

meta.hpp