shz_scalar.hpp

Go to the documentation of this file.

/*! \file
 *  \brief   C++ scalar math API.
 *  \ingroup scalar
 *
 *  This file provides a collection of general-purpose math routines for
 *  individual scalar values in C++23.
 *
 *  \author    2025, 2026 Falco Girgis
 *  \author          2026 Aleios
 *  \copyright MIT License
 */
 
#ifndef SHZ_SCALAR_HPP
#define SHZ_SCALAR_HPP
 
#include "shz_scalar.h"
 
namespace shz {
    constexpr float fipr_max_error = 0.1f; // Not accurate yet. lol.
 
    /*! \name  Comparisons
        \brief Routines for comparing and classifying floating-point values.
        @{
    */
    //! C++ alias for shz_fminf()
    constexpr auto fminf       = shz_fminf;
    //! C++ alias for shz_fmaxf()
    constexpr auto fmaxf       = shz_fmaxf;
    //! C++ alias for shz_equalf()
    constexpr auto equalf      = shz_equalf;
    //! C++ alias for shz_equalf_abs()
    constexpr auto equalf_abs  = shz_equalf_abs;
    //! C++ alias for shz_equalf_rel()
    constexpr auto equalf_rel  = shz_equalf_rel;
    //! @}
 
    /*! \name  Rounding
        \brief Routines for rounding floats.
        @{
    */
    //! C++ alias for shz_floorf().
    constexpr auto floorf     = shz_floorf;
    //! C++ alias for shz_ceilf().
    constexpr auto ceilf      = shz_ceilf;
    //! C++ alias for shz_roundf().
    constexpr auto roundf     = shz_roundf;
    //! C++ alias for shz_truncf().
    constexpr auto truncf     = shz_truncf;
    //! C++ alias for shz_remainderf().
    constexpr auto remainderf = shz_remainderf;
    //! C++ alias for shz_fmodf().
    constexpr auto fmodf      = shz_fmodf;
    //! C++ alias for shz_remquof().
    constexpr auto remquof    = shz_remquof;
    //! @}
 
    /*! \name  Mapping
        \brief Routines for mapping a number to another range.
        @{
    */
    //! C++ alias for shz_clampf().
    constexpr auto clampf             = shz_clampf;
    //! C++ alias for shz_normalizef().
    constexpr auto normalizef         = shz_normalizef;
    //! C++ alias for shz_normalizef_fsrra().
    constexpr auto normalizef_fsrra   = shz_normalizef_fsrra;
    //! C++ alias for shz_remapf().
    constexpr auto remapf             = shz_remapf;
    //! C++ alias for shz_remapf_fsrra().
    constexpr auto remapf_fsrra       = shz_remapf_fsrra;
    //! C++ alias for shz_wrapf().
    constexpr auto wrapf              = shz_wrapf;
    //! C++ alias for shz_wrapf_fsrra().
    constexpr auto wrapf_fsrra        = shz_wrapf_fsrra;
    //! C++ alias for shz_fractf().
    constexpr auto fractf            = shz_fractf;
    //! C++ alias for shz_signf().
    constexpr auto signf             = shz_signf;
    //! C++ alias for shz_saturatef().
    constexpr auto saturatef         = shz_saturatef;
    //! @}
 
    /*! \name  Miscellaneous
        \brief Fast versions of miscellaneous FP routines.
        @{
    */
    //! C++ alias for shz_fabsf().
    constexpr auto fabsf             = shz_fabsf;
    //! C++ alias for shz_copysignf().
    constexpr auto copysignf         = shz_copysignf;
    //! C++ alias for shz_fmacf().
    constexpr auto fmaf              = shz_fmaf;
    //! C++ alias for shz_fdimf().
    constexpr auto fdimf             = shz_fdimf;
    //! C++ alias for shz_hypotf().
    constexpr auto hypotf            = shz_hypotf;
    //! C++ wrapper for shz_cbrtf().
    SHZ_FORCE_INLINE float cbrtf(float x) noexcept { return shz_cbrtf(x); }
    //! C++ alias for shz_lerpf().
    constexpr auto lerpf             = shz_lerpf;
    //! C++ alias for shz_barycentric_lerpf().
    constexpr auto barycentric_lerpf = shz_barycentric_lerpf;
    //! C++ alias for shz_quadratic_roots().
    constexpr auto quadratic_roots   = shz_quadratic_roots;
    //! C++ alias for shz_randf().
    constexpr auto randf             = shz_randf;
    //! C++ alias for shz_randf_range()
    constexpr auto randf_range       = shz_randf_range;
    //! C++ alias for shz_stepf()
    constexpr auto stepf             = shz_stepf;
    //! C++ alias for shz_smoothstepf()
    constexpr auto smoothstepf       = shz_smoothstepf;
    //! C++ alias for shz_smoothstepf_safe()
    constexpr auto smoothstepf_safe  = shz_smoothstepf_safe;
 
    //! @}
 
    /*! \name  FSRRA
        \brief Routines built around fast reciprocal square root.
        @{
    */
    //! C++ alias for shz_inv_sqrtf_fsrra().
    constexpr auto inv_sqrtf_fsrra = shz_inv_sqrtf_fsrra;
    //! C++ alias for shz_inv_sqrtf().
    constexpr auto inv_sqrtf       = shz_inv_sqrtf;
    //! C++ alias for shz_sqrtf_fsrra().
    constexpr auto sqrtf_fsrra     = shz_sqrtf_fsrra;
    //! C++ alias for shz_sqrtf().
    constexpr auto sqrtf           = shz_sqrtf;
    //! C++ alias for shz_invf_fsrra().
    constexpr auto invf_fsrra      = shz_invf_fsrra;
    //! C++ alias for shz_invf().
    constexpr auto invf            = shz_invf;
    //! C++ alias for shz_divf_fsrra().
    constexpr auto divf_fsrra      = shz_divf_fsrra;
    //! C++ alias for shz_divf().
    constexpr auto divf            = shz_divf;
    //! @}
 
    /*! \name  FIPR
        \brief Routines built around fast 4D dot product.
        @{
    */
    //! C++ alias for shz_dot6f().
    constexpr auto dot6f    = shz_dot6f;
    //! C++ alias for shz_dot8f().
    constexpr auto dot8f     = shz_dot8f;
    //! C++ alias for shz_mag_sqr3f().
    constexpr auto mag_sqr3f = shz_mag_sqr3f;
    //! C++ alias for shz_mag_sqr4f().
    constexpr auto mag_sqr4f = shz_mag_sqr4f;
    //! @}
 
    /*! \name  Transcendental
        \brief Routines for accelerating transcendental functions.
        @{
    */
    //! C++ alias for shz_pow2f().
    constexpr auto pow2f  = shz_pow2f;
    //! C++ alias for shz_powf().
    constexpr auto powf   = shz_powf;
    //! C++ alias for shz_pow10f().
    constexpr auto pow10f = shz_pow10f;
    //! C++ alias for shz_log2f().
    constexpr auto log2f  = shz_log2f;
    //! C++ alias for shz_logf().
    constexpr auto logf   = shz_logf;
    //! C++ alias for shz_log10f().
    constexpr auto log10f = shz_log10f;
    // C++ alias for shz_expf()
    constexpr auto expf   = shz_expf;
    //! @}
}
 
#endif