| java.lang.Object java.lang.Float
Float | final public class Float (Code) | | The Float class wraps a value of primitive type float in
an object. An object of type Float contains a single
field whose type is float .
In addition, this class provides several methods for converting a
float to a String and a
String to a float , as well as other
constants and methods useful when dealing with a
float .
version: 12/17/01 (CLDC 1.1) since: JDK1.0, CLDC 1.1 |
Field Summary | |
final public static float | MAX_VALUE The largest positive value of type float . | final public static float | MIN_VALUE The smallest positive value of type float . | final public static float | NEGATIVE_INFINITY The negative infinity of type float . | final public static float | NaN The Not-a-Number (NaN) value of type float . | final public static float | POSITIVE_INFINITY The positive infinity of type float . |
Constructor Summary | |
public | Float(float value) Constructs a newly allocated Float object that
represents the primitive float argument. | public | Float(double value) Constructs a newly allocated Float object that
represents the argument converted to type float . |
Method Summary | |
public byte | byteValue() Returns the value of this Float as a byte (by casting to a byte). | public double | doubleValue() Returns the double value of this Float object. | public boolean | equals(Object obj) Compares this object against some other object.
The result is true if and only if the argument is
not null and is a Float object that
represents a float that has the identical bit pattern
to the bit pattern of the float represented by this
object. | native public static int | floatToIntBits(float value) Returns the bit representation of a single-float value.
The result is a representation of the floating-point argument
according to the IEEE 754 floating-point "single
precision" bit layout.
- Bit 31 (the bit that is selected by the mask
0x80000000 ) represents the sign of the floating-point
number.
- Bits 30-23 (the bits that are selected by the mask
0x7f800000 ) represent the exponent.
- Bits 22-0 (the bits that are selected by the mask
0x007fffff ) represent the significand (sometimes called
the mantissa) of the floating-point number.
- If the argument is positive infinity, the result is
0x7f800000 .
- If the argument is negative infinity, the result is
0xff800000 .
- If the argument is NaN, the result is
0x7fc00000 .
In all cases, the result is an integer that, when given to the
Float.intBitsToFloat(int) method, will produce a floating-point
value equal to the argument to floatToIntBits .
Parameters: value - a floating-point number. | public float | floatValue() Returns the float value of this Float object. | public int | hashCode() Returns a hashcode for this Float object. | native public static float | intBitsToFloat(int bits) Returns the single-float corresponding to a given bit representation.
The argument is considered to be a representation of a
floating-point value according to the IEEE 754 floating-point
"single precision" bit layout.
If the argument is 0x7f800000 , the result is positive
infinity.
If the argument is 0xff800000 , the result is negative
infinity.
If the argument is any value in the range 0x7f800001
through 0x7fffffff or in the range
0xff800001 through 0xffffffff , the result is
NaN. | public int | intValue() Returns the integer value of this Float (by casting to an int). | public static boolean | isInfinite(float v) Returns true if the specified number is infinitely large in magnitude.
Parameters: v - the value to be tested. | public boolean | isInfinite() Returns true if this Float value is infinitely large in magnitude. | public static boolean | isNaN(float v) Returns true if the specified number is the special Not-a-Number (NaN)
value.
Parameters: v - the value to be tested. | public boolean | isNaN() Returns true if this Float value is Not-a-Number (NaN). | public long | longValue() Returns the long value of this Float (by casting to a long). | public static float | parseFloat(String s) Returns a new float initialized to the value represented by the
specified String .
Parameters: s - the string to be parsed. | public short | shortValue() Returns the value of this Float as a short (by casting to a short). | public static String | toString(float f) Returns a String representation for the specified float value.
The argument is converted to a readable string format as follows.
All characters and characters in strings mentioned below are ASCII
characters.
- If the argument is NaN, the result is the string "NaN".
- Otherwise, the result is a string that represents the sign and
magnitude (absolute value) of the argument.
| public String | toString() Returns a String representation of this Float object. | public static Float | valueOf(String s) Returns the floating point value represented by the specified String.
The string s is interpreted as the representation of a
floating-point value and a Float object representing that
value is created and returned.
If s is null , then a
NullPointerException is thrown.
Leading and trailing whitespace characters in s are ignored. |
MAX_VALUE | final public static float MAX_VALUE(Code) | | The largest positive value of type float . It is
equal to the value returned by
Float.intBitsToFloat(0x7f7fffff) .
|
MIN_VALUE | final public static float MIN_VALUE(Code) | | The smallest positive value of type float . It
is equal to the value returned by
Float.intBitsToFloat(0x1) .
|
NEGATIVE_INFINITY | final public static float NEGATIVE_INFINITY(Code) | | The negative infinity of type float . It is equal
to the value returned by
Float.intBitsToFloat(0xff800000) .
|
NaN | final public static float NaN(Code) | | The Not-a-Number (NaN) value of type float .
It is equal to the value returned by
Float.intBitsToFloat(0x7fc00000) .
|
POSITIVE_INFINITY | final public static float POSITIVE_INFINITY(Code) | | The positive infinity of type float . It is equal
to the value returned by
Float.intBitsToFloat(0x7f800000) .
|
Float | public Float(float value)(Code) | | Constructs a newly allocated Float object that
represents the primitive float argument.
Parameters: value - the value to be represented by the Float . |
Float | public Float(double value)(Code) | | Constructs a newly allocated Float object that
represents the argument converted to type float .
Parameters: value - the value to be represented by the Float . |
byteValue | public byte byteValue()(Code) | | Returns the value of this Float as a byte (by casting to a byte).
since: JDK1.1 |
doubleValue | public double doubleValue()(Code) | | Returns the double value of this Float object.
the float value represented by thisobject is converted to type double and theresult of the conversion is returned. |
equals | public boolean equals(Object obj)(Code) | | Compares this object against some other object.
The result is true if and only if the argument is
not null and is a Float object that
represents a float that has the identical bit pattern
to the bit pattern of the float represented by this
object. For this purpose, two float values are considered to be
the same if and only if the method
Float.floatToIntBits(float) returns the same int value when applied to each.
Note that in most cases, for two instances of class
Float , f1 and f2 , the value
of f1.equals(f2) is true if and only if
f1.floatValue() == f2.floatValue()
also has the value true . However, there are two exceptions:
- If
f1 and f2 both represent
Float.NaN , then the equals method returns
true , even though Float.NaN==Float.NaN
has the value false .
- If
f1 represents +0.0f while
f2 represents -0.0f , or vice versa,
the equal test has the value false ,
even though 0.0f==-0.0f has the value true .
This definition allows hashtables to operate properly.
Parameters: obj - the object to be compared true if the objects are the same;false otherwise. See Also: java.lang.Float.floatToIntBits(float) |
floatToIntBits | native public static int floatToIntBits(float value)(Code) | | Returns the bit representation of a single-float value.
The result is a representation of the floating-point argument
according to the IEEE 754 floating-point "single
precision" bit layout.
- Bit 31 (the bit that is selected by the mask
0x80000000 ) represents the sign of the floating-point
number.
- Bits 30-23 (the bits that are selected by the mask
0x7f800000 ) represent the exponent.
- Bits 22-0 (the bits that are selected by the mask
0x007fffff ) represent the significand (sometimes called
the mantissa) of the floating-point number.
- If the argument is positive infinity, the result is
0x7f800000 .
- If the argument is negative infinity, the result is
0xff800000 .
- If the argument is NaN, the result is
0x7fc00000 .
In all cases, the result is an integer that, when given to the
Float.intBitsToFloat(int) method, will produce a floating-point
value equal to the argument to floatToIntBits .
Parameters: value - a floating-point number. the bits that represent the floating-point number. |
floatValue | public float floatValue()(Code) | | Returns the float value of this Float object.
the float value represented by this object. |
hashCode | public int hashCode()(Code) | | Returns a hashcode for this Float object. The result
is the integer bit representation, exactly as produced
by the method
Float.floatToIntBits(float) , of the primitive float
value represented by this Float object.
a hash code value for this object. |
intBitsToFloat | native public static float intBitsToFloat(int bits)(Code) | | Returns the single-float corresponding to a given bit representation.
The argument is considered to be a representation of a
floating-point value according to the IEEE 754 floating-point
"single precision" bit layout.
If the argument is 0x7f800000 , the result is positive
infinity.
If the argument is 0xff800000 , the result is negative
infinity.
If the argument is any value in the range 0x7f800001
through 0x7fffffff or in the range
0xff800001 through 0xffffffff , the result is
NaN. All IEEE 754 NaN values of type float are, in effect,
lumped together by the Java programming language into a single
float value called NaN.
In all other cases, let s, e, and m be three
values that can be computed from the argument:
int s = ((bits >> 31) == 0) ? 1 : -1;
int e = ((bits >> 23) & 0xff);
int m = (e == 0) ?
(bits & 0x7fffff) << 1 :
(bits & 0x7fffff) | 0x800000;
Then the floating-point result equals the value of the mathematical
expression s·m·2e-150.
Parameters: bits - an integer. the single-format floating-point value with the same bitpattern. |
intValue | public int intValue()(Code) | | Returns the integer value of this Float (by casting to an int).
the float value represented by this objectconverted to type int and the result of theconversion is returned. |
isInfinite | public static boolean isInfinite(float v)(Code) | | Returns true if the specified number is infinitely large in magnitude.
Parameters: v - the value to be tested. true if the argument is positive infinity ornegative infinity; false otherwise. |
isInfinite | public boolean isInfinite()(Code) | | Returns true if this Float value is infinitely large in magnitude.
true if the value represented by this object ispositive infinity or negative infinity;false otherwise. |
isNaN | public static boolean isNaN(float v)(Code) | | Returns true if the specified number is the special Not-a-Number (NaN)
value.
Parameters: v - the value to be tested. true if the argument is NaN;false otherwise. |
isNaN | public boolean isNaN()(Code) | | Returns true if this Float value is Not-a-Number (NaN).
true if the value represented by this object isNaN; false otherwise. |
longValue | public long longValue()(Code) | | Returns the long value of this Float (by casting to a long).
the float value represented by this object isconverted to type long and the result of theconversion is returned. |
parseFloat | public static float parseFloat(String s) throws NumberFormatException(Code) | | Returns a new float initialized to the value represented by the
specified String .
Parameters: s - the string to be parsed. the float value represented by the string argument. exception: NumberFormatException - if the string does not contain aparsable float. since: JDK1.2 |
shortValue | public short shortValue()(Code) | | Returns the value of this Float as a short (by casting to a short).
since: JDK1.1 |
toString | public static String toString(float f)(Code) | | Returns a String representation for the specified float value.
The argument is converted to a readable string format as follows.
All characters and characters in strings mentioned below are ASCII
characters.
- If the argument is NaN, the result is the string "NaN".
- Otherwise, the result is a string that represents the sign and
magnitude (absolute value) of the argument. If the sign is
negative, the first character of the result is '-'
('\u002d'); if the sign is positive, no sign character
appears in the result. As for the magnitude m:
- If m is infinity, it is represented by the characters
"Infinity"; thus, positive infinity produces the result
"Infinity" and negative infinity produces the result
"-Infinity".
- If m is zero, it is represented by the characters
"0.0"; thus, negative zero produces the result
"-0.0" and positive zero produces the result
"0.0".
- If m is greater than or equal to 10-3 but
less than 107, then it is represented as the integer
part of m, in decimal form with no leading zeroes,
followed by '.' (\u002E), followed by one or
more decimal digits representing the fractional part of
m.
- If m is less than 10-3 or not less than
107, then it is represented in so-called "computerized
scientific notation." Let n be the unique integer
such that 10n<=m<1; then let
a be the mathematically exact quotient of m
and 10n so that 1<a<10. The magnitude
is then represented as the integer part of a, as a
single decimal digit, followed by '.' (\u002E),
followed by decimal digits representing the fractional part of
a, followed by the letter 'E'
(\u0045), followed by a representation of n
as a decimal integer, as produced by the method
java.lang.Integer.toString(int) of one argument.
How many digits must be printed for the fractional part of
m or a? There must be at least one digit to
represent the fractional part, and beyond that as many, but only as
many, more digits as are needed to uniquely distinguish the argument
value from adjacent values of type float. That is, suppose that
x is the exact mathematical value represented by the
decimal representation produced by this method for a finite nonzero
argument f. Then f must be the float value
nearest to x; or, if two float values are equally close to
xthen f must be one of them and the least
significant bit of the significand of f must be 0.
Parameters: f - the float to be converted. a string representation of the argument. |
toString | public String toString()(Code) | | Returns a String representation of this Float object.
The primitive float value represented by this object
is converted to a String exactly as if by the method
toString of one argument.
a String representation of this object. See Also: java.lang.Float.toString(float) |
valueOf | public static Float valueOf(String s) throws NumberFormatException(Code) | | Returns the floating point value represented by the specified String.
The string s is interpreted as the representation of a
floating-point value and a Float object representing that
value is created and returned.
If s is null , then a
NullPointerException is thrown.
Leading and trailing whitespace characters in s are ignored. The rest
of s should constitute a FloatValue as described
by the lexical syntax rules:
FloatValue:
Signopt FloatingPointLiteral
where Sign, FloatingPointLiteral are as defined in
Section 3.10.2 of the
Java Language
Specification. If it does not have the form of a FloatValue,
then a NumberFormatException is thrown. Otherwise, it is
regarded as representing an exact decimal value in the usual
"computerized scientific notation"; this exact decimal value is then
conceptually converted to an "infinitely precise" binary value that
is then rounded to type float by the usual round-to-nearest rule of
IEEE 754 floating-point arithmetic.
Parameters: s - the string to be parsed. a newly constructed Float initialized to thevalue represented by the String argument. exception: NumberFormatException - if the string does not contain aparsable number. |
|
|