s24x8.h

Go to the documentation of this file.

#pragma once
 
// Signed 24.8 fixed-point arithmetic and trigonometry.
// All operations are integer-only in the hot path.
 
#include "fl/stl/int.h"
#include "fl/math/sin32.h"
#include "fl/math/fixed_point/isqrt.h"
#include "fl/stl/compiler_control.h"
#include "fl/math/fixed_point/traits.h"
#include "fl/stl/noexcept.h"
#include "fl/stl/undef.h"  // Undefine abs/min/max macros from Arduino.h
 
FL_OPTIMIZATION_LEVEL_O3_BEGIN
 
namespace fl {
 
// Signed 24.8 fixed-point value type.
class s24x8 {
  public:
    static constexpr int INT_BITS = 24;
    static constexpr int FRAC_BITS = 8;
    static constexpr i32 SCALE = static_cast<i32>(1) << FRAC_BITS;
 
    // ---- Construction ------------------------------------------------------
 
    constexpr s24x8() FL_NOEXCEPT = default;
 
    explicit constexpr s24x8(float f) FL_NOEXCEPT
        : mValue(static_cast<i32>(f * (SCALE))) {}
 
    // Integer constructor — any integer width (portable: AVR 16-bit int, ARM/x86 32-bit).
    // Compile error if constexpr value exceeds INT_BITS range.
    template <typename IntT, detail::enable_if_integer_t<IntT> = 0>
    explicit constexpr s24x8(IntT n) FL_NOEXCEPT
        : mValue(detail::int_to_fixed<INT_BITS, FRAC_BITS>::from_signed(n)) {}
 
    // Auto-promotion from other fixed-point types
    template <typename OtherFP>
    constexpr s24x8(const OtherFP& other,
                    typename fl::enable_if<
                        (OtherFP::INT_BITS <= INT_BITS) &&
                        (OtherFP::FRAC_BITS <= FRAC_BITS) &&
                        (OtherFP::INT_BITS != INT_BITS || OtherFP::FRAC_BITS != FRAC_BITS),
                        int>::type = 0)
 FL_NOEXCEPT : mValue(static_cast<i32>(
            static_cast<i64>(other.raw()) << (FRAC_BITS - OtherFP::FRAC_BITS))) {}
 
    // Raw constructor for C++11 constexpr from_raw
    struct RawTag {};
    constexpr explicit s24x8(i32 raw, RawTag) FL_NOEXCEPT : mValue(raw) {}
 
    static constexpr FASTLED_FORCE_INLINE s24x8 from_raw(i32 raw) FL_NOEXCEPT {
        return s24x8(raw, RawTag());
    }
 
    // ---- Access ------------------------------------------------------------
 
    constexpr i32 raw() const FL_NOEXCEPT { return mValue; }
    constexpr i32 to_int() const FL_NOEXCEPT { return mValue >> FRAC_BITS; }
    constexpr float to_float() const FL_NOEXCEPT { return static_cast<float>(mValue) / (SCALE); }
 
    // ---- Fixed-point arithmetic --------------------------------------------
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator*(s24x8 b) const FL_NOEXCEPT {
        return from_raw(static_cast<i32>(
            (static_cast<i64>(mValue) * b.mValue) >> FRAC_BITS));
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator/(s24x8 b) const FL_NOEXCEPT {
        return from_raw(static_cast<i32>(
            (static_cast<i64>(mValue) * (static_cast<i64>(SCALE))) / b.mValue));
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator+(s24x8 b) const FL_NOEXCEPT {
        return from_raw(static_cast<i32>(
            static_cast<u32>(mValue) + static_cast<u32>(b.mValue)));
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator-(s24x8 b) const FL_NOEXCEPT {
        return from_raw(static_cast<i32>(
            static_cast<u32>(mValue) - static_cast<u32>(b.mValue)));
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator-() const FL_NOEXCEPT {
        return from_raw(static_cast<i32>(0u - static_cast<u32>(mValue)));
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator>>(int shift) const FL_NOEXCEPT {
        return from_raw(mValue >> shift);
    }
 
    // ---- Scalar multiply (no fixed-point shift) ----------------------------
 
    constexpr FASTLED_FORCE_INLINE s24x8 operator*(i32 scalar) const FL_NOEXCEPT {
        return from_raw(mValue * scalar);
    }
 
    friend constexpr s24x8 operator*(i32 scalar, s24x8 fp) FL_NOEXCEPT {
        return s24x8::from_raw(scalar * fp.mValue);
    }
 
    // ---- Comparisons -------------------------------------------------------
 
    constexpr bool operator<(s24x8 b) const FL_NOEXCEPT { return mValue < b.mValue; }
    constexpr bool operator>(s24x8 b) const FL_NOEXCEPT { return mValue > b.mValue; }
    constexpr bool operator<=(s24x8 b) const FL_NOEXCEPT { return mValue <= b.mValue; }
    constexpr bool operator>=(s24x8 b) const FL_NOEXCEPT { return mValue >= b.mValue; }
    constexpr bool operator==(s24x8 b) const FL_NOEXCEPT { return mValue == b.mValue; }
    constexpr bool operator!=(s24x8 b) const FL_NOEXCEPT { return mValue != b.mValue; }
 
    // ---- Math ---------------------------------------------------------------
 
    static constexpr FASTLED_FORCE_INLINE s24x8 mod(s24x8 a, s24x8 b) FL_NOEXCEPT {
        return from_raw(a.mValue % b.mValue);
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 floor(s24x8 x) FL_NOEXCEPT {
        return from_raw(x.mValue & ~(i32((SCALE) - 1)));
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 ceil(s24x8 x) FL_NOEXCEPT {
        return from_raw((x.mValue & ~(i32((SCALE) - 1))) +
                        ((x.mValue & i32((SCALE) - 1)) ? (SCALE) : 0));
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 fract(s24x8 x) FL_NOEXCEPT {
        return from_raw(x.mValue & i32((SCALE) - 1));
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 abs(s24x8 x) FL_NOEXCEPT {
        return from_raw(x.mValue < 0 ? -x.mValue : x.mValue);
    }
 
    static constexpr FASTLED_FORCE_INLINE int sign(s24x8 x) FL_NOEXCEPT {
        return x.mValue > 0 ? 1 : (x.mValue < 0 ? -1 : 0);
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 lerp(s24x8 a, s24x8 b, s24x8 t) FL_NOEXCEPT {
        return a + (b - a) * t;
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 clamp(s24x8 x, s24x8 lo, s24x8 hi) FL_NOEXCEPT {
        return x < lo ? lo : (x > hi ? hi : x);
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 step(s24x8 edge, s24x8 x) FL_NOEXCEPT {
        return x < edge ? s24x8() : s24x8(1.0f);
    }
 
    static FASTLED_FORCE_INLINE s24x8 smoothstep(s24x8 edge0, s24x8 edge1, s24x8 x) FL_NOEXCEPT {
        constexpr s24x8 zero(0.0f);
        constexpr s24x8 one(1.0f);
        constexpr s24x8 two(2.0f);
        constexpr s24x8 three(3.0f);
        s24x8 t = clamp((x - edge0) / (edge1 - edge0), zero, one);
        return t * t * (three - two * t);
    }
 
    // ---- Inverse Trigonometry (pure fixed-point) ----------------------------
 
    static FASTLED_FORCE_INLINE s24x8 atan(s24x8 x) FL_NOEXCEPT {
        constexpr s24x8 one(1.0f);
        constexpr s24x8 pi_over_2(1.5707963f);
        bool neg = x.mValue < 0;
        s24x8 ax = abs(x);
        s24x8 result;
        if (ax <= one) {
            result = atan_unit(ax);
        } else {
            result = pi_over_2 - atan_unit(one / ax);
        }
        return neg ? -result : result;
    }
 
    static FASTLED_FORCE_INLINE s24x8 atan2(s24x8 y, s24x8 x) FL_NOEXCEPT {
        constexpr s24x8 pi(3.1415926f);
        constexpr s24x8 pi_over_2(1.5707963f);
        if (x.mValue == 0 && y.mValue == 0) return s24x8();
        if (x.mValue == 0) return y.mValue > 0 ? pi_over_2 : -pi_over_2;
        if (y.mValue == 0) return x.mValue > 0 ? s24x8() : pi;
        s24x8 ax = abs(x);
        s24x8 ay = abs(y);
        s24x8 a;
        if (ax >= ay) {
            a = atan_unit(ay / ax);
        } else {
            a = pi_over_2 - atan_unit(ax / ay);
        }
        if (x.mValue < 0) a = pi - a;
        if (y.mValue < 0) a = -a;
        return a;
    }
 
    static FASTLED_FORCE_INLINE s24x8 asin(s24x8 x) FL_NOEXCEPT {
        constexpr s24x8 one(1.0f);
        return atan2(x, sqrt(one - x * x));
    }
 
    static FASTLED_FORCE_INLINE s24x8 acos(s24x8 x) FL_NOEXCEPT {
        constexpr s24x8 one(1.0f);
        return atan2(sqrt(one - x * x), x);
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 sqrt(s24x8 x) FL_NOEXCEPT {
        return x.mValue <= 0 ? s24x8() : from_raw(static_cast<i32>(
            fl::isqrt64(static_cast<u64>(x.mValue) << FRAC_BITS)));
    }
 
    static constexpr FASTLED_FORCE_INLINE s24x8 rsqrt(s24x8 x) FL_NOEXCEPT {
        return sqrt(x).mValue == 0
            ? s24x8()
            : from_raw(SCALE) / sqrt(x);
    }
 
    static FASTLED_FORCE_INLINE s24x8 pow(s24x8 base, s24x8 exp) FL_NOEXCEPT {
        if (base.mValue <= 0) return s24x8();
        constexpr s24x8 one(1.0f);
        if (exp.mValue == 0) return one;
        if (base == one) return one;
        // Snap base values within ~2 ULPs of 1.0 to exactly 1.0 to dodge the
        // log2(1+t) minimax polynomial's upper-endpoint residual (#2969).
        constexpr i32 kOneRaw = static_cast<i32>(SCALE);
        if (base.mValue >= (kOneRaw - 2) && base.mValue <= kOneRaw) {
            return one;
        }
        return exp2_fp(exp * log2_fp(base));
    }
 
    // ---- Member function versions (operate on *this) -----------------------
 
    constexpr FASTLED_FORCE_INLINE s24x8 floor() const FL_NOEXCEPT {
        return floor(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 ceil() const FL_NOEXCEPT {
        return ceil(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 fract() const FL_NOEXCEPT {
        return fract(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 abs() const FL_NOEXCEPT {
        return abs(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE int sign() const FL_NOEXCEPT {
        return sign(*this);
    }
 
    FASTLED_FORCE_INLINE s24x8 sin() const FL_NOEXCEPT {
        return sin(*this);
    }
 
    FASTLED_FORCE_INLINE s24x8 cos() const FL_NOEXCEPT {
        return cos(*this);
    }
 
    FASTLED_FORCE_INLINE s24x8 atan() const FL_NOEXCEPT {
        return atan(*this);
    }
 
    FASTLED_FORCE_INLINE s24x8 asin() const FL_NOEXCEPT {
        return asin(*this);
    }
 
    FASTLED_FORCE_INLINE s24x8 acos() const FL_NOEXCEPT {
        return acos(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 sqrt() const FL_NOEXCEPT {
        return sqrt(*this);
    }
 
    constexpr FASTLED_FORCE_INLINE s24x8 rsqrt() const FL_NOEXCEPT {
        return rsqrt(*this);
    }
 
    // ---- Trigonometry ------------------------------------------------------
 
    static FASTLED_FORCE_INLINE s24x8 sin(s24x8 angle) FL_NOEXCEPT {
        return from_raw(fl::sin32(angle_to_a24(angle)) >> (31 - FRAC_BITS));
    }
 
    static FASTLED_FORCE_INLINE s24x8 cos(s24x8 angle) FL_NOEXCEPT {
        return from_raw(fl::cos32(angle_to_a24(angle)) >> (31 - FRAC_BITS));
    }
 
    // Combined sin+cos from s24x8 radians. Output in s24x8 [-1, 1].
    static FASTLED_FORCE_INLINE void sincos(s24x8 angle, s24x8 &out_sin,
                                            s24x8 &out_cos) FL_NOEXCEPT {
        u32 a24 = angle_to_a24(angle);
        out_sin = from_raw(fl::sin32(a24) >> (31 - FRAC_BITS));
        out_cos = from_raw(fl::cos32(a24) >> (31 - FRAC_BITS));
    }
 
  private:
    i32 mValue = 0;
 
    // Returns 0-based position of highest set bit, or -1 if v==0.
    static constexpr FASTLED_FORCE_INLINE int highest_bit(u32 v) FL_NOEXCEPT {
        return v == 0 ? -1 : _highest_bit_step(v, 0);
    }
 
    static constexpr int _highest_bit_step(u32 v, int r) FL_NOEXCEPT {
        return (v & 0xFFFF0000u) ? _highest_bit_step(v >> 16, r + 16)
             : (v & 0x0000FF00u) ? _highest_bit_step(v >> 8,  r + 8)
             : (v & 0x000000F0u) ? _highest_bit_step(v >> 4,  r + 4)
             : (v & 0x0000000Cu) ? _highest_bit_step(v >> 2,  r + 2)
             : (v & 0x00000002u) ? r + 1
             : r;
    }
 
    // Fixed-point log base 2 for positive values.
    // Uses 4-term minimax polynomial for log2(1+t), t in [0,1).
    // Horner evaluation uses i64 intermediates (16 frac bits) to minimize
    // rounding error, then converts back to 8 frac bits.
    static FASTLED_FORCE_INLINE s24x8 log2_fp(s24x8 x) FL_NOEXCEPT {
        u32 val = static_cast<u32>(x.mValue);
        int msb = highest_bit(val);
        i32 int_part = msb - FRAC_BITS;
        i32 t;
        if (msb >= FRAC_BITS) {
            t = static_cast<i32>(
                (val >> (msb - FRAC_BITS)) - (SCALE));
        } else {
            t = static_cast<i32>(
                (val << (FRAC_BITS - msb)) - (SCALE));
        }
        // 4-term minimax coefficients for log2(1+t), t in [0,1).
        // Stored as i64 with 16 fractional bits.
        constexpr int IFRAC = 16;
        constexpr i64 c0 = 94528LL;    // 1.44179 * 2^16
        constexpr i64 c1 = -45814LL;   // -0.69907 * 2^16
        constexpr i64 c2 = 23821LL;    // 0.36348 * 2^16
        constexpr i64 c3 = -6986LL;    // -0.10660 * 2^16
        // Extend t from 8 to 16 frac bits.
        i64 t16 = static_cast<i64>(t) << (IFRAC - FRAC_BITS);
        // Horner: t * (c0 + t * (c1 + t * (c2 + t * c3)))
        i64 acc = c3;
        acc = c2 + ((acc * t16) >> IFRAC);
        acc = c1 + ((acc * t16) >> IFRAC);
        acc = c0 + ((acc * t16) >> IFRAC);
        i64 frac_part = (acc * t16) >> IFRAC;
        // Convert from 16 frac bits back to 8.
        i32 frac8 = static_cast<i32>(frac_part >> (IFRAC - FRAC_BITS));
        return from_raw(static_cast<i32>(static_cast<u32>(int_part) << FRAC_BITS) + frac8);
    }
 
    // Fixed-point 2^x. Uses 4-term minimax polynomial for 2^t, t in [0,1).
    // Horner evaluation uses i64 intermediates (16 frac bits) to minimize
    // rounding error, then converts back to 8 frac bits.
    static FASTLED_FORCE_INLINE s24x8 exp2_fp(s24x8 x) FL_NOEXCEPT {
        s24x8 fl_val = floor(x);
        s24x8 fr = x - fl_val;
        i32 n = fl_val.mValue >> FRAC_BITS;
        if (n >= INT_BITS - 1) return from_raw(0x7FFFFFFF);
        if (n < -FRAC_BITS) return s24x8();
        i32 int_pow = 0;
        if (n >= 0) {
            int_pow = static_cast<i32>(SCALE) << n;
        } else {
            int_pow = static_cast<i32>(SCALE) >> (-n);
        }
        // 4-term minimax coefficients for 2^t - 1, t in [0,1).
        // Stored as i64 with 16 fractional bits.
        constexpr int IFRAC = 16;
        constexpr i64 d0 = 45427LL;    // 0.69316 * 2^16
        constexpr i64 d1 = 15775LL;    // 0.24071 * 2^16
        constexpr i64 d2 = 3497LL;     // 0.05336 * 2^16
        constexpr i64 d3 = 836LL;      // 0.01276 * 2^16
        // Extend fr from 8 to 16 frac bits.
        i64 fr16 = static_cast<i64>(fr.mValue) << (IFRAC - FRAC_BITS);
        // Horner: 1 + fr * (d0 + fr * (d1 + fr * (d2 + fr * d3)))
        i64 acc = d3;
        acc = d2 + ((acc * fr16) >> IFRAC);
        acc = d1 + ((acc * fr16) >> IFRAC);
        acc = d0 + ((acc * fr16) >> IFRAC);
        constexpr i64 one16 = 1LL << IFRAC;
        i64 frac_pow16 = one16 + ((acc * fr16) >> IFRAC);
        // Convert from 16 frac bits to 8 frac bits, then scale by int_pow.
        i32 frac_pow8 = static_cast<i32>(frac_pow16 >> (IFRAC - FRAC_BITS));
        i64 result =
            (static_cast<i64>(int_pow) * frac_pow8) >> FRAC_BITS;
        return from_raw(static_cast<i32>(result));
    }
 
    // Converts s24x8 radians to sin32/cos32 input format.
    // 2^24/(2*PI) — converts radians to sin32/cos32 format.
    static constexpr i32 RAD_TO_24 = 2670177;
    static constexpr FASTLED_FORCE_INLINE u32 angle_to_a24(s24x8 angle) FL_NOEXCEPT {
        return static_cast<u32>(
            (static_cast<i64>(angle.mValue) * RAD_TO_24) >> FRAC_BITS);
    }
 
    // Polynomial atan for t in [0, 1]. Returns [0, π/4].
    // 7th-order minimax: atan(t) ≈ t * (c0 + t² * (c1 + t² * (c2 + t² * c3)))
    // Coefficients optimized via coordinate descent on s16x16 quantization grid.
    static FASTLED_FORCE_INLINE s24x8 atan_unit(s24x8 t) FL_NOEXCEPT {
        constexpr s24x8 c0(0.9998779297f);
        constexpr s24x8 c1(-0.3269348145f);
        constexpr s24x8 c2(0.1594085693f);
        constexpr s24x8 c3(-0.0472106934f);
        s24x8 t2 = t * t;
        return t * (c0 + t2 * (c1 + t2 * (c2 + t2 * c3)));
    }
};
 
} // namespace fl
 
FL_OPTIMIZATION_LEVEL_O3_END