Number

Utilities for working with numbers.

1

import Number from "number"

Constants

Number constant values.

Number.nan

1

nan : Number

NaN represented as a Number value.

Number.infinity

1

infinity : Number

Infinity represented as a Number value.

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.

Operations

Functions for operating on values of the Number type.

Number.add

1

add : (Number, Number) -> Number

Computes the sum of its operands.

Parameters:

Returns:

Number.sub

1

sub : (Number, Number) -> Number

Computes the difference of its operands.

Parameters:

Returns:

Number.mul

1

mul : (Number, Number) -> Number

Computes the product of its operands.

Parameters:

Returns:

Number.div

1

div : (Number, Number) -> Number

Computes the quotient of its operands.

Parameters:

Returns:

Number.pow

1

pow : (Number, Number) -> Number

Computes the exponentiation of the given base and power.

Parameters:

Returns:

Number.exp

1

exp : Number -> Number

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

Parameters:

Returns:

Number.sqrt

1

sqrt : Number -> Number

Computes the square root of its operand.

Parameters:

Returns:

Number.sign

1

sign : 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 : (Number, Number) -> Number

Returns the smaller of its operands.

Parameters:

Returns:

Number.max

1

max : (Number, Number) -> Number

Returns the larger of its operands.

Parameters:

Returns:

Number.ceil

1

ceil : Number -> Number

Rounds its operand up to the next largest integer.

Parameters:

Returns:

Number.floor

1

floor : Number -> Number

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

Parameters:

Returns:

Number.trunc

1

trunc : Number -> Number

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

Parameters:

Returns:

Number.round

1

round : Number -> Number

Returns its operand rounded to its nearest integer.

Parameters:

Returns:

Number.abs

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:

Returns:

Number.neg

1

neg : Number -> Number

Returns the negation of its operand.

Parameters:

Returns:

Number.isFloat

1

isFloat : Number -> Bool

Checks if a number is a floating point value.

Parameters:

Returns:

Number.isInteger

1

isInteger : Number -> Bool

Checks if a number is an integer.

Parameters:

Returns:

Number.isRational

1

isRational : Number -> Bool

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

Parameters:

Returns:

Number.isFinite

1

isFinite : Number -> Bool

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

Parameters:

Returns:

Number.isNaN

1

isNaN : Number -> Bool

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

Parameters:

Returns:

Number.isInfinite

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:

Returns:

Number.parseInt

1

parseInt : (String, Number) -> Result<Number, String>

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:

Number.parseFloat

1

parseFloat : 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:

Number.parse

1

parse : String -> Result<Number, String>

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:

Number.sin

1

sin : Number -> Number

Computes the sine of a number (in radians) using Chebyshev polynomials.

Parameters:

Returns:

Number.cos

1

cos : Number -> Number

Computes the cosine of a number (in radians) using Chebyshev polynomials.

Parameters:

Returns:

Number.tan

1

tan : Number -> Number

Computes the tangent of a number (in radians) using Chebyshev polynomials.

Parameters:

Returns:

Number.gamma

1

gamma : Number -> Number

Computes the gamma function of a value using Lanczos approximation.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When z is zero

Number.factorial

1

factorial : Number -> Number

Computes the product of consecutive integers for an integer input and computes the gamma function for non-integer inputs.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When n is negative

Number.toRadians

1

toRadians : Number -> Number

Converts degrees to radians.

Parameters:

Returns:

Number.toDegrees

1

toDegrees : Number -> Number

Converts radians to degrees.

Parameters:

Returns: