Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
this < that => <0
this == that => 0
this > that => >0
This method may also be accessed via the < <= <=> >= and >
shortcut operators. If not overridden the default
implementation compares the toStr
representations. Also see docLang.
Examples:
3.compare(8) => -1
8.compare(3) => 1
8.compare(8) => 0
3 <=> 8 => -1 // shortcut for 3.compare(8)
Compare this object to the specified for equality. This
method may be accessed via the == and != shortcut operators.
If not overridden the default implementation compares for
reference equality using the === operator. If this method
is overridden, then hash() must also be overridden such that
any two objects which return true for equals() must return
the same value for hash(). This method must accept null and
return false.
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
Return a string representation of this object.
Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:
a->x a.trap("x", null)
a->x() a.trap("x", null)
a->x = b a.trap("x", [b])
a->x(b) a.trap("x", [b])
a->x(b, c) a.trap("x", [b, c])
The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.
This method called whenever an it-block is applied to an
object. The default implementation calls the function with this,
and then returns this.
StaticabsReturn the absolute value of this float. If this value is positive then return this, otherwise return the negation.
StaticacosReturn the arc cosine.
StaticapproxReturn 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
Optionaltolerance: numberStaticasinReturn the arc sine.
StaticatanReturn the arc tangent.
Staticatan2Converts rectangular coordinates (x, y) to polar (r, theta).
StaticbitsReturn 64-bit representation according IEEE 754 floating-point double format bit layout. This method is paired with Float.makeBits.
Staticbits32Return 32-bit representation according IEEE 754 floating-point single format bit layout. This method is paired with Float.makeBits32.
StaticceilReturns the smallest whole number greater than or equal to this number.
StaticclampClamp 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.
StaticcompareCompare based on floating point value.
NaN works as follows:
<=> operator NaN is always less than other values
and equal to itself (so sort works as expected)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
StaticcosReturn the cosine of this angle in radians.
StaticcoshReturn the hyperbolic cosine.
StaticdecrementDecrement by one. Shortcut is --a or a--.
StaticdefDefault value is 0f.
StaticdivDivide this by b. Shortcut is a/b.
StaticdivDivide this by b. Shortcut is a/b.
StaticdivDivide this by b. Shortcut is a/b.
StaticeFloat value for e which is the base of natural logarithms.
StaticechoWrite x.toStr to standard output followed by newline. If x
is null then print "null". If no argument is provided then
print an empty line.
Optionalx: JsObjStaticequalsStaticexpReturn e raised to this power.
StaticfloorReturns the largest whole number less than or equal to this number.
StaticfromParse 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.
Optionalchecked: booleanStatichashReturn bits().
StaticincrementIncrement by one. Shortcut is ++a or a++.
StaticisStaticisReturn if this is negative zero value.
StaticlocaleGet the current locale's decimal separator. For example in the the US this is a dot.
StaticlocaleGet the current locale's separator for grouping thousands together. For example in the US this is a comma.
StaticlocaleGet the current locale's minus sign used to represent a negative number.
StaticlocaleGet the current locale's string representation for not-a-number.
StaticlocaleGet the current locale's string representation for negative infinity.
StaticlocaleGet the current locale's symbol for the percent sign.
StaticlocaleGet the current locale's string representation for positive infinity.
StaticlogReturn natural logarithm of this number.
Staticlog10Return base 10 logarithm of this number.
StaticmakeMake a Float for the specified 64-bit representation according IEEE 754 floating-point double format bit layout. This method is paired with Float.bits.
StaticmakeMake a Float for the specified 32-bit representation according IEEE 754 floating-point single format bit layout. This method is paired with Float.bits32.
StaticmaxReturn the larger of this and the specified Float values.
StaticminReturn the smaller of this and the specified Float values.
StaticminusSubtract b from this. Shortcut is a-b.
StaticminusSubtract b from this. Shortcut is a-b.
StaticminusSubtract b from this. Shortcut is a-b.
StaticmodReturn remainder of this divided by b. Shortcut is a%b.
StaticmodReturn remainder of this divided by b. Shortcut is a%b.
StaticmodReturn remainder of this divided by b. Shortcut is a%b.
StaticmultMultiply this with b. Shortcut is a*b.
StaticmultMultiply this with b. Shortcut is a*b.
StaticmultMultiply this with b. Shortcut is a*b.
StaticnanFloat value for Not-A-Number.
StaticnegateNegative of this. Shortcut is -a.
StaticnegFloat value for negative infinity.
StaticnormIf this value is negative zero then return normalized zero, otherwise return this value.
StaticpiFloat value for pi which is the ratio of the circumference of a circle to its diameter.
StaticplusAdd this with b. Shortcut is a+b.
StaticplusAdd this with b. Shortcut is a+b.
StaticplusAdd this with b. Shortcut is a+b.
StaticposFloat value for positive infinity.
StaticpowReturn this value raised to the specified power.
StaticrandomGenerate a random float between 0.0 inclusive and 1.0 exclusive. Also see Int.random, Range.random, List.random, and util::Random.
StaticroundReturns the nearest whole number to this number.
StaticsinReturn sine of this angle in radians.
StaticsinhReturn hyperbolic sine.
StaticsqrtReturn square root of this value.
StatictanReturn tangent of this angle in radians.
StatictanhReturn hyperbolic tangent.
StatictoGet this Float as a Fantom code literal.
StatictoConvert this number to a Decimal.
StatictoConvert this angle in radians to an angle in degrees.
StatictoConvert this number to a Float.
StatictoConvert this number to an Int.
StatictoFormat 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
Optionalpattern: stringOptionallocale: LocaleStatictoConvert this angle in degrees to an angle in radians.
StatictoGet 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".
Float is used to represent a 64-bit floating point number.