Float32

Utilities for working with the Float32 type.

1

from "float32" include Float32

1

4.0f

1

-4.0f

1

Infinityf

1

NaNf

Values

Functions and constants included in the Float32 module.

Float32.infinity

1

infinity : Float32

Infinity represented as a Float32 value. This is an alternative to the Infinityf literal.

Float32.nan

1

nan : Float32

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

Float32.pi

1

pi : Float32

Pi represented as a Float32 value.

Float32.tau

1

tau : Float32

Tau represented as a Float32 value.

Float32.e

1

e : Float32

Euler’s number represented as a Float32 value.

Float32.fromNumber

1

fromNumber : (number: Number) => Float32

Converts a Number to a Float32.

Parameters:

Returns:

Float32.toNumber

1

toNumber : (float: Float32) => Number

Converts a Float32 to a Number.

Parameters:

Returns:

Float32.(+)

1

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

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Float32.{ (+) }
assert 1.0f + 1.0f == 2.0f

Float32.(-)

1

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

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Float32.{ (-) }
assert 1.0f - 1.0f == 0.0f

Float32.(*)

1

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

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Float32.{ (*) }
assert 2.0f * 2.0f == 4.0f

Float32.(/)

1

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

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

use Float32.{ (/) }
assert 10.0f / 4.0f == 2.5f

Float32.(<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Float32.{ (<) }
assert 1.0f < 2.0f

Float32.(>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Float32.{ (>) }
assert 2.0f > 1.0f

Float32.(<=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Float32.{ (<=) }
assert -1.0f <= 1.0f

1
2

use Float32.{ (<=) }
assert -2.0f <= -2.0f

Float32.(>=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Float32.{ (>=) }
assert 4.0f >= 1.0f

1
2

use Float32.{ (>=) }
assert 3.0f >= 3.0f

Float32.isNaN

1

isNaN : (x: Float32) => Bool

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

Parameters:

Returns:

Examples:

1

Float32.isNaN(NaNf)

1

Float32.isNaN(Infinityf) == false

1

Float32.isNaN(-Infinityf) == false

1

Float32.isNaN(0.5f) == false

1

Float32.isNaN(1.0f) == false

Float32.isInfinite

1

isInfinite : (x: Float32) => Bool

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

Parameters:

Returns:

Examples:

1

Float32.isInfinite(Infinityf)

1

Float32.isInfinite(-Infinityf)

1

Float32.isInfinite(NaNf) == false

1

Float32.isInfinite(0.5f) == false

1

Float32.isInfinite(1.0f) == false

Float32.abs

1

abs : (x: Float32) => Float32

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

Float32.abs(-1.0f) == 1.0f

1

Float32.abs(5.0f) == 5.0f

Float32.neg

1

neg : (x: Float32) => Float32

Returns the negation of its operand.

Parameters:

Returns:

Examples:

1

Float32.neg(-1.0f) == 1.0f

1

Float32.neg(1.0f) == -1.0f