#pragma once #include "Details.h" #include "SFixedBase.h" FIXED_POINTS_BEGIN_NAMESPACE // // Declaration // template< unsigned Integer, unsigned Fraction > class SFixed : FIXED_POINTS_DETAILS::SFixedBase< Integer, Fraction > { public: static_assert(((Integer + 1) + Fraction) <= FIXED_POINTS_DETAILS::BitSize::Value, "Platform does not have a native type large enough for SFixed."); public: using IntegerType = FIXED_POINTS_DETAILS::LeastInt; using FractionType = FIXED_POINTS_DETAILS::LeastUInt; using InternalType = FIXED_POINTS_DETAILS::LeastInt<(Integer + 1) + Fraction>; using ShiftType = FIXED_POINTS_DETAILS::LeastUInt<(Integer + 1) + Fraction>; using MaskType = FIXED_POINTS_DETAILS::LeastUInt<(Integer + 1) + Fraction>; constexpr const static unsigned IntegerSize = Integer + 1; constexpr const static unsigned FractionSize = Fraction; constexpr const static unsigned LogicalSize = IntegerSize + FractionSize; constexpr const static unsigned InternalSize = FIXED_POINTS_DETAILS::BitSize::Value; constexpr const static unsigned long long Scale = 1ULL << FractionSize; public: constexpr const static ShiftType IntegerShift = FractionSize; constexpr const static ShiftType FractionShift = 0; constexpr const static MaskType IntegerMask = FIXED_POINTS_DETAILS::IdentityMask::Value; constexpr const static MaskType FractionMask = FIXED_POINTS_DETAILS::IdentityMask::Value; constexpr const static MaskType IdentityMask = (IntegerMask << IntegerShift) | (FractionMask << FractionShift); constexpr const static MaskType MidpointMask = FIXED_POINTS_DETAILS::MsbMask::Value; constexpr const static MaskType LesserMidpointMask = MidpointMask - 1; private: using Base = FIXED_POINTS_DETAILS::SFixedBase; using RawType = typename Base::RawType; public: using Base::Base; constexpr SFixed(void); constexpr SFixed(const IntegerType & integer); constexpr SFixed(const IntegerType & integer, const FractionType & fraction); constexpr InternalType getInternal(void) const; constexpr IntegerType getInteger(void) const; constexpr FractionType getFraction(void) const; constexpr explicit operator IntegerType(void) const; constexpr explicit operator float(void) const; constexpr explicit operator double(void) const; template< unsigned IntegerOut, unsigned FractionOut > constexpr explicit operator SFixed(void) const; constexpr static SFixed fromInternal(const InternalType & value); constexpr SFixed operator -(void) const; SFixed & operator ++(void); SFixed & operator --(void); SFixed & operator +=(const SFixed & other); SFixed & operator -=(const SFixed & other); SFixed & operator *=(const SFixed & other); SFixed & operator /=(const SFixed & other); public: const static SFixed Epsilon; const static SFixed MinValue; const static SFixed MaxValue; const static SFixed Pi; const static SFixed E; const static SFixed Phi; const static SFixed Tau; }; // // Variables // template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::Epsilon = SFixed::fromInternal(1); template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::MinValue = SFixed::fromInternal(FIXED_POINTS_DETAILS::MsbMask::Value); template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::MaxValue = SFixed::fromInternal(~FIXED_POINTS_DETAILS::MsbMask::Value); // 40 digits is probably enough for these template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::Pi = 3.1415926535897932384626433832795028841971; template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::E = 2.718281828459045235360287471352662497757; template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::Phi = 1.6180339887498948482045868343656381177203; template< unsigned Integer, unsigned Fraction > constexpr const SFixed SFixed::Tau = 6.2831853071795864769252867665590057683943; // // Free functions // template< unsigned Integer, unsigned Fraction > constexpr SFixed multiply(const SFixed & left, const SFixed & right); // // Basic Logic Operations // template< unsigned Integer, unsigned Fraction > constexpr bool operator ==(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator !=(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator <(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator >(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator <=(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator >=(const SFixed & left, const SFixed & right); // // Inter-size Logic Operations // template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator ==(const SFixed & left, const SFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator !=(const SFixed & left, const SFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator <(const SFixed & left, const SFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator >(const SFixed & left, const SFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator <=(const SFixed & left, const SFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator >=(const SFixed & left, const SFixed & right); // // Basic Arithmetic Operations // template< unsigned Integer, unsigned Fraction > constexpr SFixed operator +(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr SFixed operator -(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr SFixed operator *(const SFixed & left, const SFixed & right); template< unsigned Integer, unsigned Fraction > constexpr SFixed operator /(const SFixed & left, const SFixed & right); // // Inter-size Arithmetic Operations // template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator +(const SFixed & left, const SFixed & right) -> FIXED_POINTS_DETAILS::LargerType< SFixed, SFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator -(const SFixed & left, const SFixed & right) -> FIXED_POINTS_DETAILS::LargerType< SFixed, SFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator *(const SFixed & left, const SFixed & right) -> FIXED_POINTS_DETAILS::LargerType< SFixed, SFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > inline constexpr auto operator /(const SFixed & left, const SFixed & right) -> FIXED_POINTS_DETAILS::LargerType< SFixed, SFixed >; FIXED_POINTS_END_NAMESPACE #include "SFixedMemberFunctions.h" #include "SFixedFreeFunctions.h"