shadow:standard@FloatingPoint<float>, shadow:standard@Number<double>, shadow:standard@CanHash

`immutable locked class float`

Class `float`

contains the methods that can be called on `float`

values.

Modifiers | Type | Name and Description |
---|---|---|

`public immutable constant` |
`float` |
`PI` Closest |

`public immutable constant` |
`float` |
`E` Closest |

`public immutable constant` |
`float` |
`NaN` Constant representing one of the 32-bit not-a-number values supported by the IEEE 754 standard. |

`public immutable constant` |
`float` |
`INFINITY` Constant representing positive infinity with 32 bits in the IEEE 754 standard. |

`public immutable constant` |
`float` |
`NEGATIVE_INFINITY` Constant representing negative infinity with 32 bits in the IEEE 754 standard. |

Modifiers | Return Types | Method and Description |
---|---|---|

`public` |
`()` |
`create()` |

Modifiers | Return Types | Method and Description |
---|---|---|

`public` |
`()` |
`destroy()` |

Modifiers | Return Types | Method and Description |
---|---|---|

`public readonly locked` |
`(double)` |
`add(double other)` Adds a |

`public readonly locked` |
`(float)` |
`add(float other)` |

`public readonly locked` |
`(float)` |
`ceiling()` |

`public readonly locked` |
`(int)` |
`compare(double other)` |

`public readonly locked` |
`(int)` |
`compare(float other)` |

`public readonly` |
`(float)` |
`copy(AddressMap addresses)` |

`public readonly locked` |
`(float)` |
`cos()` |

`public readonly locked` |
`(double)` |
`divide(double other)` Divides the current value by a |

`public readonly locked` |
`(float)` |
`divide(float other)` |

`public readonly locked` |
`(boolean)` |
`equal(double other)` |

`public readonly locked` |
`(boolean)` |
`equal(float other)` |

`public readonly locked` |
`(float)` |
`floor()` |

`public readonly locked` |
`(boolean)` |
`isFinite()` Checks to see if the current value represents an IEEE 754 value for a finite number. |

`public readonly locked` |
`(boolean)` |
`isInfinite()` Checks to see if the current value represents an IEEE 754 value for positive or negative infinity. |

`public readonly locked` |
`(boolean)` |
`isNaN()` Checks to see if the current value represents an IEEE 754 not-a-number value. |

`public readonly locked` |
`(float)` |
`logBase10()` |

`public readonly locked` |
`(float)` |
`logBase2()` |

`public readonly locked` |
`(float)` |
`logBaseE()` |

`public readonly locked` |
`(double)` |
`modulus(double other)` Divides the current value by a |

`public readonly locked` |
`(float)` |
`modulus(float other)` |

`public readonly locked` |
`(double)` |
`multiply(double other)` Multiplies the current value by a |

`public readonly locked` |
`(float)` |
`multiply(float other)` |

`public readonly locked` |
`(float)` |
`multiplyAdd(float multiplicand, float addend)` |

`public readonly locked` |
`(float)` |
`negate()` |

`public readonly locked` |
`(float)` |
`power(float value)` |

`public readonly locked` |
`(float)` |
`power(int value)` |

`public readonly locked` |
`(float)` |
`round()` Rounds the current |

`public readonly locked` |
`(float)` |
`sin()` |

`public readonly locked` |
`(float)` |
`squareRoot()` |

`public readonly locked` |
`(double)` |
`subtract(double other)` Subtracts a |

`public readonly locked` |
`(float)` |
`subtract(float other)` |

`public readonly locked` |
`(float)` |
`tan()` |

`public readonly locked` |
`(byte)` |
`toByte()` |

`public readonly locked` |
`(code)` |
`toCode()` |

`public readonly locked` |
`(double)` |
`toDouble()` |

`public readonly locked` |
`(float)` |
`toFloat()` |

`public readonly locked` |
`(int)` |
`toInt()` |

`public readonly locked` |
`(long)` |
`toLong()` |

`public readonly locked` |
`(short)` |
`toShort()` |

`public readonly locked` |
`(String)` |
`toString()` Returns a |

`public readonly locked` |
`(String)` |
`toString(int maxPrecision, int integerThreshold, int fractionalThreshold)` Returns a |

`public readonly locked` |
`(ubyte)` |
`toUByte()` |

`public readonly locked` |
`(uint)` |
`toUInt()` |

`public readonly locked` |
`(ulong)` |
`toULong()` |

`public readonly locked` |
`(ushort)` |
`toUShort()` |

Modifiers | Return Types | Method and Description |
---|---|---|

`public readonly get locked` |
`(uint)` |
`bits()` Retrieves the representation of 32 bits that makes up the current |

`public readonly get locked` |
`(ulong)` |
`hash()` Finds a hash value for the current value. |

`public readonly get locked` |
`(uint)` |
`raw()` |

`public immutable constant float PI`

Closest `float`

to the mathematical constant pi, the ratio of a circle's circumference to its diameter, approximately 3.1415927.

`public immutable constant float E`

Closest `float`

to the mathematical constant e, the base of the natural logarithm, approximately 2.7182817.

`public immutable constant float NaN`

Constant representing one of the 32-bit not-a-number values supported by the IEEE 754 standard.

`public immutable constant float INFINITY`

Constant representing positive infinity with 32 bits in the IEEE 754 standard.

`public immutable constant float NEGATIVE_INFINITY`

Constant representing negative infinity with 32 bits in the IEEE 754 standard.

`public create() => ()`

`public destroy() => ()`

`public readonly locked add(double other) => (double)`

Adds a `double`

to the current value and returns the resulting `double`

.

`other`

- value to add

sum of the two values

`public readonly locked ceiling() => (float)`

`public readonly copy(AddressMap addresses) => (float)`

`public readonly locked cos() => (float)`

`public readonly locked divide(double other) => (double)`

Divides the current value by a `double`

and returns the quotient.

`other`

- value to divide by

quotient of the division

`public readonly locked floor() => (float)`

`public readonly locked isFinite() => (boolean)`

Checks to see if the current value represents an IEEE 754 value for a finite number.

`true`

if the current value is finite

`public readonly locked isInfinite() => (boolean)`

Checks to see if the current value represents an IEEE 754 value for positive or negative infinity.

`true`

if the current value is infinite

`public readonly locked isNaN() => (boolean)`

Checks to see if the current value represents an IEEE 754 not-a-number value.

`true`

if the current value is not a number

`public readonly locked logBase10() => (float)`

`public readonly locked logBase2() => (float)`

`public readonly locked logBaseE() => (float)`

`public readonly locked modulus(double other) => (double)`

Divides the current value by a `double`

and returns the remainder.

`other`

- value to divide by

remainder of the division

`public readonly locked multiply(double other) => (double)`

Multiplies the current value by a `double`

and returns the resulting `double`

.

`other`

- value to multiply by

product of the two values

`public readonly locked negate() => (float)`

`public readonly locked round() => (float)`

Rounds the current `float`

value to the nearest integer.

current value rounded to the nearest integer

`public readonly locked sin() => (float)`

`public readonly locked squareRoot() => (float)`

`public readonly locked subtract(double other) => (double)`

Subtracts a `double`

from the current value and returns the resulting `double`

.

`other`

- value to subtract

difference of the two values

`public readonly locked tan() => (float)`

`public readonly locked toByte() => (byte)`

`public readonly locked toCode() => (code)`

`public readonly locked toDouble() => (double)`

`public readonly locked toFloat() => (float)`

`public readonly locked toInt() => (int)`

`public readonly locked toLong() => (long)`

`public readonly locked toShort() => (short)`

`public readonly locked toString() => (String)`

Returns a `String`

representation of the value, in base 10, with a maximum precision of 9 decimal digits, a threshold of 7 integer digits before scientific notation is used, and a threshold of 3 fractional digits without integer digits before scientific notation is used.

`String`

representation

`public readonly locked toString(int maxPrecision, int integerThreshold, int fractionalThreshold) => (String)`

Returns a `String`

representation of the value, in base 10, with the specificed maximum precision of decimal digits, the specified threshold of integer digits before scientific notation is used, and the specified threshold of fractional digits without integer digits before scientific notation is used.

`String`

representation

`public readonly locked toUByte() => (ubyte)`

`public readonly locked toUInt() => (uint)`

`public readonly locked toULong() => (ulong)`

`public readonly locked toUShort() => (ushort)`

`public readonly get locked bits() => (uint)`

Retrieves the representation of 32 bits that makes up the current `float`

value, as a `uint`

, except that all NaN values are treated as the same value.

bit representation of `float`

value

`public readonly get locked hash() => (ulong)`

Finds a hash value for the current value.

hash value

`public readonly get locked raw() => (uint)`