WPILibC++ 2024.3.2
asinh.hpp
Go to the documentation of this file.
1/*################################################################################
2 ##
3 ## Copyright (C) 2016-2023 Keith O'Hara
4 ##
5 ## This file is part of the GCE-Math C++ library.
6 ##
8 ## you may not use this file except in compliance with the License.
9 ## You may obtain a copy of the License at
10 ##
12 ##
13 ## Unless required by applicable law or agreed to in writing, software
15 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 ## See the License for the specific language governing permissions and
17 ## limitations under the License.
18 ##
19 ################################################################################*/
20
21/*
22 * compile-time inverse hyperbolic sine function
23 */
24
25#ifndef _gcem_asinh_HPP
26#define _gcem_asinh_HPP
27
28#include <cmath>
29#include <type_traits>
30
31namespace gcem
32{
33
34namespace internal
35{
36
37template<typename T>
38constexpr
39T
40asinh_compute(const T x)
41noexcept
42{
43 return( // NaN check
44 is_nan(x) ? \
46 // indistinguishable from zero
47 GCLIM<T>::min() > abs(x) ? \
48 T(0) :
49 // else
50 log( x + sqrt(x*x + T(1)) ) );
51}
52
53}
54
55/**
56 * Compile-time inverse hyperbolic sine function
57 *
58 * @param x a real-valued input.
59 * @return the inverse hyperbolic sine function using \f[ \text{asinh}(x) = \ln \left( x + \sqrt{x^2 + 1} \right) \f]
60 */
61
62template<typename T>
63constexpr
64return_t<T>
65asinh(const T x)
66noexcept
67{
69 return internal::asinh_compute( static_cast<return_t<T>>(x) );
70 } else {
71 return std::asinh(x);
72 }
73}
74
75}
76
77#endif
constexpr FMT_INLINE auto is_constant_evaluated(bool default_value=false) noexcept -> bool
Definition: core.h:304
constexpr bool is_nan(const T x) noexcept
Definition: is_nan.hpp:39
constexpr T asinh_compute(const T x) noexcept
Definition: asinh.hpp:40
Definition: is_even.hpp:29
constexpr T abs(const T x) noexcept
Compile-time absolute value function.
Definition: abs.hpp:40
constexpr return_t< T > log(const T x) noexcept
Compile-time natural logarithm function.
Definition: log.hpp:186
constexpr return_t< T > sqrt(const T x) noexcept
Compile-time square-root function.
Definition: sqrt.hpp:109
std::numeric_limits< T > GCLIM
Definition: gcem_options.hpp:74
constexpr return_t< T > asinh(const T x) noexcept
Compile-time inverse hyperbolic sine function.
Definition: asinh.hpp:65
typename std::conditional< std::is_integral< T >::value, double, T >::type return_t
Definition: gcem_options.hpp:77