Float4D (TotalCrossSDK 6.1.0 API)

java.lang.Object
- java.lang.Number
- - totalcross.lang.Float4D

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Float4D>
```
public final class Float4D
extends java.lang.Number
implements java.lang.Comparable<Float4D>
```
The wrapper for the primitive type float.

Since:

1.0

See Also:

Number, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`MAX_VALUE` Constant for the maximum `float` value, (2 - 2^-23) * 2¹²⁷.
`static float`	`MIN_VALUE` Constant for the minimum `float` value, 2^-149.
`static float`	`NaN` Constant for the Not-a-Number (NaN) value of the `float` type.
`static float`	`NEGATIVE_INFINITY` Constant for the Negative Infinity value of the `float` type.
`static float`	`POSITIVE_INFINITY` Constant for the Positive Infinity value of the `float` type.
`static int`	`SIZE` Constant for the number of bits needed to represent a `float` in two's complement form.
`static java.lang.Class<java.lang.Float>`	`TYPE` The `Class` object that represents the primitive type `float`.

Constructor Summary

Constructors
Constructor and Description
`Float4D(double value)` Constructs a new `Float` with the specified primitive double value.
`Float4D(float value)` Constructs a new `Float` with the specified primitive float value.
`Float4D(java.lang.String string)` Constructs a new `Float` from the specified string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`byteValue()`
`static int`	`compare(float float1, float float2)` Compares the two specified float values.
`int`	`compareTo(Float4D object)` Compares this object to the specified float object to determine their relative order.
`double`	`doubleValue()`
`boolean`	`equals(java.lang.Object object)` Compares this instance with the specified object and indicates if they are equal.
`static int`	`floatToIntBits(float value)` Converts the specified float value to a binary representation conforming to the IEEE 754 floating-point single precision bit layout.
`static int`	`floatToRawIntBits(float value)` Converts the specified float value to a binary representation conforming to the IEEE 754 floating-point single precision bit layout.
`float`	`floatValue()` Gets the primitive value of this float.
`int`	`hashCode()`
`static float`	`intBitsToFloat(int bits)` Converts the specified IEEE 754 floating-point single precision bit pattern to a Java float value.
`int`	`intValue()`
`boolean`	`isInfinite()` Indicates whether this object represents an infinite value.
`static boolean`	`isInfinite(float f)` Indicates whether the specified float represents an infinite value.
`boolean`	`isNaN()` Indicates whether this object is a Not-a-Number (NaN) value.
`static boolean`	`isNaN(float f)` Indicates whether the specified float is a Not-a-Number (NaN) value.
`long`	`longValue()`
`static float`	`parseFloat(java.lang.String string)` Parses the specified string as a float value.
`short`	`shortValue()`
`static java.lang.String`	`toHexString(float f)` Converts the specified float into its hexadecimal string representation.
`java.lang.String`	`toString()`
`static java.lang.String`	`toString(float f)` Returns a string containing a concise, human-readable description of the specified float value.
`static java.lang.Float`	`valueOf(float f)` Returns a `Float` instance for the specified float value.
`static java.lang.Float`	`valueOf(java.lang.String string)` Parses the specified string as a float value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_VALUE
```
public static final float MAX_VALUE
```
    Constant for the maximum float value, (2 - 2^-23) * 2¹²⁷.
    
    See Also:
    
    Constant Field Values
  - MIN_VALUE
```
public static final float MIN_VALUE
```
    Constant for the minimum float value, 2^-149.
    
    See Also:
    
    Constant Field Values
  - NaN
```
public static final float NaN
```
    Constant for the Not-a-Number (NaN) value of the float type.
    
    See Also:
    
    Constant Field Values
  - POSITIVE_INFINITY
```
public static final float POSITIVE_INFINITY
```
    Constant for the Positive Infinity value of the float type.
    
    See Also:
    
    Constant Field Values
  - NEGATIVE_INFINITY
```
public static final float NEGATIVE_INFINITY
```
    Constant for the Negative Infinity value of the float type.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.Class<java.lang.Float> TYPE
```
    The Class object that represents the primitive type float.
    
    Since:
    
    1.1
  - SIZE
```
public static final int SIZE
```
    Constant for the number of bits needed to represent a float in two's complement form.
    
    Since:
    
    1.5
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Float4D
```
public Float4D(float value)
```
    Constructs a new Float with the specified primitive float value.
    
    Parameters:
    
    value - the primitive float value to store in the new instance.
  - Float4D
```
public Float4D(double value)
```
    Constructs a new Float with the specified primitive double value.
    
    Parameters:
    
    value - the primitive double value to store in the new instance.
  - Float4D
```
public Float4D(java.lang.String string)
        throws java.lang.NumberFormatException
```
    Constructs a new Float from the specified string.
    
    Parameters:
    
    string - the string representation of a float value.
    
    Throws:
    
    java.lang.NumberFormatException - if string can not be decoded into a float value.
    
    See Also:
    
    parseFloat(String)
- Method Detail
  - compareTo
```
public int compareTo(Float4D object)
```
    Compares this object to the specified float object to determine their relative order. There are two special cases:
    - Float.NaN is equal to Float.NaN and it is greater than any other float value, including Float.POSITIVE_INFINITY;
    - +0.0f is greater than -0.0f
    Specified by:
    
    compareTo in interface java.lang.Comparable<Float4D>
    
    Parameters:
    
    object - the float object to compare this object to.
    
    Returns:
    
    a negative value if the value of this float is less than the value of object; 0 if the value of this float and the value of object are equal; a positive value if the value of this float is greater than the value of object.
    
    Since:
    
    1.2
    
    See Also:
    
    Comparable
  - byteValue
```
public byte byteValue()
```
    Overrides:
    
    byteValue in class java.lang.Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares this instance with the specified object and indicates if they are equal. In order to be equal, object must be an instance of Float and have the same float value as this object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the object to compare this float with.
    
    Returns:
    
    true if the specified object is equal to this Float; false otherwise.
  - floatToIntBits
```
public static int floatToIntBits(float value)
```
    Converts the specified float value to a binary representation conforming to the IEEE 754 floating-point single precision bit layout. All Not-a-Number (NaN) values are converted to a single NaN representation (0x7ff8000000000000L).
    
    Parameters:
    
    value - the float value to convert.
    
    Returns:
    
    the IEEE 754 floating-point single precision representation of value.
    
    See Also:
    
    floatToRawIntBits(float), intBitsToFloat(int)
  - floatToRawIntBits
```
public static int floatToRawIntBits(float value)
```
    Converts the specified float value to a binary representation conforming to the IEEE 754 floating-point single precision bit layout. Not-a-Number (NaN) values are preserved.
    
    Parameters:
    
    value - the float value to convert.
    
    Returns:
    
    the IEEE 754 floating-point single precision representation of value.
    
    See Also:
    
    floatToIntBits(float), intBitsToFloat(int)
  - floatValue
```
public float floatValue()
```
    Gets the primitive value of this float.
    
    Specified by:
    
    floatValue in class java.lang.Number
    
    Returns:
    
    this object's primitive value.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - intBitsToFloat
```
public static float intBitsToFloat(int bits)
```
    Converts the specified IEEE 754 floating-point single precision bit pattern to a Java float value.
    
    Parameters:
    
    bits - the IEEE 754 floating-point single precision representation of a float value.
    
    Returns:
    
    the float value converted from bits.
    
    See Also:
    
    floatToIntBits(float), floatToRawIntBits(float)
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - isInfinite
```
public boolean isInfinite()
```
    Indicates whether this object represents an infinite value.
    
    Returns:
    
    true if the value of this float is positive or negative infinity; false otherwise.
  - isInfinite
```
public static boolean isInfinite(float f)
```
    Indicates whether the specified float represents an infinite value.
    
    Parameters:
    
    f - the float to check.
    
    Returns:
    
    true if the value of f is positive or negative infinity; false otherwise.
  - isNaN
```
public boolean isNaN()
```
    Indicates whether this object is a Not-a-Number (NaN) value.
    
    Returns:
    
    true if this float is Not-a-Number; false if it is a (potentially infinite) float number.
  - isNaN
```
public static boolean isNaN(float f)
```
    Indicates whether the specified float is a Not-a-Number (NaN) value.
    
    Parameters:
    
    f - the float value to check.
    
    Returns:
    
    true if f is Not-a-Number; false if it is a (potentially infinite) float number.
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - parseFloat
```
public static float parseFloat(java.lang.String string)
                        throws java.lang.NumberFormatException
```
    Parses the specified string as a float value.
    
    Parameters:
    
    string - the string representation of a float value.
    
    Returns:
    
    the primitive float value represented by string.
    
    Throws:
    
    java.lang.NumberFormatException - if string is null, has a length of zero or can not be parsed as a float value.
    
    Since:
    
    1.2
    
    See Also:
    
    valueOf(String)
  - shortValue
```
public short shortValue()
```
    Overrides:
    
    shortValue in class java.lang.Number
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public static java.lang.String toString(float f)
```
    Returns a string containing a concise, human-readable description of the specified float value.
    
    Parameters:
    
    f - the float to convert to a string.
    
    Returns:
    
    a printable representation of f.
  - valueOf
```
public static java.lang.Float valueOf(java.lang.String string)
                               throws java.lang.NumberFormatException
```
    Parses the specified string as a float value.
    
    Parameters:
    
    string - the string representation of a float value.
    
    Returns:
    
    a Float instance containing the float value represented by string.
    
    Throws:
    
    java.lang.NumberFormatException - if string is null, has a length of zero or can not be parsed as a float value.
    
    See Also:
    
    parseFloat(String)
  - compare
```
public static int compare(float float1,
                          float float2)
```
    Compares the two specified float values. There are two special cases:
    - Float.NaN is equal to Float.NaN and it is greater than any other float value, including Float.POSITIVE_INFINITY;
    - +0.0f is greater than -0.0f
    Parameters:
    
    float1 - the first value to compare.
    
    float2 - the second value to compare.
    
    Returns:
    
    a negative value if float1 is less than float2; 0 if float1 and float2 are equal; a positive value if float1 is greater than float2.
    
    Since:
    
    1.4
  - valueOf
```
public static java.lang.Float valueOf(float f)
```
    Returns a Float instance for the specified float value.
    
    Parameters:
    
    f - the float value to store in the instance.
    
    Returns:
    
    a Float instance containing f.
    
    Since:
    
    1.5
  - toHexString
```
public static java.lang.String toHexString(float f)
```
    Converts the specified float into its hexadecimal string representation.
    
    Parameters:
    
    f - the float to convert.
    
    Returns:
    
    the hexadecimal string representation of f.
    
    Since:
    
    1.5

Class Float4D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_VALUE

MIN_VALUE

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

TYPE

SIZE

Constructor Detail

Float4D

Float4D

Float4D

Method Detail

compareTo

byteValue

doubleValue

equals

floatToIntBits

floatToRawIntBits

floatValue

hashCode

intBitsToFloat

intValue

isInfinite

isInfinite

isNaN

isNaN

longValue

parseFloat

shortValue

toString

toString

valueOf

compare

valueOf

toHexString