java::lang::Float

java::lang::Float Class Reference

The Float class wraps a value of primitive type float in an object. More...

#include <java_lang_Float.h>

Inheritance diagram for java::lang::Float:

[legend]Collaboration diagram for java::lang::Float:

[legend]List of all members.


Public Types
enum	{ xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9, xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::Float >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::Float > >	array2D
Public Member Functions
jbyte	byteValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Float` as a `byte` (by casting to a `byte`).
jint	compareTo (const ::java::lang::Float &anotherFloat,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares two `Float` objects numerically.
jint	compareTo (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this `Float` object to another object.
jdouble	doubleValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `double` value of this `Float` object.
bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this object against the specified object.
	Float (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated `Float` object that represents the floating-point value of type `float` represented by the string.
	Float (jdouble value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated `Float` object that represents the argument converted to type `float`.
	Float (jfloat value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated `Float` object that represents the primitive `float` argument.
jfloat	floatValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `float` value of this `Float` object.
jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hash code for this `Float` object.
jint	intValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Float` as an `int` (by casting to type `int`).
bool	isInfinite (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns `true` if this `Float` value is infinitely large in magnitude, `false` otherwise.
bool	isNaN (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns `true` if this `Float` value is a Not-a-Number (NaN), `false` otherwise.
jlong	longValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns value of this `Float` as a `long` (by casting to type `long`).
jshort	shortValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Float` as a `short` (by casting to a `short`).
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string representation of this `Float` object.
Static Public Member Functions
static jint	compare (jfloat f1, jfloat f2,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares the two specified `float` values.
static jint	floatToIntBits (jfloat value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "single format" bit layout.
static jint	floatToRawIntBits (jfloat value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "single format" bit layout, preserving Not-a-Number (NaN) values.
static jfloat	intBitsToFloat (jint bits,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `float` value corresponding to a given bit represention.
static bool	isInfinite (jfloat v,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns `true` if the specified number is infinitely large in magnitude, `false` otherwise.
static bool	isNaN (jfloat v,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns `true` if the specified number is a Not-a-Number (NaN) value, `false` otherwise.
static jfloat	parseFloat (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a new `float` initialized to the value represented by the specified `String`, as performed by the `valueOf` method of class `Float`.
::java::lang::String	toString (jfloat f,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string representation of the `float` argument.
::java::lang::Float	valueOf (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Float` object holding the `float` value represented by the argument string `s`.
Static Public Attributes
static xmog_float	MAX_VALUE
	A constant holding the largest positive finite value of type `float`, (2-2^-23)2¹²⁷.
static xmog_float	MIN_VALUE
	A constant holding the smallest positive nonzero value of type `float`, 2^-149.
static xmog_float	NaN
	A constant holding a Not-a-Number (NaN) value of type `float`.
static xmog_float	NEGATIVE_INFINITY
	A constant holding the negative infinity of type `float`.
static xmog_float	POSITIVE_INFINITY
	A constant holding the positive infinity of type `float`.
::java::lang::Class	TYPE
	The `Class` instance representing the primitive type `float`.

Detailed Description

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.

Author:: Lee Boynton
Arthur van Hoff

Constructor & Destructor Documentation

java::lang::Float::Float ( jfloat value,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Constructs a newly allocated Float object that represents the primitive float argument.

Parameters:

value the value to be represented by the Float.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

java::lang::Float::Float ( jdouble value,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Constructs a newly allocated Float object that represents the argument converted to type float.

Parameters:

value the value to be represented by the Float.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

java::lang::Float::Float ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Constructs a newly allocated Float object that represents the floating-point value of type float represented by the string.
The string is converted to a float value as if by the valueOf method.

Parameters:

s a string to be converted to a Float.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Member Function Documentation

jbyte java::lang::Float::byteValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Float as a byte (by casting to a byte).

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object converted to type byte

Reimplemented from java::lang::Number.

static jint java::lang::Float::compare ( jfloat f1,

jfloat f2,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Compares the two specified float values.
The sign of the integer value returned is the same as that of the integer that would be returned by the call:

new Float(f1).compareTo(new Float(f2))

Parameters:

f1 the first float to compare.

f2 the second float to compare.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the value 0 if f1 is numerically equal to f2; a value less than 0 if f1 is numerically less than f2; and a value greater than 0 if f1 is numerically greater than f2.

jint java::lang::Float::compareTo ( const ::java::lang::Float & anotherFloat,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Compares two Float objects numerically.
There are two ways in which comparisons performed by this method differ from those performed by the Java language numerical comparison operators (<, <=, ==, >= >) when applied to primitive float values:

Float.NaN is considered by this method to be equal to itself and greater than all other float values (including Float.POSITIVE_INFINITY).

0.0f is considered by this method to be greater than -0.0f.

This ensures that Float.compareTo(Object) (which forwards its behavior to this method) obeys the general contract for Comparable.compareTo, and that the natural order on Floats is consistent with equals.

Parameters:

anotherFloat the Float to be compared.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the value 0 if anotherFloat is numerically equal to this Float; a value less than 0 if this Float is numerically less than anotherFloat; and a value greater than 0 if this Float is numerically greater than anotherFloat.

jint java::lang::Float::compareTo ( const ::java::lang::Object & o,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Compares this Float object to another object.
If the object is a Float, this function behaves like compareTo(Float). Otherwise, it throws a ClassCastException (as Float objects are comparable only to other Float objects).

Parameters:

o the Object to be compared.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the value 0 if the argument is a Float numerically equal to this Float; a value less than 0 if the argument is a Float numerically greater than this Float; and a value greater than 0 if the argument is a Float numerically less than this Float .

Reimplemented from java::lang::Comparable.

jdouble java::lang::Float::doubleValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the double value of this Float object.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object is converted to type double and the result of the conversion is returned.

Reimplemented from java::lang::Number.

bool java::lang::Float::equals ( const ::java::lang::Object & obj,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Compares this object against the specified object.
The result is true if and only if the argument is not null and is a Float object that represents a float with the same value as the float represented by this object. For this purpose, two float values are considered to be the same if and only if the method returns the identical 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 <blockquote>

f1.floatValue() == f2.floatValue()

</blockquote>
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 hash tables to operate properly.

Parameters:

obj the object to be compared

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if the objects are the same; false otherwise.

Reimplemented from java::lang::Object.

static jint java::lang::Float::floatToIntBits ( jfloat value,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "single format" 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 method, will produce a floating-point value the same as the argument to floatToIntBits (except all NaN values are collapsed to a single "canonical" NaN value).

Parameters:

value a floating-point number.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the bits that represent the floating-point number.

static jint java::lang::Float::floatToRawIntBits ( jfloat value,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "single format" bit layout, preserving Not-a-Number (NaN) values.
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 the integer representing the actual NaN value. Unlike the floatToIntBits method, intToRawIntBits does not collapse all the bit patterns encoding a NaN to a single "canonical" NaN value.
In all cases, the result is an integer that, when given to the method, will produce a floating-point value the same as the argument to floatToRawIntBits.

Parameters:

value a floating-point number.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the bits that represent the floating-point number.

jfloat java::lang::Float::floatValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the float value of this Float object.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object

Reimplemented from java::lang::Number.

jint java::lang::Float::hashCode ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns a hash code for this Float object.
The result is the integer bit representation, exactly as produced by the method , of the primitive float value represented by this Float object.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a hash code value for this object.

Reimplemented from java::lang::Object.

static jfloat java::lang::Float::intBitsToFloat ( jint bits,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns the float value corresponding to a given bit represention.
The argument is considered to be a representation of a floating-point value according to the IEEE 754 floating-point "single format" 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 a NaN. No IEEE 754 floating-point operation provided by Java can distinguish between two NaN values of the same type with different bit patterns. Distinct values of NaN are only distinguishable by use of the Float.floatToRawIntBits method.
In all other cases, let s, e, and m be three values that can be computed from the argument: <blockquote>

int s = ((bits >> 31) == 0) ? 1 : -1; int e = ((bits >> 23) & 0xff); int m = (e == 0) ? (bits & 0x7fffff) << 1 : (bits & 0x7fffff) | 0x800000;

</blockquote> Then the floating-point result equals the value of the mathematical expression sm2^e-150.
Note that this method may not be able to return a float NaN with exactly same bit pattern as the int argument. IEEE 754 distinguishes between two kinds of NaNs, quiet NaNs and signaling NaNs. The differences between the two kinds of NaN are generally not visible in Java. Arithmetic operations on signaling NaNs turn them into quiet NaNs with a different, but often similar, bit pattern. However, on some processors merely copying a signaling NaN also performs that conversion. In particular, copying a signaling NaN to return it to the calling method may perform this conversion. So intBitsToFloat may not be able to return a float with a signaling NaN bit pattern. Consequently, for some int values, floatToRawIntBits(intBitsToFloat(start)) may not equal start. Moreover, which particular bit patterns represent signaling NaNs is platform dependent; although all NaN bit patterns, quiet or signaling, must be in the NaN range identified above.

Parameters:

bits an integer.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float floating-point value with the same bit pattern.

jint java::lang::Float::intValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Float as an int (by casting to type int).

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object converted to type int

Reimplemented from java::lang::Number.

static bool java::lang::Float::isInfinite ( jfloat v,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns true if the specified number is infinitely large in magnitude, false otherwise.

Parameters:

v the value to be tested.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if the argument is positive infinity or negative infinity; false otherwise.

bool java::lang::Float::isInfinite ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns true if this Float value is infinitely large in magnitude, false otherwise.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if the value represented by this object is positive infinity or negative infinity; false otherwise.

static bool java::lang::Float::isNaN ( jfloat v,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

Parameters:

v the value to be tested.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if the argument is NaN; false otherwise.

bool java::lang::Float::isNaN ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns true if this Float value is a Not-a-Number (NaN), false otherwise.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if the value represented by this object is NaN; false otherwise.

jlong java::lang::Float::longValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns value of this Float as a long (by casting to type long).

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object converted to type long

Reimplemented from java::lang::Number.

static jfloat java::lang::Float::parseFloat ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a new float initialized to the value represented by the specified String, as performed by the valueOf method of class Float.

Parameters:

s the string to be parsed.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by the string argument.

jshort java::lang::Float::shortValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Float as a short (by casting to a short).

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the float value represented by this object converted to type short

Reimplemented from java::lang::Number.

::java::lang::String java::lang::Float::toString ( jfloat f,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a string representation of the float argument.
All characters 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 10⁷, 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 greater than or equal to 10⁷, then it is represented in so-called "computerized scientific notation." Let n be the unique integer such that 10ⁿ<= m < 10ⁿ⁺¹; then let a be the mathematically exact quotient of m and 10ⁿ 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 .

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 x, then f must be one of them and the least significant bit of the significand of f must be 0.
To create localized string representations of a floating-point value, use subclasses of .

Parameters:

f the float to be converted.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a string representation of the argument.

::java::lang::String java::lang::Float::toString ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

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.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a String representation of this object.

Reimplemented from java::lang::Object.

::java::lang::Float java::lang::Float::valueOf ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a Float object holding the float value represented by the argument string s.
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: <blockquote>

FloatValue:

Sign_opt NaN Sign_opt Infinity Sign_opt FloatingPointLiteral

</blockquote> where Sign and FloatingPointLiteral are as defined in 3.10.2 of the Java Language Specification. If s does not have the form of a FloatValue, then a NumberFormatException is thrown. Otherwise, s 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, which includes preserving the sign of a zero value. Finally, a Float object representing this float value is returned.
To interpret localized string representations of a floating-point value, use subclasses of .
Note that trailing format specifiers, specifiers that determine the type of a floating-point literal (1.0f is a float value; 1.0d is a double value), do not influence the results of this method. In other words, the numerical value of the input string is converted directly to the target floating-point type. In general, the two-step sequence of conversions, string to double followed by double to float, is not equivalent to converting a string directly to float. For example, if first converted to an intermediate double and then to float, the string
"1.00000017881393421514957253748434595763683319091796875001d"
results in the float value 1.0000002f; if the string is converted directly to float, 1.0000001f results.

Parameters:

s the string to be parsed.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a Float object holding the value represented by the String argument.

Member Data Documentation

xmog_float java::lang::Float::MAX_VALUE [static]

A constant holding the largest positive finite value of type float, (2-2^-23)2¹²⁷.
It is equal to the value returned by Float.intBitsToFloat(0x7f7fffff).

xmog_float java::lang::Float::MIN_VALUE [static]

A constant holding the smallest positive nonzero value of type float, 2^-149.
It is equal to the value returned by Float.intBitsToFloat(0x1).

xmog_float java::lang::Float::NaN [static]

A constant holding a Not-a-Number (NaN) value of type float.
It is equivalent to the value returned by Float.intBitsToFloat(0x7fc00000).

xmog_float java::lang::Float::NEGATIVE_INFINITY [static]

A constant holding the negative infinity of type float.
It is equal to the value returned by Float.intBitsToFloat(0xff800000).

xmog_float java::lang::Float::POSITIVE_INFINITY [static]

A constant holding the positive infinity of type float.
It is equal to the value returned by Float.intBitsToFloat(0x7f800000).

The documentation for this class was generated from the following file:

java_lang_Float.h

Generated on Fri Jun 16 10:19:25 2006 for JMS Courier for C++ by

1.4.1

java::lang::Float Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation