float

Infinity

## Module overview

The `lang.float` module corresponds to the `float` basic type.


Returns the IEEE absolute value of a float value.



Returns the arccosine of a float value.

Corresponds to IEEE acos operation.



acos

the arccosine of parameter `x` in radians


Returns the arcsine of a float value.

Corresponds to IEEE asin operation.



asin

Returns the arctangent of a float value.

Corresponds to IEEE atan operation.



atan

the arctangent of parameter `x` in radians


Performs the 2-argument arctangent operation.

Corresponds IEEE atan2(y, x) operation.



atan2

the angle in radians from the positive x-axis to the point
whose Cartesian coordinates are `(x, y)`


Returns the cube root of a float value.

Corresponds to IEEE rootn(x, 3) operation.



cbrt

Rounds a float up to the closest integral value.



ceiling

smallest (closest to -∞) decimal value not less than parameter `x` that is a mathematical integer


Returns the cosine of a float value.

Corresponds to IEEE cos operation.



float value, specifying an angle in radians


Returns the hyperbolic cosine of a float value.

Corresponds to IEEE cosh operation.



cosh

Raises Euler's number to a power.

Corresponds to IEEE exp operation.



Euler's number raised to the power parameter `x`


Rounds a float down to the closest integral value.



floor

largest (closest to +∞) float value not greater than parameter `x` that is a mathematical integer


Returns the float that is represented in IEEE 64-bit floating point by an int.

All bit patterns that IEEE defines to be NaNs will all be mapped to the single float NaN value.



fromBitsInt

Return the float value represented by a string.

parameter `s` must follow the syntax of HexFloatingPointLiteral as defined by the Ballerina specification
with the following modifications
- the HexFloatingPointLiteral may have a leading `+` or `-` sign
- `NaN` is allowed
- `Infinity` is allowed with an optional leading `+` or `-` sign



fromHexString

hexadecimal floating point hex string representation


string

error

Returns the float value represented by a string.

parameter `s` must follow the syntax of DecimalFloatingPointNumber as defined by the Ballerina specification
with the following modifications
- the DecimalFloatingPointNumber may have a leading `+` or `-` sign
- `NaN` is allowed
- `Infinity` is allowed with an optional leading `+` or `-` sign
- a FloatingPointTypeSuffix is not allowed
This is the inverse of function ``value:toString`` applied to an `float`.



fromString

Tests whether a float is finite.

Exactly one of isFinite, isInfinite and IsNaN will be true for any float value



isFinite

true if parameter `x` is finite, i.e., neither NaN nor +∞ nor -∞


boolean

Tests whether a float is infinite.

Exactly one of isFinite, isInfinite and IsNaN will be true for any float value



isInfinite

true if parameter `x` is either +∞ or -∞


Tests whether a float is NaN.

Exactly one of isFinite, isInfinite and IsNaN will be true for any float value.



isNaN

Returns the natural logarithm of a float value.

Corresponds to IEEE log operation.



Returns the base 10 logarithm of a float value.

Corresponds to IEEE log10 operation.



log10

Returns the maximum of zero or more float values.

Result is -∞ if no args
NaN if any arg is NaN



Returns the minimum of zero or more float values.

Result is +∞ if no args
Result is NaN if any arg is NaN



Raises one float value to the power of another float values.

Corresponds to IEEE pow(x, y) operation.



`x` raised to the power of parameter `y`


Rounds a float value to a specified number of digits.

Returns the float value that is an integral multiple of 10 raised to the power of `-fractionDigits` and closest to `x`.
If there are two such values, choose the one whose final digit is even
(this is the round-to-nearest rounding mode, which is the default for IEEE and for Ballerina).
A value of `fractionDigits` greater than 0 thus corresponds to the number of digits after the decimal
point being `fractionDigits`; a value of 0 for `fractionDigits` rounds to an integer.
If `x` is NaN, +0, -0, +∞ or -∞, then the result is `x``.
 MISSING[`]When `fractionDigits` is 0, this is
the same as Java Math.rint method, .NET Math.Round method and
IEEE roundToIntegralTiesToEven operation
Note that `<int>x` is the same as `<int>x.round(0)`.



round

the number of digits after the decimal point


fractionDigits

float value closest to `x` that is an integral multiple of 10 raised to the power of `-fractionDigits`


Returns the sine of a float value.

Corresponds to IEEE sin operation.



Returns the hyperbolic sine of a float value.

Corresponds to IEEE sinh operation.



sinh

Returns the square root of a float value.

Corresponds to IEEE squareRoot operation.



sqrt

Returns the sum of zero or more float values.

Result is NaN if any arg is NaN



sum of all of parameter `xs`, +0.0 if parameter `xs` is empty


Returns the tangent of a float value.

Corresponds to IEEE tan operation



Returns the hyperbolic tangent of a float value.

Corresponds to IEEE tanh operation.



tanh

Returns IEEE 64-bit binary floating point format representation of a float value as an int.



toBitsInt

Returns a string that represents `x` using scientific notation.
The returned string will be in the same format used by `value:toString`,
except that it will always include an exponent and there will be exactly
one digit before the decimal point.
But if `x` is NaN or infinite, the result will be the same as `value:toString`.
The digit before the decimal point will be zero only if all other digits
are zero.
This will panic if fractionDigits is less than 0.
If `fractionDigits` is zero, there will be no decimal point.
Any necessary rounding will use the roundTiesToEven rounding direction.
The exponent in the result uses lower-case `e`, followed by a `+` or `-` sign,
followed by at least two digits, and only as many more digits as are needed
to represent the result. If `x` is zero, the exponent is zero. A zero exponent
is represented with a `+` sign.



toExpString

number of digits following the decimal point; `()` means to use
the minimum number of digits required to accurately represent the value


string representation of `x` in scientific notation


Returns a string that represents `x` using fixed-point notation.
The returned string will be in the same format used by `value:toString`,
except that it will not include an exponent.
If `x` is NaN or infinite, the result will be the same as `value:toString`.
This will panic if `fractionDigits` is less than 0.
If `fractionDigits` is zero, there will be no decimal point.
Any necessary rounding will use the roundTiesToEven rounding direction.



toFixedString

string representation of `x` in fixed-point notation


Returns a string that represents a float value as a hexadecimal floating point number.

The returned string will comply to the grammar of HexFloatingPointLiteral
in the Ballerina spec with the following modifications:
- it will have a leading `-` sign if negative
- positive infinity will be represented by `Infinity`
- negative infinity will be represented by `-Infinity`
- NaN will be represented by `NaN`
The representation includes `0x` for finite numbers.



toHexString

The `lang.float` module corresponds to the `float` basic type.


Constants