Functions -
lang.float
abs |
IEEE abs operation.
|
acos |
Returns the arccosine of a float value.
|
asin |
Returns the arcsine of a float value.
|
atan |
Returns the arctangent of a float value.
|
atan2 |
Performs the 2-argument arctangent operation.
|
cbrt |
Returns the cube root of a float value.
|
ceiling |
Rounds a float up to the closest integral value.
|
cos |
Returns the cosine of a float value.
|
cosh |
Returns the hyperbolic cosine of a float value.
|
exp |
Raises Euler's number to a power.
|
floor |
Rounds a float down to the closest integral value.
|
fromBitsInt |
Returns the float that is represented in IEEE 64-bit floating point by
x .
|
fromHexString |
Return the float value represented by
s .
|
fromString |
Return the float value represented by
s .
|
isFinite |
Tests whether a float is finite.
|
isInfinite |
Tests whether a float is infinite.
|
isNaN |
Tests whether a float is NaN.
|
log |
Returns the natural logarithm of a float value
Corresponds to IEEE log operation.
|
log10 |
Returns the base 10 logarithm of a float value.
|
max |
Maximum of zero or more float values.
|
min |
Minimum of zero or more float values.
|
pow |
Raises one float value to the power of another float values.
|
round |
Round a float value to the closest integral value.
|
sin |
Returns the sine of a float value.
|
sinh |
Returns the hyperbolic sine of a float value.
|
sqrt |
Returns the square root of a float value.
|
sum |
Sum of zero or more float values.
|
tan |
Returns the tangent of a float value.
|
tanh |
Returns the hyperbolic tangent of a float value.
|
toBitsInt |
Returns IEEE 64-bit binary floating point format representation of
x as an int.
|
toHexString |
Returns a string that represents
x as a hexadecimal floating point number.
|
Parameters
- x float
-
float value to operate on
-
Return Type
(float) absolute value of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) the arccosine of
x
in radians
Parameters
- x float
-
float value to operate on
-
Return Type
(float) the arcsine of
x
in radians
Parameters
- x float
-
float value to operate on
-
Return Type
(float) the arctangent of
x
in radians
Parameters
- y float
-
the y-coordinate
- x float
-
the x-coordinate
-
Return Type
(float) the angle in radians from the positive x-axis to the point whose Cartesian coordinates are
(x, y)
Parameters
- x float
-
float value to operate on
-
Return Type
(float) cube root of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) smallest (closest to -∞) decimal value not less than
x
that is a mathematical integer
Parameters
- x float
-
float value, specifying an angle in radians
-
Return Type
(float) the cosine of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) hyperbolic cosine of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) Euler's number raised to the power
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) largest (closest to +∞) float value not greater than
x
that is a mathematical integer.
x
.
All bit patterns that IEEE defines to be NaNs will all be mapped to the single float NaN value.
Parameters
- x int
-
int value
-
Return Type
(float) x
bit pattern as a float
s
.
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 allowedInfinity
is allowed with an optional leading+
or-
sign
Parameters
- s string
-
hexadecimal floating point hex string representation
-
Return Type
(float | error) float value or error
s
.
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 allowedInfinity
is allowed with an optional leading+
or-
sign- a FloatingPointTypeSuffix is not allowed
This is the inverse of
value:toString
applied to anfloat
.
Parameters
- s string
-
string representation of a float
-
Return Type
(float | error) float value or error
Parameters
- x float
-
the float to be tested
-
Return Type
(boolean) true if
x
is finite, i.e. neither NaN nor +∞ nor -∞
Parameters
- x float
-
the float to be tested
-
Return Type
(boolean) true if
x
is either +∞ or -∞
Parameters
- x float
-
the float to be tested
-
Return Type
(boolean) true if
x
is NaN
Parameters
- x float
-
float value to operate on
-
Return Type
(float) natural logarithm of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) base 10 logarithm of
x
Parameters
- xs float[]
-
float values to operate on
-
Return Type
(float) maximum value of all the
xs
Parameters
- xs float[]
-
float values to operate on
-
Return Type
(float) minimum value of all the
xs
Parameters
- x float
-
base value
- y float
-
the exponent
-
Return Type
(float) x
raised to the power ofy
x
.
If there are two such values, choose the one that is even
(this is the round-to-nearest rounding mode, which is the default for IEEE and for Ballerina).
Same as Java Math.rint method
Same as .NET Math.Round method
IEEE roundToIntegralTiesToEven operation
Note that <int>x
is the same as <int>x.round()
Parameters
- x float
-
float value to operate on
-
Return Type
(float) closest float value to
x
that is a mathematical integer
Parameters
- x float
-
float value, specifying an angle in radians
-
Return Type
(float) the sine of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) hyperbolic sine of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) square root of
x
Parameters
- xs float[]
-
float values to sum
-
Return Type
(float) sum of all the
xs
, +0.0 ifxs
is empty
Parameters
- x float
-
float value, specifying an angle in radians
-
Return Type
(float) the tangent of
x
Parameters
- x float
-
float value to operate on
-
Return Type
(float) hyperbolic tangent of
x
x
as an int.
Parameters
- x float
-
float value
-
Return Type
(int) x
bit pattern as an int
x
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 includes0x
for finite numbers.
Parameters
- x float
-
float value
-
Return Type
(string) hexadecimal floating point hex string representation