math.md

core::math

Collection of basic mathematical functions.

Types

Random

Random number generator

Methods

next_float

random.next_float ( ) -> float

Get next random number between 0.0 and 1.0

next_gaussian

random.next_gaussian ( mu : float,
                       sigma : float ) -> float

Get next gaussian distributed random number

Parameters

Name	Type	Optional	Description
mu	float	x	Mean value
sigma	float	x	Standard deviation

next_int

random.next_int ( min : int,
                  max : int ) -> int

Get next random number between min and max

Parameters

Name	Type	Optional	Description
min	int		Minimum value (inclusive)
max	int		Maximum value (inclusive)

Constants

Name	Type	Description
DEG_TO_RAD	float	Multiplicator to convert an angle of degree to radian.
E	float	Represents the natural logarithmic base, specified by the e constant,
EPSILON	float	Machine epsilon, i.e lowest possible resolution of a floating point number.
MAX_FLOAT	float	Maximum possible floating point number.
MAX_INT	int	Maximum possible integer number.
MIN_FLOAT	float	Minimum possible floating point number.
MIN_INT	int	Minimum possible integer number.
PI	float	Represents the ratio of the circumference of a circle to its diameter, specified by the constant, π.
RAD_TO_DEG	float	Multiplicator to convert an angle of radian to degree.

Functions

abs

pub sync fn abs ( value : float ) -> float

Returns the absolute value of a number.

Parameters

Name	Type	Optional	Description
value	float

acos

pub sync fn acos ( d : float ) -> float

Returns the angle in radian whose cosine is the specified number.

Parameters

Name	Type	Optional	Description
d	float

acos_deg

pub sync fn acos_deg ( x : float ) -> float

Returns the angle in degree whose cosine is the specified number.

Parameters

Name	Type	Optional	Description
x	float

acosh

pub sync fn acosh ( x : float ) -> float

Returns the angle whose hyperbolic cosine is the specified number.

Parameters

Name	Type	Optional	Description
x	float

asin

pub sync fn asin ( d : float ) -> float

Returns the angle in radian whose sine is the specified number.

Parameters

Name	Type	Optional	Description
d	float

asin_deg

pub sync fn asin_deg ( x : float ) -> float

Returns the angle in degree whose sine is the specified number.

Parameters

Name	Type	Optional	Description
x	float

asinh

pub sync fn asinh ( x : float ) -> float

Returns the angle whose hyperbolic sine is the specified number.

Parameters

Name	Type	Optional	Description
x	float

atan

pub sync fn atan ( d : float ) -> float

Returns the angle in radian whose tanget is the specified number.

Parameters

Name	Type	Optional	Description
d	float

atan2

pub sync fn atan2 ( y : float,
                    x : float ) -> float

Returns the angle in redian whose tangent is the quotient of two specified numbers.

Parameters

Name	Type	Optional	Description
y	float
x	float

atan2_deg

pub sync fn atan2_deg ( y : float,
                        x : float ) -> float

Returns the angle in degree whose tangent is the quotient of two specified numbers.

Parameters

Name	Type	Optional	Description
y	float
x	float

atan_deg

pub sync fn atan_deg ( x : float ) -> float

Returns the angle in degree whose tangent is the specified number.

Parameters

Name	Type	Optional	Description
x	float

atanh

pub sync fn atanh ( x : float ) -> float

Returns the angle whose hyperbolic tanget is the specified number.

Parameters

Name	Type	Optional	Description
x	float

ceiling

pub sync fn ceiling ( a : float ) -> float

Returns the smallest integral value that is greater than or equal to the specified number.

Parameters

Name	Type	Optional	Description
a	float

clamp

pub sync fn clamp ( x : float,
                    min : float,
                    max : float ) -> float

Clamp a number between a given minimum and maximum

Parameters

Name	Type	Optional	Description
x	float
min	float
max	float

clamp_degrees180

pub sync fn clamp_degrees180 ( angle : float ) -> float

Clamp an angle between -180 and 180 degree

Parameters

Name	Type	Optional	Description
angle	float

clamp_degrees360

pub sync fn clamp_degrees360 ( angle : float ) -> float

Clamp an angle between 0 and 360 degree

Parameters

Name	Type	Optional	Description
angle	float

clamp_radians2_pi

pub sync fn clamp_radians2_pi ( angle : float ) -> float

Clamp an angle between 0 and 2π

Parameters

Name	Type	Optional	Description
angle	float

clamp_radians_pi

pub sync fn clamp_radians_pi ( angle : float ) -> float

Clamp an angle between -π and π

Parameters

Name	Type	Optional	Description
angle	float

cos

pub sync fn cos ( d : float ) -> float

Returns the cosine of the specified angle in redian.

Parameters

Name	Type	Optional	Description
d	float

cos_deg

pub sync fn cos_deg ( x : float ) -> float

Returns the cosine of the specified angle in degree.

Parameters

Name	Type	Optional	Description
x	float

cosh

pub sync fn cosh ( value : float ) -> float

Returns the hyperbolic cosine of the specified angle.

Parameters

Name	Type	Optional	Description
value	float

exp

pub sync fn exp ( d : float ) -> float

Returns e raised to the specified power.

Parameters

Name	Type	Optional	Description
d	float

floor

pub sync fn floor ( d : float ) -> float

Returns the largest integral value less than or equal to the specified number.

Parameters

Name	Type	Optional	Description
d	float

log

pub sync fn log ( d : float ) -> float

Returns the natural (base e) logarithm of a specified number.

Parameters

Name	Type	Optional	Description
d	float

log10

pub sync fn log10 ( d : float ) -> float

Returns the base 10 logarithm of a specified number.

Parameters

Name	Type	Optional	Description
d	float

max

pub sync fn max ( val1 : float,
                  val2 : float ) -> float

Returns the larger of two decimal numbers.

Parameters

Name	Type	Optional	Description
val1	float
val2	float

min

pub sync fn min ( val1 : float,
                  val2 : float ) -> float

Returns the smaller of two decimal numbers.

Parameters

Name	Type	Optional	Description
val1	float
val2	float

pow

pub sync fn pow ( x : float,
                  y : float ) -> float

Returns a specified number raised to the specified power.

Parameters

Name	Type	Optional	Description
x	float
y	float

random

pub sync fn random ( ) -> core::math::Random

New random number generator

random_from_seed

pub sync fn random_from_seed ( seed : int ) -> core::math::Random

New random number generator from given seed

Parameters

Name	Type	Optional	Description
seed	int

round

pub sync fn round ( a : float ) -> float

Rounds a decimal value to the nearest integral value, and rounds midpoint values to the nearest even number.

Parameters

Name	Type	Optional	Description
a	float

sin

pub sync fn sin ( a : float ) -> float

Returns the sine of the specified angle in redian.

Parameters

Name	Type	Optional	Description
a	float

sin_deg

pub sync fn sin_deg ( x : float ) -> float

Returns the sine of the specified angle in degree.

Parameters

Name	Type	Optional	Description
x	float

sinh

pub sync fn sinh ( value : float ) -> float

Returns the hyperbolic sine of the specified angle.

Parameters

Name	Type	Optional	Description
value	float

sqrt

pub sync fn sqrt ( d : float ) -> float

Returns the square root of a specified number.

Parameters

Name	Type	Optional	Description
d	float

tan

pub sync fn tan ( a : float ) -> float

Returns the sine of the specified angle in redian.

Parameters

Name	Type	Optional	Description
a	float

tan_deg

pub sync fn tan_deg ( x : float ) -> float

Returns the sine of the specified angle in degree.

Parameters

Name	Type	Optional	Description
x	float

tanh

pub sync fn tanh ( value : float ) -> float

Returns the hyperbolic tangent of the specified angle.

Parameters

Name	Type	Optional	Description
value	float

truncate

pub sync fn truncate ( d : float ) -> float

Calculates the integral part of a specified number.

Parameters

Name	Type	Optional	Description
d	float