Beatmup::Fixed< rtype, precision, optype > Struct Template Reference

Fixed-point number. More...

#include <fixed_point.h>

Public Types
typedef rtype	underlying_type

Public Member Functions
	Fixed ()
	Fixed (const Fixed &another)
	Fixed (float value)
Fixed &	operator= (const float value)
Fixed &	operator= (const rtype value)
Fixed	operator+ (const Fixed &another) const
Fixed	operator- (const Fixed &another) const
Fixed	operator* (const Fixed &another) const
Fixed	operator/ (const Fixed &another) const
	operator float () const
uint8_t	asTexture () const

Static Public Member Functions
static Fixed	interpret (const underlying_type value)
static float	min ()
static float	max ()

Protected Member Functions
	Fixed (const rtype value)

Static Protected Member Functions
static rtype	clamp (const float val, const rtype min, const rtype max)
static rtype	fromFloat (const float val)

Protected Attributes
rtype	value

Detailed Description

template<typename rtype, const int precision, typename optype>
struct Beatmup::Fixed< rtype, precision, optype >

Fixed-point number.

Template Parameters

rtype	Datatype used to store the values
precision	Number of bits to represent the fractional part
optype	Datatype used in arithmetic operations

Definition at line 33 of file fixed_point.h.

Member Typedef Documentation

underlying_type

template<typename rtype , const int precision, typename optype >

typedef rtype Beatmup::Fixed< rtype, precision, optype >::underlying_type

Definition at line 47 of file fixed_point.h.

Constructor & Destructor Documentation

Fixed() [1/4]

template<typename rtype , const int precision, typename optype >

Beatmup::Fixed< rtype, precision, optype >::Fixed ( const rtype  value )

inlineprotected

Definition at line 44 of file fixed_point.h.

: value(((optype)value) << precision) {}

Fixed() [2/4]

template<typename rtype , const int precision, typename optype >

Beatmup::Fixed< rtype, precision, optype >::Fixed ( )

inline

Definition at line 49 of file fixed_point.h.

: value(0) {}

Fixed() [3/4]

template<typename rtype , const int precision, typename optype >

Beatmup::Fixed< rtype, precision, optype >::Fixed ( const Fixed< rtype, precision, optype > &  another )

inline

Definition at line 51 of file fixed_point.h.

: value(another.value) {}

Fixed() [4/4]

template<typename rtype , const int precision, typename optype >

Beatmup::Fixed< rtype, precision, optype >::Fixed ( float  value )

inline

Definition at line 53 of file fixed_point.h.

: value(fromFloat(value)) {}

Member Function Documentation

clamp()

template<typename rtype , const int precision, typename optype >

static rtype Beatmup::Fixed< rtype, precision, optype >::clamp ( const float  val, const rtype  min, const rtype  max  )

inlinestaticprotected

Definition at line 36 of file fixed_point.h.

                                                                                     {
            return val <= min ? min : val >= max ? max : (rtype)roundf_fast(val);
        }

fromFloat()

template<typename rtype , const int precision, typename optype >

static rtype Beatmup::Fixed< rtype, precision, optype >::fromFloat ( const float  val )

inlinestaticprotected

Definition at line 40 of file fixed_point.h.

                                                       {
            return clamp(val * (1 << precision), std::numeric_limits<underlying_type>::min(), std::numeric_limits<underlying_type>::max());
        }

operator=() [1/2]

template<typename rtype , const int precision, typename optype >

Fixed& Beatmup::Fixed< rtype, precision, optype >::operator= ( const float  value )

inline

Definition at line 55 of file fixed_point.h.

                                            {
            this->value = fromFloat(value);
            return *this;
        }

operator=() [2/2]

template<typename rtype , const int precision, typename optype >

Fixed& Beatmup::Fixed< rtype, precision, optype >::operator= ( const rtype  value )

inline

Definition at line 60 of file fixed_point.h.

                                            {
            this->value = ((optype)value) << precision;
            return *this;
        }

operator+()

template<typename rtype , const int precision, typename optype >

Fixed Beatmup::Fixed< rtype, precision, optype >::operator+ ( const Fixed< rtype, precision, optype > &  another ) const

inline

Definition at line 65 of file fixed_point.h.

                                                    {
            return Fixed::interpret( static_cast<rtype>(value + another.value) );
        }

operator-()

template<typename rtype , const int precision, typename optype >

Fixed Beatmup::Fixed< rtype, precision, optype >::operator- ( const Fixed< rtype, precision, optype > &  another ) const

inline

Definition at line 69 of file fixed_point.h.

                                                    {
            return Fixed::interpret( static_cast<rtype>(value - another.value) );
        }

operator*()

template<typename rtype , const int precision, typename optype >

Fixed Beatmup::Fixed< rtype, precision, optype >::operator* ( const Fixed< rtype, precision, optype > &  another ) const

inline

Definition at line 73 of file fixed_point.h.

                                                    {
            return Fixed::interpret( static_cast<rtype>(((optype)value * another.value) >> precision) );
        }

operator/()

template<typename rtype , const int precision, typename optype >

Fixed Beatmup::Fixed< rtype, precision, optype >::operator/ ( const Fixed< rtype, precision, optype > &  another ) const

inline

Definition at line 77 of file fixed_point.h.

                                                    {
            return Fixed::interpret( static_cast<rtype>(((optype)value << precision) / another.value) );
        }

operator float()

template<typename rtype , const int precision, typename optype >

Beatmup::Fixed< rtype, precision, optype >::operator float ( ) const

inline

Definition at line 82 of file fixed_point.h.

                               {
            return (float)value / (float)(1 << precision);
        }

asTexture()

template<typename rtype , const int precision, typename optype >

uint8_t Beatmup::Fixed< rtype, precision, optype >::asTexture ( ) const

inline

Definition at line 87 of file fixed_point.h.

                                  {
            const optype v = (((optype)value) * 255) >> precision;
            return v <= 0 ? 0 : v >= 255 ? 255 : (uint8_t)v;
        }

interpret()

template<typename rtype , const int precision, typename optype >

static Fixed Beatmup::Fixed< rtype, precision, optype >::interpret ( const underlying_type  value )

inlinestatic

Definition at line 93 of file fixed_point.h.

                                                            {
            Fixed result;
            result.value = value;
            return result;
        }

min()

template<typename rtype , const int precision, typename optype >

static float Beatmup::Fixed< rtype, precision, optype >::min ( )

inlinestatic

Returns

min representable value.

Definition at line 103 of file fixed_point.h.

                           {
            return interpret(std::numeric_limits<underlying_type>::min());
        }

max()

template<typename rtype , const int precision, typename optype >

static float Beatmup::Fixed< rtype, precision, optype >::max ( )

inlinestatic

Returns

max representable value.

Definition at line 111 of file fixed_point.h.

                           {
            return interpret(std::numeric_limits<underlying_type>::max());
        }

Member Data Documentation

value

template<typename rtype , const int precision, typename optype >

rtype Beatmup::Fixed< rtype, precision, optype >::value

protected

Definition at line 35 of file fixed_point.h.

---

The documentation for this struct was generated from the following file:

• core/utils/fixed_point.h