Standard math functions. More...

#include <tdme/math/Math.h>

Collaboration diagram for Math:

Static Public Member Functions
static int	clamp (int value, int min, int max)
	Clamps a int value to min or max value. More...

static int64_t	clamp (int64_t value, int64_t min, int64_t max)
	Clamps a 64 bit int value to min or max value. More...

static float	clamp (float value, float min, float max)
	Clamps a float value to min or max value. More...

static float	sign (float value)
	Returns sign of value. More...

static float	square (float value)
	Do the square product. More...

static int32_t	abs (int32_t value)
	Returns absolute value. More...

static int64_t	abs (int64_t value)
	Returns absolute value. More...

static float	abs (float value)
	Returns absolute value. More...

static float	acos (float value)
	Returns the arc cosine of a value. More...

static float	asin (float value)
	Returns the arc sine of a value. More...

static float	atan (float value)
	Returns the arc tangent of a value. More...

static float	atan2 (float y, float x)
	Returns the angle from the conversion of rectangular coordinates to polar coordinates. More...

static float	ceil (float value)
	Returns the higher integer value of given value. More...

static float	cos (float value)
	Returns the cosine of an angle. More...

static float	floor (float value)
	Returns the lower integer value of given value. More...

static int32_t	max (int32_t value1, int32_t value2)
	Returns the higher value of given values. More...

static int64_t	max (int64_t value1, int64_t value2)
	Returns the higher value of given values. More...

static float	max (float value1, float value2)
	Returns the higher value of given values. More...

static int32_t	min (int32_t value1, int32_t value2)
	Returns the lesser value of given values. More...

static int32_t	min (int64_t value1, int64_t value2)
	Returns the lesser value of given values. More...

static float	min (float value1, float value2)
	Returns the lesser value of given values. More...

static float	round (float value)
	Returns the rounded value of given float value. More...

static int32_t	pow (int32_t value1, int32_t value2)
	Returns the value of the value 1 raised to the power of value2. More...

static float	pow (float value1, float value2)
	Returns the value of the value 1 raised to the power of value2. More...

static float	random ()
	Returns a random value between 0.0 . More...

static float	sin (float value)
	Returns the sine of an angle. More...

static float	sqrt (float value)
	Returns the square of given value. More...

static float	tan (float value)
	Returns the tangent of an angle. More...

static float	exp (float value)
	Returns e raised to the given power. More...

static float	log (float value)
	Returns the natural (base e) logarithm of value. More...

static float	mod (float value, float range)
	Returns modulo of value, so that return value is -range < value < range. More...

static float	absmod (float value, float range)
	Returns absolute modulo of value, so that return value is 0.0f <= value < range. More...

Static Public Attributes
static constexpr float	E { 2.718281828459045f }

static constexpr float	PI { 3.141592653589793f }

static constexpr float	EPSILON { 0.0000001f }

static constexpr float	DEG2RAD { 0.017453294f }

static constexpr float	g { 9.80665f }

Detailed Description

Standard math functions.

Author: Andreas Drewke

Version: $Id$

Definition at line 20 of file Math.h.

Member Function Documentation

◆ abs() [1/3]

static float abs ( float value )

inlinestatic

Returns absolute value.

Parameters

value value

Returns: absolute value

Definition at line 109 of file Math.h.

◆ abs() [2/3]

static int32_t abs ( int32_t value )

inlinestatic

Returns absolute value.

Parameters

value value

Returns: absolute value

Definition at line 91 of file Math.h.

◆ abs() [3/3]

static int64_t abs ( int64_t value )

inlinestatic

Returns absolute value.

Parameters

value value

Returns: absolute value

Definition at line 100 of file Math.h.

◆ absmod()

static float absmod	(	float	value,
		float	range
	)

inlinestatic

Returns absolute modulo of value, so that return value is 0.0f <= value < range.

Parameters

value	value
range	range

Returns: modulo of value

Definition at line 336 of file Math.h.

◆ acos()

static float acos ( float value )

inlinestatic

Returns the arc cosine of a value.

Parameters

value value

Returns: arc cosine

Definition at line 118 of file Math.h.

◆ asin()

static float asin ( float value )

inlinestatic

Returns the arc sine of a value.

Parameters

value value

Returns: arc sine

Definition at line 127 of file Math.h.

◆ atan()

static float atan ( float value )

inlinestatic

Returns the arc tangent of a value.

Parameters

value value

Returns: arc tangent

Definition at line 136 of file Math.h.

◆ atan2()

static float atan2	(	float	y,
		float	x
	)

inlinestatic

Returns the angle from the conversion of rectangular coordinates to polar coordinates.

Parameters

y	y
x	x

Returns: angle

Definition at line 147 of file Math.h.

◆ ceil()

static float ceil ( float value )

inlinestatic

Returns the higher integer value of given value.

Parameters

value value

Returns: higher integer

Definition at line 156 of file Math.h.

◆ clamp() [1/3]

static float clamp	(	float	value,
		float	min,
		float	max
	)

inlinestatic

Clamps a float value to min or max value.

Parameters

value	value
min	min value
max	max value

Returns: clamped value

Definition at line 62 of file Math.h.

◆ clamp() [2/3]

static int clamp	(	int	value,
		int	min,
		int	max
	)

inlinestatic

Clamps a int value to min or max value.

Parameters

value	value
min	min value
max	max value

Returns: clamped value

Definition at line 36 of file Math.h.

◆ clamp() [3/3]

static int64_t clamp	(	int64_t	value,
		int64_t	min,
		int64_t	max
	)

inlinestatic

Clamps a 64 bit int value to min or max value.

Parameters

value	value
min	min value
max	max value

Returns: clamped value

Definition at line 49 of file Math.h.

◆ cos()

static float cos ( float value )

inlinestatic

Returns the cosine of an angle.

Parameters

value value

Returns: cosine

Definition at line 165 of file Math.h.

◆ exp()

static float exp ( float value )

inlinestatic

Returns e raised to the given power.

Parameters

value value

Returns: e

Definition at line 307 of file Math.h.

◆ floor()

static float floor ( float value )

inlinestatic

Returns the lower integer value of given value.

Parameters

value value

Returns: lower integer

Definition at line 174 of file Math.h.

◆ log()

static float log ( float value )

inlinestatic

Returns the natural (base e) logarithm of value.

Parameters

value value

Returns: log

Definition at line 316 of file Math.h.

◆ max() [1/3]

static float max	(	float	value1,
		float	value2
	)

inlinestatic

Returns the higher value of given values.

Parameters

value1	value 1
value2	value 2

Returns: higher value

Definition at line 204 of file Math.h.

◆ max() [2/3]

static int32_t max	(	int32_t	value1,
		int32_t	value2
	)

inlinestatic

Returns the higher value of given values.

Parameters

value1	value 1
value2	value 2

Returns: higher value

Definition at line 184 of file Math.h.

◆ max() [3/3]

static int64_t max	(	int64_t	value1,
		int64_t	value2
	)

inlinestatic

Returns the higher value of given values.

Parameters

value1	value 1
value2	value 2

Returns: higher value

Definition at line 194 of file Math.h.

◆ min() [1/3]

static float min	(	float	value1,
		float	value2
	)

inlinestatic

Returns the lesser value of given values.

Parameters

value1	value 1
value2	value 2

Returns: lesser value

Definition at line 234 of file Math.h.

◆ min() [2/3]

static int32_t min	(	int32_t	value1,
		int32_t	value2
	)

inlinestatic

Returns the lesser value of given values.

Parameters

value1	value 1
value2	value 2

Returns: lesser value

Definition at line 214 of file Math.h.

◆ min() [3/3]

static int32_t min	(	int64_t	value1,
		int64_t	value2
	)

inlinestatic

Returns the lesser value of given values.

Parameters

value1	value 1
value2	value 2

Returns: lesser value

Definition at line 224 of file Math.h.

◆ mod()

static float mod	(	float	value,
		float	range
	)

inlinestatic

Returns modulo of value, so that return value is -range < value < range.

Parameters

value	value
range	range

Returns: modulo of value

Definition at line 326 of file Math.h.

◆ pow() [1/2]

static float pow	(	float	value1,
		float	value2
	)

inlinestatic

Returns the value of the value 1 raised to the power of value2.

Parameters

value1	value 1
value2	value 2

Returns: pow

Definition at line 263 of file Math.h.

◆ pow() [2/2]

static int32_t pow	(	int32_t	value1,
		int32_t	value2
	)

inlinestatic

Returns the value of the value 1 raised to the power of value2.

Parameters

value1	value 1
value2	value 2

Returns: pow

Definition at line 253 of file Math.h.

◆ random()

static float random ( )

inlinestatic

Returns a random value between 0.0 .

. 1.0

Returns: random value

Definition at line 271 of file Math.h.

◆ round()

static float round ( float value )

inlinestatic

Returns the rounded value of given float value.

Parameters

value value

Returns: rounded value

Definition at line 243 of file Math.h.

◆ sign()

static float sign ( float value )

inlinestatic

Returns sign of value.

Parameters

value value

Returns: -1 if value is negative or +1 if positive

Definition at line 73 of file Math.h.

◆ sin()

static float sin ( float value )

inlinestatic

Returns the sine of an angle.

Parameters

value value

Returns: sine

Definition at line 280 of file Math.h.

◆ sqrt()

static float sqrt ( float value )

inlinestatic

Returns the square of given value.

Parameters

value value

Returns: squaere

Definition at line 289 of file Math.h.

◆ square()

static float square ( float value )

inlinestatic

Do the square product.

Parameters

value value

Returns

Definition at line 82 of file Math.h.

◆ tan()

static float tan ( float value )

inlinestatic

Returns the tangent of an angle.

Parameters

value value

Returns: tangent

Definition at line 298 of file Math.h.

Member Data Documentation

◆ DEG2RAD

constexpr float DEG2RAD { 0.017453294f }

staticconstexpr

Definition at line 26 of file Math.h.

◆ E

constexpr float E { 2.718281828459045f }

staticconstexpr

Definition at line 23 of file Math.h.

◆ EPSILON

constexpr float EPSILON { 0.0000001f }

staticconstexpr

Definition at line 25 of file Math.h.

◆ g

constexpr float g { 9.80665f }

staticconstexpr

Definition at line 27 of file Math.h.

◆ PI

constexpr float PI { 3.141592653589793f }

staticconstexpr

Definition at line 24 of file Math.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/math/Math.h

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ abs() [1/3]

◆ abs() [2/3]

◆ abs() [3/3]

◆ absmod()

◆ acos()

◆ asin()

◆ atan()

◆ atan2()

◆ ceil()

◆ clamp() [1/3]

◆ clamp() [2/3]

◆ clamp() [3/3]

◆ cos()

◆ exp()

◆ floor()

◆ log()

◆ max() [1/3]

◆ max() [2/3]

◆ max() [3/3]

◆ min() [1/3]

◆ min() [2/3]

◆ min() [3/3]

◆ mod()

◆ pow() [1/2]

◆ pow() [2/2]

◆ random()

◆ round()

◆ sign()

◆ sin()

◆ sqrt()

◆ square()

◆ tan()

Member Data Documentation

◆ DEG2RAD

◆ E

◆ EPSILON

◆ g

◆ PI