// Copyright 2017 Pharap // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #pragma once #include "Details.h" FIXED_POINTS_BEGIN_NAMESPACE // // Declaration // template< unsigned Integer, unsigned Fraction > class UFixed { public: static_assert((Integer + Fraction) <= FIXED_POINTS_DETAILS::BitSize::Value, "Platform does not have a native type large enough for UFixed."); public: using IntegerType = FIXED_POINTS_DETAILS::LeastUInt; using FractionType = FIXED_POINTS_DETAILS::LeastUInt; using InternalType = FIXED_POINTS_DETAILS::LeastUInt; using ShiftType = FIXED_POINTS_DETAILS::LeastUInt; using MaskType = FIXED_POINTS_DETAILS::LeastUInt; constexpr const static uintmax_t IntegerSize = Integer; constexpr const static uintmax_t FractionSize = Fraction; constexpr const static uintmax_t LogicalSize = IntegerSize + FractionSize; constexpr const static uintmax_t InternalSize = FIXED_POINTS_DETAILS::BitSize::Value; constexpr const static uintmax_t 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; protected: class RawType { private: const InternalType value; public: constexpr inline explicit RawType(const InternalType & value) : value(value) {} constexpr inline explicit operator InternalType(void) const { return this->value; } }; protected: InternalType value; protected: constexpr UFixed(const RawType & value); public: constexpr UFixed(void); constexpr UFixed(const IntegerType & integer, const FractionType & fraction); constexpr UFixed(const char & value); constexpr UFixed(const unsigned char & value); constexpr UFixed(const signed char & value); constexpr UFixed(const unsigned short int & value); constexpr UFixed(const signed short int & value); constexpr UFixed(const unsigned int & value); constexpr UFixed(const signed int & value); constexpr UFixed(const unsigned long int & value); constexpr UFixed(const signed long int & value); constexpr UFixed(const unsigned long long int & value); constexpr UFixed(const signed long long int & value); constexpr UFixed(const double & value); constexpr UFixed(const float & value); constexpr UFixed(const long double & value); public: 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; constexpr explicit operator long double(void) const; template< unsigned IntegerOut, unsigned FractionOut > constexpr explicit operator UFixed(void) const; constexpr static UFixed fromInternal(const InternalType & value); UFixed & operator ++(void); UFixed & operator --(void); UFixed & operator +=(const UFixed & other); UFixed & operator -=(const UFixed & other); UFixed & operator *=(const UFixed & other); UFixed & operator /=(const UFixed & other); public: constexpr const static UFixed Epsilon = UFixed::fromInternal(1); constexpr const static UFixed MinValue = UFixed::fromInternal(0); constexpr const static UFixed MaxValue = UFixed::fromInternal(~0); // 40 digits is probably enough for these constexpr const static UFixed Pi = 3.1415926535897932384626433832795028841971; constexpr const static UFixed E = 2.718281828459045235360287471352662497757; constexpr const static UFixed Phi = 1.6180339887498948482045868343656381177203; constexpr const static UFixed Tau = 6.2831853071795864769252867665590057683943; }; // // Free functions // template< unsigned Integer, unsigned Fraction > constexpr UFixed multiply(const UFixed & left, const UFixed & right); // // Basic Logic Operations // template< unsigned Integer, unsigned Fraction > constexpr bool operator ==(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator !=(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator <(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator >(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator <=(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr bool operator >=(const UFixed & left, const UFixed & right); // // Inter-size Logic Operations // template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator ==(const UFixed & left, const UFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator !=(const UFixed & left, const UFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator <(const UFixed & left, const UFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator >(const UFixed & left, const UFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator <=(const UFixed & left, const UFixed & right); template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr bool operator >=(const UFixed & left, const UFixed & right); // // Basic Arithmetic Operations // template< unsigned Integer, unsigned Fraction > constexpr UFixed operator +(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr UFixed operator -(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr UFixed operator *(const UFixed & left, const UFixed & right); template< unsigned Integer, unsigned Fraction > constexpr UFixed operator /(const UFixed & left, const UFixed & right); // // Inter-size Arithmetic Operations // template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator +(const UFixed & left, const UFixed & right) -> FIXED_POINTS_DETAILS::LargerType< UFixed, UFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator -(const UFixed & left, const UFixed & right) -> FIXED_POINTS_DETAILS::LargerType< UFixed, UFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > constexpr auto operator *(const UFixed & left, const UFixed & right) -> FIXED_POINTS_DETAILS::LargerType< UFixed, UFixed >; template< unsigned IntegerLeft, unsigned FractionLeft, unsigned IntegerRight, unsigned FractionRight > inline constexpr auto operator /(const UFixed & left, const UFixed & right) -> FIXED_POINTS_DETAILS::LargerType< UFixed, UFixed >; FIXED_POINTS_END_NAMESPACE #include "UFixedMemberFunctions.h" #include "UFixedFreeFunctions.h"