Number

Utilities for working with numbers.

1

from "number" include Number

1

1

1

-1

1

0.5

1

1/2

1

Infinity

1

NaN

Types

Type declarations included in the Number module.

Number.ParseIntError

1
2
3
4
5

enum ParseIntError {
  ParseIntEmptyString,
  ParseIntInvalidDigit,
  ParseIntInvalidRadix,
}

Represents an error that occurred trying to parse an integer.

Variants:

1

ParseIntEmptyString

Represents an error caused by trying to parse an empty string.

1

ParseIntInvalidDigit

Represents an error caused by trying to parse a string with an invalid character.

1

ParseIntInvalidRadix

Represents an error caused by trying to parse with an invalid radix.

Values

Functions and constants included in the Number module.

Number.pi

1

pi : Number

Pi represented as a Number value.

Number.tau

1

tau : Number

Tau represented as a Number value.

Number.e

1

e : Number

Euler’s number represented as a Number value.

Number.(+)

1

(+) : (num1: Number, num2: Number) => Number

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

from Number use { (+) }
assert 1 + 2 == 3

Number.(-)

1

(-) : (num1: Number, num2: Number) => Number

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

from Number use { (-) }
assert 5 - 2 == 3

Number.(*)

1

(*) : (num1: Number, num2: Number) => Number

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

from Number use { (*) }
assert 5 * 4 == 20

Number.(/)

1

(/) : (num1: Number, num2: Number) => Number

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

from Number use { (/) }
assert 10 / 2.5 == 4

Number.(**)

1

(**) : (base: Number, power: Number) => Number

Computes the exponentiation of the given base and power.

Parameters:

Returns:

Examples:

1
2

from Number use { (**) }
assert 10 ** 2 == 100

Number.exp

1

exp : (power: Number) => Number

Computes the exponentiation of Euler’s number to the given power.

Parameters:

Returns:

Examples:

1

Number.exp(1) == Number.e

1

Number.exp(10) == 22026.465794806703

Number.sqrt

1

sqrt : (x: Number) => Number

Computes the square root of its operand.

Parameters:

Returns:

Examples:

1

Number.sqrt(25) == 5

Number.sign

1

sign : (x: Number) => Number

Determine the positivity or negativity of a Number.

Parameters:

Returns:

Examples:

1

Number.sign(-10000) == -1

1

Number.sign(222222) == 1

1

Number.sign(0) == 0

Number.min

1

min : (x: Number, y: Number) => Number

Returns the smaller of its operands.

Parameters:

Returns:

Examples:

1

Number.min(5, 2) == 2

Number.max

1

max : (x: Number, y: Number) => Number

Returns the larger of its operands.

Parameters:

Returns:

Examples:

1

Number.max(5, 2) == 5

Number.ceil

1

ceil : (x: Number) => Number

Rounds its operand up to the next largest integer.

Parameters:

Returns:

Examples:

1

Number.ceil(5.5) == 6

1

Number.ceil(-5.5) == -5

Number.floor

1

floor : (x: Number) => Number

Rounds its operand down to the largest integer less than the operand.

Parameters:

Returns:

Examples:

1

Number.floor(5.5) == 5

1

Number.floor(-5.5) == -6

Number.trunc

1

trunc : (x: Number) => Number

Returns the integer part of its operand, removing any fractional value.

Parameters:

Returns:

Examples:

1

Number.trunc(5.5) == 5

Number.round

1

round : (x: Number) => Number

Returns its operand rounded to its nearest integer.

Parameters:

Returns:

Examples:

1

Number.round(5.5) == 6

1

Number.round(5.4) == 5

1

Number.round(-5.5) == -6

1

Number.round(-5.4) == -5

Number.abs

1

abs : (x: Number) => Number

Returns the absolute value of a number. That is, it returns x if x is positive or zero and the negation of x if x is negative.

Parameters:

Returns:

Examples:

1

Number.abs(-1) == 1

1

Number.abs(5) == 5

Number.neg

1

neg : (x: Number) => Number

Returns the negation of its operand.

Parameters:

Returns:

Examples:

1

Number.neg(-1) == 1

1

Number.neg(1) == -1

Number.isFloat

1

isFloat : (x: Number) => Bool

Checks if a number is a floating point value.

Parameters:

Returns:

Examples:

1

Number.isFloat(0.5)

1

Number.isFloat(1.0)

1

Number.isFloat(Infinity)

1

Number.isFloat(NaN)

1

Number.isFloat(1/2) == false

1

Number.isFloat(1) == false

Number.isInteger

1

isInteger : (x: Number) => Bool

Checks if a number is an integer.

Parameters:

Returns:

Examples:

1

Number.isInteger(1)

1

Number.isInteger(0.5) == false

1

Number.isInteger(1.0) == false

1

Number.isInteger(1/2) == false

1

Number.isInteger(Infinity) == false

1

Number.isInteger(NaN) == false

Number.isRational

1

isRational : (x: Number) => Bool

Checks if a number is a non-integer rational value.

Parameters:

Returns:

Examples:

1

Number.isRational(1/2)

1

Number.isRational(0.5) == false

1

Number.isRational(1.0) == false

1

Number.isRational(1) == false

1

Number.isRational(Infinity) == false

1

Number.isRational(NaN) == false

Number.isFinite

1

isFinite : (x: Number) => Bool

Checks if a number is finite. All values are finite exept for floating point NaN, infinity or negative infinity.

Parameters:

Returns:

Examples:

1

Number.isFinite(1/2)

1

Number.isFinite(0.5)

1

Number.isFinite(1.0)

1

Number.isFinite(1)

1

Number.isFinite(Infinity) == false

1

Number.isFinite(-Infinity) == false

1

Number.isFinite(NaN) == false

Number.isNaN

1

isNaN : (x: Number) => Bool

Checks if a number is the float NaN value (Not A Number).

Parameters:

Returns:

Examples:

1

Number.isNaN(NaN)

1

Number.isNaN(Infinity) == false

1

Number.isNaN(-Infinity) == false

1

Number.isNaN(1/2) == false

1

Number.isNaN(0.5) == false

1

Number.isNaN(1.0) == false

1

Number.isNaN(1) == false

Number.isInfinite

1

isInfinite : (x: Number) => Bool

Checks if a number is infinite, that is either of floating point positive or negative infinity. Note that this function is not the exact opposite of isFinite(Number) in that it doesn’t return true for NaN.

Parameters:

Returns:

Examples:

1

Number.isInfinite(Infinity)

1

Number.isInfinite(-Infinity)

1

Number.isInfinite(NaN) == false

1

Number.isInfinite(1/2) == false

1

Number.isInfinite(0.5) == false

1

Number.isInfinite(1.0) == false

1

Number.isInfinite(1) == false

Number.isClose

1
2
3

isClose :
  (a: Number, b: Number, ?relativeTolerance: Number,
   ?absoluteTolerance: Number) => Bool

Determines whether two values are considered close to each other using a relative and absolute tolerance.

Parameters:

Returns:

Examples:

1

Number.isClose(1.233, 1.233)

1

Number.isClose(1.233, 1.233000001)

1

Number.isClose(8.005, 8.450, absoluteTolerance=0.5)

1

Number.isClose(4, 4.1, relativeTolerance=0.025)

1

Number.isClose(1.233, 1.24) == false

1

Number.isClose(1.233, 1.4566) == false

1

Number.isClose(8.005, 8.450, absoluteTolerance=0.4) == false

1

Number.isClose(4, 4.1, relativeTolerance=0.024) == false

Number.parseInt

1
2

parseInt :
  (string: String, radix: Number) => Result<Number, Atoi.ParseIntError>

Parses a string representation of an integer into a Number using the specified radix (also known as a number system “base”).

If the string has a radix prefix (i.e. “0x”/“0X”, “0o”/“0O”, or “0b”/“0B” for radixes 16, 8, or 2 respectively), the supplied radix is ignored in favor of the prefix. Underscores that appear in the numeric portion of the input are ignored.

Parameters:

Returns:

Examples:

1

Number.parseInt("1", radix=10) == Ok(1)

1

Number.parseInt("-1", radix=10) == Ok(-1)

1

Number.parseInt("0xf0", radix=16) == Ok(0x0f0)

Number.parseFloat

1

parseFloat : (string: String) => Result<Number, String>

Parses a string representation of a float into a Number. Underscores that appear in numeric portions of the input are ignored.

Parameters:

Returns:

Examples:

1

Number.parseFloat("1") == Ok(1.0)

1

Number.parseFloat("-1") == Ok(-1.0)

1

Number.parseFloat("-1.5") == Ok(-1.5)

Number.parse

1

parse : (input: String) => Result<Number, Atoi.ParseIntError>

Parses a string representation of an integer, float, or rational into a Number. Underscores that appear in the numeric portion of the input are ignored.

Parameters:

Returns:

Examples:

1

Number.parse("1") == Ok(1)

1

Number.parse("-1") == Ok(-1)

1

Number.parse("0xf0") == Ok(0x0f0)

1

Number.parse("-1.5") == Ok(-1.5)

Number.asin

1

asin : (angle: Number) => Number

Computes the inverse sine of the given angle.

Parameters:

Returns:

Examples:

1

Number.asin(0) == 0

1

Number.asin(1) == 1.5707963267948966

Number.acos

1

acos : (angle: Number) => Number

Computes the inverse cosine of the given angle.

Parameters:

Returns:

Examples:

1

Number.acos(1) == 0

1

Number.acos(0) == 1.5707963267948966

Number.atan

1

atan : (angle: Number) => Number

Computes the inverse tangent of the given angle.

Parameters:

Returns:

Examples:

1

Number.atan(0) == 0

1

Number.atan(1) == 0.7853981633974483

Number.atan2

1

atan2 : (y: Number, x: Number) => Number

Computes the angle between the positive x-axis and the ray from the origin to the point (x, y).

Parameters:

Returns:

Examples:

1

Number.atan2(0, 1) == Number.pi

Number.toRadians

1

toRadians : (degrees: Number) => Number

Converts degrees to radians.

Parameters:

Returns:

Examples:

1

Number.toRadians(180) == Number.pi

Number.toDegrees

1

toDegrees : (radians: Number) => Number

Converts radians to degrees.

Parameters:

Returns:

Examples:

1

Number.toRadians(Number.pi) == 180

Number.clamp

1

clamp : (range: Range<Number>, input: Number) => Number

Constrains a number within the given inclusive range.

Parameters:

Returns:

Number.linearInterpolate

1

linearInterpolate : (range: Range<Number>, weight: Number) => Number

Maps a weight between 0 and 1 within the given inclusive range.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When weight is not between 0 and 1
• When range is not finite
• When range includes NaN

Number.linearMap

1
2
3

linearMap :
  (inputRange: Range<Number>, outputRange: Range<Number>, current: Number) =>
   Number

Scales a number from one inclusive range to another inclusive range. If the number is outside the input range, it will be clamped.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When inputRange is not finite
• When inputRange includes NaN
• When outputRange is not finite
• When outputRange includes NaN