tanh.hpp

Go to the documentation of this file.

/*################################################################################
  ##
  ##   Copyright (C) 2016-2024 Keith O'Hara
  ##
  ##   This file is part of the GCE-Math C++ library.
  ##
  ##   Licensed under the Apache License, Version 2.0 (the "License");
  ##   you may not use this file except in compliance with the License.
  ##   You may obtain a copy of the License at
  ##
  ##       http://www.apache.org/licenses/LICENSE-2.0
  ##
  ##   Unless required by applicable law or agreed to in writing, software
  ##   distributed under the License is distributed on an "AS IS" BASIS,
  ##   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ##   See the License for the specific language governing permissions and
  ##   limitations under the License.
  ##
  ################################################################################*/
 
/*
 * compile-time hyperbolic tangent function
 */
 
#ifndef _gcem_tanh_HPP
#define _gcem_tanh_HPP
 
#include <cmath>
#include <type_traits>
 
namespace gcem
{
 
namespace internal
{
 
#if __cplusplus >= 201402L // C++14 version
 
template<typename T>
constexpr
T
tanh_cf(const T xx, const int depth_end)
noexcept
{
    int depth = GCEM_TANH_MAX_ITER - 1;
    T res = T(2*(depth+1) - 1);
 
    while (depth > depth_end - 1) {
        res = T(2*depth - 1) + xx / res;
 
        --depth;
    }
 
    return res;
}
 
#else // C++11 version
 
template<typename T>
constexpr
T
tanh_cf(const T xx, const int depth)
noexcept
{
    return( depth < GCEM_TANH_MAX_ITER ? \
            // if
                (2*depth - 1) + xx/tanh_cf(xx,depth+1) :
            // else
                T(2*depth - 1) );
}
 
#endif
 
template<typename T>
constexpr
T
tanh_begin(const T x)
noexcept
{
    return( x/tanh_cf(x*x,1) );
}
 
template<typename T>
constexpr
T
tanh_check(const T x)
noexcept
{
    return( // NaN check
            is_nan(x) ? \
                GCLIM<T>::quiet_NaN() :
            // indistinguishable from zero
             GCLIM<T>::min() > abs(x) ? \
                T(0) :
             // else
                x < T(0) ? \
                    - tanh_begin(-x) : 
                      tanh_begin( x) );
}
 
}
 
/**
 * Compile-time hyperbolic tangent function
 *
 * @param x a real-valued input.
 * @return the hyperbolic tangent function using \f[ \tanh(x) = \dfrac{x}{1 + \dfrac{x^2}{3 + \dfrac{x^2}{5 + \dfrac{x^2}{7 + \ddots}}}} \f]
 */
 
template<typename T>
constexpr
return_t<T>
tanh(const T x)
noexcept
{
  if (std::is_constant_evaluated()) {
    return internal::tanh_check( static_cast<return_t<T>>(x) );
  } else {
    return std::tanh(x);
  }
}
 
}
 
#endif