maths.h

Go to the documentation of this file.

#ifndef _MATHS_H_
#define _MATHS_H_


extern const fix32 sintab_f32[1024];
extern const fix16 sintab_f16[1024];

extern const fix16 log2tab_f16[0x10000];
extern const fix16 log10tab_f16[0x10000];
extern const fix16 sqrttab_f16[0x10000];


#define min(X, Y)   (((X) < (Y))?(X):(Y))

#define max(X, Y)   (((X) > (Y))?(X):(Y))

#define clamp(X, L, H)   (min(max((X), (L)), (H)))

#if (ENABLE_NEWLIB == 0)

#define abs(X)      (((X) < 0)?-(X):(X))
#endif  // ENABLE_NEWLIB

#ifndef PI

#define PI 3.14159265358979323846
#endif


#define FIX16_INT_BITS              10
#define FIX16_FRAC_BITS             (16 - FIX16_INT_BITS)

#define FIX16_INT_MASK              (((1 << FIX16_INT_BITS) - 1) << FIX16_FRAC_BITS)
#define FIX16_FRAC_MASK             ((1 << FIX16_FRAC_BITS) - 1)


#define FIX32_INT_BITS              22
#define FIX32_FRAC_BITS             (32 - FIX32_INT_BITS)

#define FIX32_INT_MASK              (((1 << FIX32_INT_BITS) - 1) << FIX32_FRAC_BITS)
#define FIX32_FRAC_MASK             ((1 << FIX32_FRAC_BITS) - 1)


#define FASTFIX16_INT_BITS          8
#define FASTFIX16_FRAC_BITS         (16 - FASTFIX16_INT_BITS)

#define FASTFIX16_INT_MASK          (((1 << FASTFIX16_INT_BITS) - 1) << FASTFIX16_FRAC_BITS)
#define FASTFIX16_FRAC_MASK         ((1 << FASTFIX16_FRAC_BITS) - 1)


#define FASTFIX32_INT_BITS          16
#define FASTFIX32_FRAC_BITS         (32 - FASTFIX32_INT_BITS)

#define FASTFIX32_INT_MASK          (((1 << FASTFIX32_INT_BITS) - 1) << FASTFIX32_FRAC_BITS)
#define FASTFIX32_FRAC_MASK         ((1 << FASTFIX32_FRAC_BITS) - 1)


#define FIX16(value)                ((fix16) ((value) * (1 << FIX16_FRAC_BITS)))

#define FIX32(value)                ((fix32) ((value) * (1 << FIX32_FRAC_BITS)))

#define FASTFIX16(value)                ((fastfix16) ((value) * (1 << FASTFIX16_FRAC_BITS)))

#define FASTFIX32(value)                ((fastfix32) ((value) * (1 << FASTFIX32_FRAC_BITS)))


// 2D STUFF

typedef struct
{
    u16 x;
    u16 y;
} Vect2D_u16;

typedef struct
{
    s16 x;
    s16 y;
} Vect2D_s16;

typedef struct
{
    u32 x;
    u32 y;
} Vect2D_u32;

typedef struct
{
    s32 x;
    s32 y;
} Vect2D_s32;

typedef struct
{
    fix16 x;
    fix16 y;
} Vect2D_f16;

typedef struct
{
    fix32 x;
    fix32 y;
} Vect2D_f32;

typedef struct
{
    Vect2D_f16 a;
    Vect2D_f16 b;
} Mat2D_f16;

typedef struct
{
    Vect2D_f32 a;
    Vect2D_f32 b;
} Mat2D_f32;


// 3D STUFF

typedef struct
{
    u16 x;
    u16 y;
    u16 z;
} Vect3D_u16;

typedef struct
{
    s16 x;
    s16 y;
    s16 z;
} Vect3D_s16;

typedef struct
{
    u32 x;
    u32 y;
    u32 z;
} Vect3D_u32;

typedef struct
{
    s32 x;
    s32 y;
    s32 z;
} Vect3D_s32;

typedef struct
{
    fix16 x;
    fix16 y;
    fix16 z;
} Vect3D_f16;

typedef struct
{
    fix32 x;
    fix32 y;
    fix32 z;
} Vect3D_f32;

typedef struct
{
    Vect3D_f16 a;
    Vect3D_f16 b;
    Vect3D_f16 c;
} Mat3D_f16;

typedef struct
{
    Vect3D_f32 a;
    Vect3D_f32 b;
    Vect3D_f32 c;
} Mat3D_f32;


// 4D STUFF

typedef struct
{
    fix16 x;
    fix16 y;
    fix16 z;
    fix16 w;
} Vect4D_f16;

typedef struct
{
    fix32 x;
    fix32 y;
    fix32 z;
    fix32 w;
} Vect4D_f32;

typedef struct
{
    Vect4D_f16 a;
    Vect4D_f16 b;
    Vect4D_f16 c;
    Vect4D_f16 d;
} Mat4D_f16;

typedef struct
{
    Vect4D_f32 a;
    Vect4D_f32 b;
    Vect4D_f32 c;
    Vect4D_f32 d;
} Mat4D_f32;


// short alias

typedef Vect2D_u16 V2u16;
typedef Vect2D_s16 V2s16;
typedef Vect2D_u32 V2u32;
typedef Vect2D_s32 V2s32;
typedef Vect2D_f16 V2f16;
typedef Vect2D_f32 V2f32;

typedef Vect3D_u16 V3u16;
typedef Vect3D_s16 V3s16;
typedef Vect3D_u32 V3u32;
typedef Vect3D_s32 V3s32;
typedef Vect3D_f16 V3f16;
typedef Vect3D_f32 V3f32;

typedef Vect4D_f16 V4f16;
typedef Vect4D_f32 V4f32;

typedef Mat2D_f16 M2f16;
typedef Mat2D_f32 M2f32;
typedef Mat3D_f16 M3f16;
typedef Mat3D_f32 M3f32;
typedef Mat4D_f16 M4f16;
typedef Mat4D_f32 M4f32;


u32 mulu(u16 op1, u16 op2);
s32 muls(s16 op1, s16 op2);
u16 divu(u32 op1, u16 op2);
s16 divs(s32 op1, s16 op2);
u16 modu(u32 op1, u16 op2);
s16 mods(s32 op1, s16 op2);

u32 divmodu(u32 op1, u16 op2);
s32 divmods(s32 op1, s16 op2);


fix16 intToFix16(s16 value);
s16 fix16ToInt(fix16 value);
fix32 fix16ToFix32(fix16 value);

fix16 fix16Round(fix16 value);
s16 fix16ToRoundedInt(fix16 value);
fix16 fix16Frac(fix16 value);
fix16 fix16Int(fix16 value);

#define fix16Add(a, b)      _Pragma("GCC error \"This method is deprecated, simply use '+' operator to add fix16 values together.\"")
#define fix16Sub(a, b)      _Pragma("GCC error \"This method is deprecated, simply use '-' operator to subtract fix16 values.\"")
#define fix16Neg(a)         _Pragma("GCC error \"This method is deprecated, simply use '0 - value' to get the negative fix16 value.\"")

fix16 fix16Mul(fix16 val1, fix16 val2);
fix16 fix16Div(fix16 val1, fix16 val2);
fix16 fix16Avg(fix16 val1, fix16 val2);

fix16 fix16Log2(fix16 value);
fix16 fix16Log10(fix16 value);
fix16 fix16Sqrt(fix16 value);

fix16 sinFix16(u16 value);
fix16 cosFix16(u16 value);


fix32 intToFix32(s32 value);
s32 fix32ToInt(fix32 value);
fix16 fix32ToFix16(fix32 value);

fix32 fix32Round(fix32 value);
s32 fix32ToRoundedInt(fix32 value);
fix32 fix32Frac(fix32 value);
fix32 fix32Int(fix32 value);

#define fix32Add(a, b)      _Pragma("GCC error \"This method is deprecated, simply use '+' operator to add fix32 values together.\"")
#define fix32Sub(a, b)      _Pragma("GCC error \"This method is deprecated, simply use '-' operator to subtract fix32 values.\"")
#define fix32Neg(a)         _Pragma("GCC error \"This method is deprecated, simply use '0 - value' to get the negative fix32 value.\"")

fix32 fix32Mul(fix32 val1, fix32 val2);
fix32 fix32Div(fix32 val1, fix32 val2);
fix32 fix32Avg(fix32 val1, fix32 val2);

fix32 sinFix32(u16 value);
fix32 cosFix32(u16 value);





fastfix16 intToFastFix16(s16 value);
s16 fastFix16ToInt(fastfix16 value);

fastfix16 fastFix16Round(fastfix16 value);
s16 fastFix16ToRoundedInt(fastfix16 value);
fastfix16 fastFix16Frac(fastfix16 value);
fastfix16 fastFix16Int(fastfix16 value);

fastfix16 fastFix16Mul(fastfix16 val1, fastfix16 val2);
fastfix16 fastFix16Div(fastfix16 val1, fastfix16 val2);


fastfix32 intToFastFix32(s16 value);
s16 fastFix32ToInt(fastfix32 value);

fastfix32 fastFix32Round(fastfix32 value);
s32 fastFix32ToRoundedInt(fastfix32 value);
fastfix32 fastFix32Frac(fastfix32 value);
fastfix32 fastFix32Int(fastfix32 value);

fastfix32 fastFix32Mul(fastfix32 val1, fastfix32 val2);
fastfix32 fastFix32Div(fastfix32 val1, fastfix32 val2);






u32 intToBCD(u32 value);

#define distance_approx(dx, dy) _Pragma("GCC error \"This method is deprecated, use getApproximatedDistance(..) instead.\"")

u32 getApproximatedDistance(s32 dx, s32 dy);
u32 getApproximatedDistanceV(V2s32* v);
s32 getApproximatedLog2(s32 value);
u16 getLog2Int(u32 value);

u32 getNextPow2(u32 value);


#endif // _MATHS_H_