Float64

Utilities for working with the Float64 type.

1

from "float64" include Float64

1

5.0d

1

-5.0d

1

Infinityd

1

NaNd

Values

Functions and constants included in the Float64 module.

Float64.infinity

1

infinity : Float64

Infinity represented as a Float64 value. This is an alternative to the Infinityd literal.

Float64.nan

1

nan : Float64

NaN (Not a Number) represented as a Float64 value. This is an alternative to the NaNd literal.

Float64.pi

1

pi : Float64

Pi represented as a Float64 value.

Float64.tau

1

tau : Float64

Tau represented as a Float64 value.

Float64.e

1

e : Float64

Euler’s number represented as a Float64 value.

Float64.fromNumber

1

fromNumber : (number: Number) => Float64

Converts a Number to a Float64.

Parameters:

Returns:

Float64.toNumber

1

toNumber : (float: Float64) => Number

Converts a Float64 to a Number.

Parameters:

Returns:

Float64.(+)

1

(+) : (x: Float64, y: Float64) => Float64

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (+) }
assert 1.0d + 1.0d == 2.0d

Float64.(-)

1

(-) : (x: Float64, y: Float64) => Float64

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (-) }
assert 5.0d - 4.0d == 1.0d

Float64.(*)

1

(*) : (x: Float64, y: Float64) => Float64

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (*) }
assert -5.0d * 4.0d == -20.0d

Float64.(/)

1

(/) : (x: Float64, y: Float64) => Float64

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (/) }
assert 25.0d / 4.0d == 6.25d

Float64.(<)

1

(<) : (x: Float64, y: Float64) => Bool

Checks if the first value is less than the second value.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (<) }
assert -5.0d < 5.0d

Float64.(>)

1

(>) : (x: Float64, y: Float64) => Bool

Checks if the first value is greater than the second value.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (>) }
assert 6.0d > 5.0d

Float64.(<=)

1

(<=) : (x: Float64, y: Float64) => Bool

Checks if the first value is less than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (<=) }
assert 1.0d <= 2.0d

1
2

use Float64.{ (<=) }
assert 2.0d <= 2.0d

Float64.(>=)

1

(>=) : (x: Float64, y: Float64) => Bool

Checks if the first value is greater than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Float64.{ (>=) }
assert 5.0d >= 2.0d

1
2

use Float64.{ (>=) }
assert -1.0d >= -1.0d

Float64.isNaN

1

isNaN : (x: Float64) => Bool

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

Parameters:

Returns:

Examples:

1

Float64.isNaN(NaNd)

1

Float64.isNaN(Infinityd) == false

1

Float64.isNaN(-Infinityd) == false

1

Float64.isNaN(0.5d) == false

1

Float64.isNaN(1.0d) == false

Float64.isInfinite

1

isInfinite : (x: Float64) => Bool

Checks if a float is infinite, that is either of positive or negative infinity.

Parameters:

Returns:

Examples:

1

Float64.isInfinite(Infinityd)

1

Float64.isInfinite(-Infinityd)

1

Float64.isInfinite(NaNd) == false

1

Float64.isInfinite(0.5d) == false

1

Float64.isInfinite(1.0d) == false

Float64.abs

1

abs : (x: Float64) => Float64

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

Parameters:

Returns:

Examples:

1

Float64.abs(-1.0d) == 1.0d

1

Float64.abs(5.0d) == 5.0d

Float64.neg

1

neg : (x: Float64) => Float64

Returns the negation of its operand.

Parameters:

Returns:

Examples:

1

Float64.neg(-1.0d) == 1.0d

1

Float64.neg(1.0d) == -1.0d