Float0.28.0-dev

Overview
Properties
Methods

external class Float extends Number

A 64-bit floating-point number conforming to the IEEE 754 binary64 format.

Known subtypes:
Known usages:
All versions:: 0.29.0-dev, 0.28.1, 0.28.0, 0.28.0-dev, 0.27.2, 0.27.1, 0.27.0, 0.26.3, 0.26.2, 0.26.1, 0.26.0, 0.25.3, 0.25.2, 0.25.1, 0.25.0-dev

The following binary operators are supported for Numbers:

-a     // negative
a + b  // addition
a - b  // subtraction
a * b  // multiplication
a / b  // division
a ~/ b // integer division
a % b  // remainder
a ** b // exponentiation

Tip: To allow transparent use of Float and Int, use Number instead of Float in type annotations.

Properties(show inherited)

link

ns: Duration

A Duration with value this and unit "ns" (nanoseconds).
link

us: Duration

A Duration with value this and unit "us" (microseconds).
link

ms: Duration

A Duration with value this and unit "ms" (milliseconds).
link

s: Duration

A Duration with value this and unit "s" (seconds).
link

min: Duration

A Duration with value this and unit "min" (minutes).
link

h: Duration

A Duration with value this and unit "h" (hours).
link

d: Duration

A Duration with value this and unit "d" (days).
link

b: DataSize

A DataSize with value this and unit "b" (bytes).
link
kb: DataSize

A DataSize with value this and unit "kb" (kilobytes).
Facts:
```
1.kb == 1000.b
```
link
mb: DataSize

A DataSize with value this and unit "mb" (megabytes).
Facts:
```
1.mb == 1000.kb
```
link
gb: DataSize

A DataSize with value this and unit "gb" (gigabytes).
Facts:
```
1.gb == 1000.mb
```
link
tb: DataSize

A DataSize with value this and unit "tb" (terabytes).
Facts:
```
1.tb == 1000.gb
```
link
pb: DataSize

A DataSize with value this and unit "pb" (petabytes).
Facts:
```
1.pb == 1000.tb
```
link
kib: DataSize

A DataSize with value this and unit "kib" (kibibytes).
Facts:
```
1.kib == 1024.b
```
link
mib: DataSize

A DataSize with value this and unit "mib" (mebibytes).
Facts:
```
1.mib == 1024.kib
```
link
gib: DataSize

A DataSize with value this and unit "gib" (gibibytes).
Facts:
```
1.gib == 1024.mib
```
link
tib: DataSize

A DataSize with value this and unit "tib" (tebibytes).
Facts:
```
1.tib == 1024.gib
```
link
pib: DataSize

A DataSize with value this and unit "pib" (pebibytes).
Facts:
```
1.pib == 1024.tib
```
link

sign: Float

The sign of this number.

Returns 0 for 0, 0.0, -0.0, and NaN, 1 for positive numbers (including Infinity), and -1 for negative numbers (including -Infinity).

link

abs: Float

The absolute value of this number.

Facts:

42.abs == 42
-42.abs == 42
0.0.abs == 0.0
(-0.0).abs == 0.0
Infinity.abs == Infinity
(-Infinity).abs == Infinity
NaN.abs == NaN

link

ceil: Float

Rounds this number to the next mathematical integer towards Infinity.

If this is an Int, returns this. If this is NaN, Infinity, -Infinity, 0.0, or -0.0, returns this. Otherwise, returns the smallest Float that is greater than or equal to this and is equal to a mathematical integer.
link

floor: Float

Rounds this number to the next mathematical integer towards -Infinity.

If this is an Int, returns this. If this is NaN, Infinity, -Infinity, 0.0, or -0.0, returns this. Otherwise, returns the largest Float that is less than or equal to this and is equal to a mathematical integer.

link

isPositive: Boolean

Tells if this number is greater than or equal to zero.

Facts:

0.isPositive
(-0).isPositive
0.0.isPositive
(-0.0).isPositive
3.isPositive
3.14.isPositive
Infinity.isPositive

!(-3).isPositive
!(-3.14).isPositive
!(-Infinity).isPositive
!NaN.isPositive

link

isFinite: Boolean

Tells if this number is neither NaN nor isInfinite.
link

isInfinite: Boolean

Tells if this number is Infinity or -Infinity.
link

isNaN: Boolean

Tells if this number is NaN.

Always use this method when testing for NaN. Note that x == NaN is not a correct way to test for NaN because NaN != NaN as per the IEEE spec.
link

isNonZero: Boolean

Tells if this number is not 0.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

toString(): String

Converts this number to its decimal string representation.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

round(): Float

Rounds this number to the nearest mathematical integer, breaking ties in favor of the even integer.

If this is an Int, returns this. If this is NaN, Infinity, -Infinity, 0.0, or -0.0, returns this. Otherwise, return the Float that is nearest to this and is equal to a mathematical integer. If two mathematical integers are equally near, returns the even integer.
link

function

truncate(): Float

Rounds this number to the next mathematical integer towards zero.

If this is an Int, returns this. If this is NaN, Infinity, -Infinity, 0.0, or -0.0, returns this. If this is less than zero, returns the smallest Float that is greater than or equal to this and is equal to a mathematical integer. Otherwise, returns the largest Float that is less than or equal to this and is equal to a mathematical integer.
link

function

toInt(): Int

Converts this number to an Int.

If this is an Int, returns this. If this is NaN, Infinity, or -Infinity, throws an error. Otherwise, returns the Int representation for this.truncate(). If this.truncate() is not representable in (that is, too large for) Int, throws an error.
link

function

toFloat(): Float

Converts this number to a Float.

If this is a Float, returns this. Otherwise, returns the Float representation for this. If this is not representable in Float, returns the Float nearest to this.
link

function

toFixed(fractionDigits: Int(this.isBetween(0, 20))): String

Converts this number to a decimal fixed-point representation with fractionDigits digits after the decimal point.
link

function

toDuration(unit: DurationUnit): Duration

Converts this number to a duration with this value and the given unit.
link

function

toDataSize(unit: DataSizeUnit): DataSize

Converts this number to a data size with this value and the given unit.
link

function
isBetween(start: Number, inclusiveEnd: Number): Boolean

Tells if this number is greater than or equal to start and less than or equal to inclusiveEnd.
Facts:
```
3.2.isBetween(2.6, 4)
3.2.isBetween(2.6, 3.2)
3.2.isBetween(3.2, 4)
!3.2.isBetween(1, 3.1)
```