Float
@Serializable { simple=true }
const class Float : Num
Float is used to represent a 64-bit floating point number.
Parse a Str into a Float
Float value for e which is the base of natural logarithms
Float value for negative infinity
Float value for pi which is the ratio of the circumference of a circle to its diameter
Float value for Not-A-Number
Float value for positive infinity
Default value is 0f
Return remainder of this divided by b
Multiply this with b
Return the cosine of this angle in radians
Return if this is Float.nan
Return the arc tangent
Divide this by b
Return square root of this value
Return e raised to this power
Clamp this float between the min and max
Converts rectangular coordinates (x, y) to polar (r, theta)
Return tangent of this angle in radians
Get string representation according to the lexical representation defined by Section 3.2.5 of XML Schema Part 2
Return hyperbolic sine
Get this Float as a Fantom code literal
Return 64-bit representation according IEEE 754 floating-point double format bit layout
Convert this angle in radians to an angle in degrees
Return the arc cosine
Returns the smallest whole number greater than or equal to this number
Add this with b
Divide this by b
Make a Float for the specified 32-bit representation according IEEE 754 floating-point single format bit layout
If this value is negative zero then return normalized zero, otherwise return this value
Divide this by b
Return bits()
Return if this is negative zero value
Subtract b from this
Compare based on floating point value
Return natural logarithm of this number
Return base 10 logarithm of this number
Return remainder of this divided by b
Increment by one
Multiply this with b
Add this with b
Generate a random float between 0.0 inclusive and 1.0 exclusive
Return hyperbolic tangent
Return the smaller of this and the specified Float values
Subtract b from this
Return this value raised to the specified power
Return sine of this angle in radians
Return 32-bit representation according IEEE 754 floating-point single format bit layout
Returns the largest whole number less than or equal to this number
Add this with b
Format this floating point number for the current locale
Return remainder of this divided by b
Return the larger of this and the specified Float values
Convert this angle in degrees to an angle in radians
Return the hyperbolic cosine
Return the absolute value of this float
Returns the nearest whole number to this number
Make a Float for the specified 64-bit representation according IEEE 754 floating-point double format bit layout
Decrement by one
Subtract b from this
Negative of this
Return true if same float value
Return the arc sine
Multiply this with b
Return if this Float is approximately equal to the given Float by the specified tolerance
Float abs()
Return the absolute value of this float. If this value is positive then return this, otherwise return the negation.
Float acos()
Return the arc cosine.
Bool approx(Float r, Float? tolerance)
Return if this Float is approximately equal to the given Float by the specified tolerance. If tolerance is null, then it is computed using the magnitude of the two Floats. It is useful for comparing Floats since often they lose a bit of precision during manipulation. This method is equivalent to:
if (tolerance == null) tolerance = min(abs(this/1e6), abs(r/1e6)) (this - r).abs < tolerance
Float asin()
Return the arc sine.
Float atan()
Return the arc tangent.
static Float atan2(Float y, Float x)
Converts rectangular coordinates (x, y) to polar (r, theta).
Int bits()
Return 64-bit representation according IEEE 754 floating-point double format bit layout. This method is paired with Float.makeBits.
Int bits32()
Return 32-bit representation according IEEE 754 floating-point single format bit layout. This method is paired with Float.makeBits32.
Float ceil()
Returns the smallest whole number greater than or equal to this number.
Float clamp(Float min, Float max)
Clamp this float between the min and max. If its less than min then return min, if its greater than max return max, otherwise return this float itself.
virtual Int compare(Obj obj)
Compare based on floating point value.
NaN works as follows:
- for the
<=>operator NaN is always less than other values and equal to itself (so sort works as expected) - for all other comparison operators anything compared against NaN is false (normal Java semanatics)
Examples:
Float.nan <=> Float.nan => 0 2f <=> Float.nan => 1 Float.nan <=> 2f => -1 2f < Float.nan => false Float.nan < 2f => false Float.nan <= Float.nan => false
Float cos()
Return the cosine of this angle in radians.
Float cosh()
Return the hyperbolic cosine.
@Operator
Float decrement()
Decrement by one. Shortcut is --a or a--.
const static Float : defVal
Default value is 0f.
@Operator
Float div(Float b)
Divide this by b. Shortcut is a/b.
@Operator
Decimal divDecimal(Decimal b)
Divide this by b. Shortcut is a/b.
@Operator
Float divInt(Int b)
Divide this by b. Shortcut is a/b.
const static Float : e
Float value for e which is the base of natural logarithms.
virtual Bool equals(Obj? obj)
Return true if same float value. Like Java, NaN != NaN. Also see compare.
Float exp()
Return e raised to this power.
Float floor()
Returns the largest whole number less than or equal to this number.
static new fromStr(Str s, Bool checked)
Parse a Str into a Float. Representations for infinity and not-a-number are "-INF", "INF", "NaN". This string format matches the lexical representation of Section 3.2.5 of XML Schema Part 2. If invalid format and checked is false return null, otherwise throw ParseErr.
virtual Int hash()
Return bits().
@Operator
Float increment()
Increment by one. Shortcut is ++a or a++.
Bool isNaN()
Return if this is Float.nan. Also see compare.
Bool isNegZero()
Return if this is negative zero value.
Float log()
Return natural logarithm of this number.
Float log10()
Return base 10 logarithm of this number.
static Float makeBits(Int bits)
Make a Float for the specified 64-bit representation according IEEE 754 floating-point double format bit layout. This method is paired with Float.bits.
static Float makeBits32(Int bits)
Make a Float for the specified 32-bit representation according IEEE 754 floating-point single format bit layout. This method is paired with Float.bits32.
Float max(Float that)
Return the larger of this and the specified Float values.
Float min(Float that)
Return the smaller of this and the specified Float values.
@Operator
Float minus(Float b)
Subtract b from this. Shortcut is a-b.
@Operator
Decimal minusDecimal(Decimal b)
Subtract b from this. Shortcut is a-b.
@Operator
Float minusInt(Int b)
Subtract b from this. Shortcut is a-b.
@Operator
Float mod(Float b)
Return remainder of this divided by b. Shortcut is a%b.
@Operator
Decimal modDecimal(Decimal b)
Return remainder of this divided by b. Shortcut is a%b.
@Operator
Float modInt(Int b)
Return remainder of this divided by b. Shortcut is a%b.
@Operator
Float mult(Float b)
Multiply this with b. Shortcut is a*b.
@Operator
Decimal multDecimal(Decimal b)
Multiply this with b. Shortcut is a*b.
@Operator
Float multInt(Int b)
Multiply this with b. Shortcut is a*b.
const static Float : nan
Float value for Not-A-Number.
const static Float : negInf
Float value for negative infinity.
@Operator
Float negate()
Negative of this. Shortcut is -a.
Float normNegZero()
If this value is negative zero then return normalized zero, otherwise return this value.
const static Float : pi
Float value for pi which is the ratio of the circumference of a circle to its diameter.
@Operator
Float plus(Float b)
Add this with b. Shortcut is a+b.
@Operator
Decimal plusDecimal(Decimal b)
Add this with b. Shortcut is a+b.
@Operator
Float plusInt(Int b)
Add this with b. Shortcut is a+b.
const static Float : posInf
Float value for positive infinity.
Float pow(Float pow)
Return this value raised to the specified power.
static Float random()
Generate a random float between 0.0 inclusive and 1.0 exclusive. Also see Int.random, Range.random, List.random, and Random.
Float round()
Returns the nearest whole number to this number.
Float sin()
Return sine of this angle in radians.
Float sinh()
Return hyperbolic sine.
Float sqrt()
Return square root of this value.
Float tan()
Return tangent of this angle in radians.
Float tanh()
Return hyperbolic tangent.
Str toCode()
Get this Float as a Fantom code literal.
Float toDegrees()
Convert this angle in radians to an angle in degrees.
Str toLocale(Str? pattern, Locale locale)
Format this floating point number for the current locale. If pattern is null, then the locale's default pattern is used. Also see Num.localeDecimal, Num.localeGrouping, etc.
The pattern format:
# optional digit 0 required digit . decimal point , grouping separator (only last one before decimal matters)
Examples:
12345.786f.toLocale("#,###.0") => 12,345.8
7.1234f.toLocale("#.000") => 7.123
0.1234f.toLocale("#.000") => .123
0.1234f.toLocale("0.00") => 0.12
70.12f.toLocale("0.0000") => 70.1200
Float toRadians()
Convert this angle in degrees to an angle in radians.
virtual Str toStr()
Get string representation according to the lexical representation defined by Section 3.2.5 of XML Schema Part 2. Representations for infinity and not-a-number are "-INF", "INF", "NaN".