2024 December Release

Class FSCEXPEXT@1.1001:MathFunctions Permanent link for this heading

Math Functions.

Note: The trigonometric functions (sin(), cos(), tan(), asin(), acos(), atan(), atan2()) expect or return angles in radians. To convert radians to degrees, divide by (Math.PI / 180), and multiply by this to convert the other way.

Note: Many math functions have a precision that is implementation-dependent. This means that a different OS or architecture can give different results.

Class Hierarchy

Object > ComponentObject > MathFunctions

Actions Permanent link for this heading

Return Type

Signature

float

abs(
  float x,
  out retval float result)

float

acos(
  float x,
  out retval float result)

float

acosh(
  float x,
  out retval float result)

float

asin(
  float x,
  out retval float result)

float

asinh(
  float x,
  out retval float result)

float

atan(
  float x,
  out retval float result)

float

atan2(
  float y,
  float x,
  out retval float result)

float

atanh(
  float x,
  out retval float result)

float

cbrt(
  float x,
  out retval float result)

float

ceil(
  float x,
  out retval float result)

float

clz32(
  float x,
  out retval float result)

float

cos(
  float x,
  out retval float result)

float

cosh(
  float x,
  out retval float result)

float

exp(
  float x,
  out retval float result)

float

expm1(
  float x,
  out retval float result)

float

floor(
  float x,
  out retval float result)

float

fround(
  float x,
  out retval float result)

float

hypot(
  float x,
  float y,
  out retval float result)

float

imul(
  float x,
  float y,
  out retval float result)

float

log(
  float x,
  out retval float result)

float

log10(
  float x,
  out retval float result)

float

log1p(
  float x,
  out retval float result)

float

log2(
  float x,
  out retval float result)

float

pow(
  float x,
  float y,
  out retval float result)

float

random(
  out retval float result)

float

round(
  float x,
  out retval float result)

float

sign(
  float x,
  out retval float result)

float

sin(
  float x,
  out retval float result)

float

sinh(
  float x,
  out retval float result)

float

sqrt(
  float x,
  out retval float result)

float

tan(
  float x,
  out retval float result)

float

tanh(
  float x,
  out retval float result)

float

trunc(
  float x,
  out retval float result)

Actions Permanent link for this heading


FSCEXPEXT@1.1001:abs Permanent link for this heading

Returns the absolute value of a number.

float FSCEXPEXT@1.1001:abs(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:acos Permanent link for this heading

Returns the arccosine of a number.

float FSCEXPEXT@1.1001:acos(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:acosh Permanent link for this heading

Returns the hyperbolic arccosine of a number.

float FSCEXPEXT@1.1001:acosh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:asin Permanent link for this heading

Returns the arcsine of a number.

float FSCEXPEXT@1.1001:asin(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:asinh Permanent link for this heading

Returns the hyperbolic arcsine of a number.

float FSCEXPEXT@1.1001:asinh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:atan Permanent link for this heading

Returns the arctangent of a number.

float FSCEXPEXT@1.1001:atan(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:atan2 Permanent link for this heading

Returns the angle in the plane (in radians) between the positive x-axis and the ray from (0, 0) to the point (x,y).

float FSCEXPEXT@1.1001:atan2(
  float y,
  float x,
  out retval float result)

Name

Description

y
the y coordinate value.

x
the x coordinate value.

result
the result.

FSCEXPEXT@1.1001:atanh Permanent link for this heading

Returns the hyperbolic arctangent of a number.

float FSCEXPEXT@1.1001:atanh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:cbrt Permanent link for this heading

Returns the cube root of a number.

float FSCEXPEXT@1.1001:cbrt(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:ceil Permanent link for this heading

Returns the smallest integer greater than or equal to a number.

float FSCEXPEXT@1.1001:ceil(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:clz32 Permanent link for this heading

Returns the number of leading zeroes of a 32-bit integer.

float FSCEXPEXT@1.1001:clz32(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:cos Permanent link for this heading

Returns the cosine of a number.

float FSCEXPEXT@1.1001:cos(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:cosh Permanent link for this heading

Returns the hyperbolic cosine of a number.

float FSCEXPEXT@1.1001:cosh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:exp Permanent link for this heading

Returns E^x, where x is the argument, and E is Euler's constant (2.718...), the base of the natural logarithm.

float FSCEXPEXT@1.1001:exp(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:expm1 Permanent link for this heading

Returns subtracting 1 from exp(x).

float FSCEXPEXT@1.1001:expm1(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:floor Permanent link for this heading

Returns the largest integer less than or equal to a number.

float FSCEXPEXT@1.1001:floor(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:fround Permanent link for this heading

Returns the nearest single precision float representation of a number.

float FSCEXPEXT@1.1001:fround(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:hypot Permanent link for this heading

Returns the square root of the sum of squares of its arguments.

float FSCEXPEXT@1.1001:hypot(
  float x,
  float y,
  out retval float result)

Name

Description

x
the value.

y
the value.

result
the result.

FSCEXPEXT@1.1001:imul Permanent link for this heading

Returns the result of a 32-bit integer multiplication.

float FSCEXPEXT@1.1001:imul(
  float x,
  float y,
  out retval float result)

Name

Description

x
the value.

y
the value.

result
the result.

FSCEXPEXT@1.1001:log Permanent link for this heading

Returns the natural logarithm (loge, also ln) of a number.

float FSCEXPEXT@1.1001:log(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:log10 Permanent link for this heading

Returns the base 10 logarithm of a number.

float FSCEXPEXT@1.1001:log10(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:log1p Permanent link for this heading

Returns the natural logarithm (loge, also ln) of 1 + x for a number x.

float FSCEXPEXT@1.1001:log1p(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:log2 Permanent link for this heading

Returns the base 2 logarithm of a number.

float FSCEXPEXT@1.1001:log2(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:pow Permanent link for this heading

Returns base to the exponent power, that is, baseexponent.

float FSCEXPEXT@1.1001:pow(
  float x,
  float y,
  out retval float result)

Name

Description

x
the value.

y
the value.

result
the result.

FSCEXPEXT@1.1001:random Permanent link for this heading

Returns a pseudo-random number between 0 and 1. See InitializeRandom.

float FSCEXPEXT@1.1001:random(
  out retval float result)

Name

Description

result
the result.

FSCEXPEXT@1.1001:round Permanent link for this heading

Returns the value of a number rounded to the nearest integer.
Note: this function rounds to the next integer away from zero (differs from ECMAScript). 
round(3.5) == 4
round(-3.5) == -4

float FSCEXPEXT@1.1001:round(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:sign Permanent link for this heading

Returns the sign of the x, indicating whether x is positive, negative or zero.

float FSCEXPEXT@1.1001:sign(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:sin Permanent link for this heading

Returns the sine of a number.

float FSCEXPEXT@1.1001:sin(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:sinh Permanent link for this heading

Returns the hyperbolic sine of a number.

float FSCEXPEXT@1.1001:sinh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:sqrt Permanent link for this heading

Returns the positive square root of a number.

float FSCEXPEXT@1.1001:sqrt(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:tan Permanent link for this heading

Returns the tangent of a number.

float FSCEXPEXT@1.1001:tan(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:tanh Permanent link for this heading

Returns the hyperbolic tangent of a number.

float FSCEXPEXT@1.1001:tanh(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.

FSCEXPEXT@1.1001:trunc Permanent link for this heading

Returns the integer part of the number x, removing any fractional digits.

float FSCEXPEXT@1.1001:trunc(
  float x,
  out retval float result)

Name

Description

x
the value.

result
the result.