tanh.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_FUN_TANH_HPP
#define STAN_MATH_PRIM_FUN_TANH_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/fun/exp.hpp>
#include <stan/math/prim/core/operator_division.hpp>
#include <stan/math/prim/functor/apply_scalar_unary.hpp>
#include <stan/math/prim/functor/apply_vector_unary.hpp>
#include <stan/math/prim/fun/to_ref.hpp>
#include <cmath>
#include <complex>
 
namespace stan {
namespace math {
 
template <typename T, require_arithmetic_t<T>* = nullptr>
inline auto tanh(T&& x) {
  return std::tanh(x);
}
 
template <typename T, require_complex_bt<std::is_arithmetic, T>* = nullptr>
inline auto tanh(T&& x) {
  return std::tanh(x);
}
 
struct tanh_fun {
  template <typename T>
  static inline auto fun(T&& x) {
    return tanh(std::forward<T>(x));
  }
};
 
template <typename Container, require_ad_container_t<Container>* = nullptr>
inline auto tanh(Container&& x) {
  return apply_scalar_unary<tanh_fun, Container>::apply(
      std::forward<Container>(x));
}
 
template <typename Container,
          require_container_bt<std::is_arithmetic, Container>* = nullptr>
inline auto tanh(Container&& x) {
  auto&& x_ref = to_ref(std::forward<Container>(x));
  return apply_vector_unary<decltype(x_ref)>::apply(
      std::forward<decltype(x_ref)>(x_ref),
      [](auto&& v) { return v.array().tanh(); });
}
 
namespace internal {
template <typename V>
inline std::complex<V> complex_tanh(const std::complex<V>& z) {
  auto exp_z = exp(z);
  auto exp_neg_z = exp(-z);
  return stan::math::internal::complex_divide(exp_z - exp_neg_z,
                                              exp_z + exp_neg_z);
}
}  // namespace internal
 
}  // namespace math
}  // namespace stan
 
#endif