log.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2021 Tobias Hienzsch
 
#ifndef TETL_CMATH_LOG_HPP
#define TETL_CMATH_LOG_HPP
 
#include <etl/_config/all.hpp>
 
#include <etl/_3rd_party/gcem/gcem.hpp>
#include <etl/_concepts/integral.hpp>
#include <etl/_type_traits/is_constant_evaluated.hpp>
 
namespace etl {
 
namespace detail {
 
inline constexpr struct log {
    template <typename Float>
    [[nodiscard]] constexpr auto operator()(Float v) const noexcept -> Float
    {
        if (not is_constant_evaluated()) {
#if __has_builtin(__builtin_logf)
            if constexpr (is_same_v<Float, float>) {
                return __builtin_logf(v);
            }
#endif
#if __has_builtin(__builtin_log)
            if constexpr (is_same_v<Float, double>) {
                return __builtin_log(v);
            }
#endif
        }
 
        return etl::detail::gcem::log(v);
    }
} log;
 
} // namespace detail
 
/// \ingroup cmath
/// @{
 
/// Computes the natural (base e) logarithm of arg.
/// \details https://en.cppreference.com/w/cpp/numeric/math/log
[[nodiscard]] constexpr auto log(float v) noexcept -> float
{
    return etl::detail::log(v);
}
[[nodiscard]] constexpr auto logf(float v) noexcept -> float
{
    return etl::detail::log(v);
}
[[nodiscard]] constexpr auto log(double v) noexcept -> double
{
    return etl::detail::log(v);
}
[[nodiscard]] constexpr auto log(long double v) noexcept -> long double
{
    return etl::detail::log(v);
}
[[nodiscard]] constexpr auto logl(long double v) noexcept -> long double
{
    return etl::detail::log(v);
}
[[nodiscard]] constexpr auto log(integral auto arg) noexcept -> double
{
    return etl::detail::log(double(arg));
}
 
/// @}
 
} // namespace etl
 
#endif // TETL_CMATH_LOG_HPP