Number

GitHub   Edit on GitHub

Utilities for working with numbers.

Added in 0.4.0 No other changes yet.
1
import Number from "number"

Number.add

Added in 0.4.0 No other changes yet.
1
add : (Number, Number) -> Number

Computes the sum of its operands.

Parameters:

param type description
x Number The first operand
y Number The second operand

Returns:

type description
Number The sum of the two operands

Number.sub

Added in 0.4.0 No other changes yet.
1
sub : (Number, Number) -> Number

Computes the difference of its operands.

Parameters:

param type description
x Number The first operand
y Number The second operand

Returns:

type description
Number The difference of the two operands

Number.mul

Added in 0.4.0 No other changes yet.
1
mul : (Number, Number) -> Number

Computes the product of its operands.

Parameters:

param type description
x Number The first operand
y Number The second operand

Returns:

type description
Number The product of the two operands

Number.div

Added in 0.4.0 No other changes yet.
1
div : (Number, Number) -> Number

Computes the quotient of its operands.

Parameters:

param type description
x Number The dividend
y Number The divisor

Returns:

type description
Number The quotient of the two operands

Number.sqrt

Added in 0.4.0 No other changes yet.
1
sqrt : Number -> Number

Computes the square root of its operand.

Parameters:

param type description
x Number The number to square root

Returns:

type description
Number The square root of the operand

Number.min

Added in 0.4.0 No other changes yet.
1
min : (Number, Number) -> Number

Returns the smaller of its operands.

Parameters:

param type description
x Number The first operand
y Number The second operand

Returns:

type description
Number The smaller of the two operands

Number.max

Added in 0.4.0 No other changes yet.
1
max : (Number, Number) -> Number

Returns the larger of its operands.

Parameters:

param type description
x Number The first operand
y Number The second operand

Returns:

type description
Number The larger of the two operands

Number.ceil

Added in 0.4.0 No other changes yet.
1
ceil : Number -> Number

Rounds its operand up to the next largest integer.

Parameters:

param type description
x Number The number to round

Returns:

type description
Number The next largest integer of the operand

Number.floor

Added in 0.4.0 No other changes yet.
1
floor : Number -> Number

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

Parameters:

param type description
x Number The number to round

Returns:

type description
Number The previous integer of the operand

Number.trunc

Added in 0.4.0 No other changes yet.
1
trunc : Number -> Number

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

Parameters:

param type description
x Number The number to truncate

Returns:

type description
Number The integer part of the operand

Number.round

Added in 0.4.0 No other changes yet.
1
round : Number -> Number

Returns its operand rounded to its nearest integer.

Parameters:

param type description
x Number The number to round

Returns:

type description
Number The nearest integer to the operand

Number.abs

Added in 0.4.0 No other changes yet.
1
abs : 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:

param type description
x Number The operand

Returns:

type description
Number The absolute value of the operand

Number.neg

Added in 0.4.0 No other changes yet.
1
neg : Number -> Number

Returns the negation of its operand.

Parameters:

param type description
x Number The number to negate

Returns:

type description
Number The negated operand

Number.isFinite

Added in 0.4.0 No other changes yet.
1
isFinite : Number -> Bool

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

Parameters:

param type description
x Number The number to check

Returns:

type description
Bool true if the value is finite, otherwise false

Number.isNaN

Added in 0.4.0 No other changes yet.
1
isNaN : Number -> Bool

Checks if a number contains the NaN value (Not A Number).
Only boxed floating point numbers can contain NaN.

Parameters:

param type description
x Number The number to check

Returns:

type description
Bool true if the value is NaN, otherwise false

Number.isInfinite

Added in 0.4.0 No other changes yet.
1
isInfinite : 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:

param type description
x Number The number to check

Returns:

type description
Bool true if the value is infinite, otherwise false
This is a notification!