Float64

GitHub   Edit on GitHub

Utilities for working with the Float64 type.

Added in 0.2.0 No other changes yet.
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

Added in 0.4.0 No other changes yet.
1
infinity : Float64

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

Float64.nan

Added in 0.4.0 No other changes yet.
1
nan : Float64

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

Float64.pi

Added in 0.5.2 No other changes yet.
1
pi : Float64

Pi represented as a Float64 value.

Float64.tau

Added in 0.5.2 No other changes yet.
1
tau : Float64

Tau represented as a Float64 value.

Float64.e

Added in 0.5.2 No other changes yet.
1
e : Float64

Euler’s number represented as a Float64 value.

Float64.fromNumber

Added in 0.2.0 No other changes yet.
1
fromNumber : (number: Number) => Float64

Converts a Number to a Float64.

Parameters:

param type description
number Number The value to convert

Returns:

type description
Float64 The Number represented as a Float64

Float64.toNumber

Added in 0.2.0 No other changes yet.
1
toNumber : (float: Float64) => Number

Converts a Float64 to a Number.

Parameters:

param type description
float Float64 The value to convert

Returns:

type description
Number The Float64 represented as a Number

Float64.(+)

Added in 0.6.0
versionchanges
0.2.0Originally named `add`
1
(+) : (x: Float64, y: Float64) => Float64

Computes the sum of its operands.

Parameters:

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

Returns:

type description
Float64 The sum of the two operands

Examples:

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

Float64.(-)

Added in 0.6.0
versionchanges
0.2.0Originally named `sub`
1
(-) : (x: Float64, y: Float64) => Float64

Computes the difference of its operands.

Parameters:

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

Returns:

type description
Float64 The difference of the two operands

Examples:

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

Float64.(*)

Added in 0.6.0
versionchanges
0.2.0Originally named `mul`
1
(*) : (x: Float64, y: Float64) => Float64

Computes the product of its operands.

Parameters:

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

Returns:

type description
Float64 The product of the two operands

Examples:

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

Float64.(/)

Added in 0.6.0
versionchanges
0.2.0Originally named `div`
1
(/) : (x: Float64, y: Float64) => Float64

Computes the quotient of its operands.

Parameters:

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

Returns:

type description
Float64 The quotient of the two operands

Examples:

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

Float64.(<)

Added in 0.6.0
versionchanges
0.2.0Originally named `lt`
1
(<) : (x: Float64, y: Float64) => Bool

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

Parameters:

param type description
x Float64 The first value
y Float64 The second value

Returns:

type description
Bool true if the first value is less than the second value or false otherwise

Examples:

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

Float64.(>)

Added in 0.6.0
versionchanges
0.2.0Originally named `gt`
1
(>) : (x: Float64, y: Float64) => Bool

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

Parameters:

param type description
x Float64 The first value
y Float64 The second value

Returns:

type description
Bool true if the first value is greater than the second value or false otherwise

Examples:

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

Float64.(<=)

Added in 0.6.0
versionchanges
0.2.0Originally named `lte`
1
(<=) : (x: Float64, y: Float64) => Bool

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

Parameters:

param type description
x Float64 The first value
y Float64 The second value

Returns:

type description
Bool true if the first value is less than or equal to the second value or false otherwise

Examples:

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

Float64.(>=)

Added in 0.6.0
versionchanges
0.2.0Originally named `gte`
1
(>=) : (x: Float64, y: Float64) => Bool

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

Parameters:

param type description
x Float64 The first value
y Float64 The second value

Returns:

type description
Bool true if the first value is greater than or equal to the second value or false otherwise

Examples:

1
2
use Float64.{ (>=) }
assert 5.0d >= 2.0d
1
2
use Float64.{ (>=) }
assert -1.0d >= -1.0d

Float64.isNaN

Added in 0.6.5 No other changes yet.
1
isNaN : (x: Float64) => Bool

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

Parameters:

param type description
x Float64 The value to check

Returns:

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

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

Added in 0.6.5 No other changes yet.
1
isInfinite : (x: Float64) => Bool

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

Parameters:

param type description
x Float64 The value to check

Returns:

type description
Bool true if the value is infinite or false otherwise

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

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

param type description
x Float64 The operand

Returns:

type description
Float64 The absolute value of the operand

Examples:

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

Float64.neg

Added in 0.6.5 No other changes yet.
1
neg : (x: Float64) => Float64

Returns the negation of its operand.

Parameters:

param type description
x Float64 The operand

Returns:

type description
Float64 The negated operand

Examples:

1
Float64.neg(-1.0d) == 1.0d
1
Float64.neg(1.0d) == -1.0d
This is a notification!