Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

java::lang::Double Class Reference

The Double class wraps a value of the primitive type double in an object. More...

#include <java_lang_Double.h>

Inheritance diagram for java::lang::Double:

Inheritance graph
[legend]
Collaboration diagram for java::lang::Double:

Collaboration graph
[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::Double
array1D
typedef ::xmog_java_array_template<
::xmog_java_array_template<
::java::lang::Double > > 
array2D

Public Member Functions

jbyte byteValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the value of this Double as a byte (by casting to a byte).
jint compareTo (const ::java::lang::Double &anotherDouble,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares two Double objects numerically.
jint compareTo (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares this Double object to another object.
 Double (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Constructs a newly allocated Double object that represents the floating-point value of type double represented by the string.
 Double (jdouble value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Constructs a newly allocated Double object that represents the primitive double argument.
jdouble doubleValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the double value of this Double 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.
jfloat floatValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the float value of this Double object.
jint hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a hash code for this Double object.
jint intValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the value of this Double as an int (by casting to type int).
bool isInfinite (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns true if this Double value is infinitely large in magnitude, false otherwise.
bool isNaN (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns true if this Double value is a Not-a-Number (NaN), false otherwise.
jlong longValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the value of this Double 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 Double 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 Double object.

Static Public Member Functions

static jint compare (jdouble d1, jdouble d2,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares the two specified double values.
static jlong doubleToLongBits (jdouble 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 "double format" bit layout.
static jlong doubleToRawLongBits (jdouble 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 "double format" bit layout, preserving Not-a-Number (NaN) values.
static bool isInfinite (jdouble 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 (jdouble 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 jdouble longBitsToDouble (jlong bits,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the double value corresponding to a given bit representation.
static jdouble parseDouble (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a new double initialized to the value represented by the specified String, as performed by the valueOf method of class Double.
::java::lang::String toString (jdouble d,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a string representation of the double argument.
::java::lang::Double valueOf (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a Double object holding the double value represented by the argument string s.

Static Public Attributes

static xmog_double MAX_VALUE
 A constant holding the largest positive finite value of type double, (2-2-52)21023.
static xmog_double MIN_VALUE
 A constant holding the smallest positive nonzero value of type double, 2-1074.
static xmog_double NaN
 A constant holding a Not-a-Number (NaN) value of type double.
static xmog_double NEGATIVE_INFINITY
 A constant holding the negative infinity of type double.
static xmog_double POSITIVE_INFINITY
 A constant holding the positive infinity of type double.
::java::lang::Class TYPE
 The Class instance representing the primitive type double.

Detailed Description

The Double class wraps a value of the primitive type double in an object.

An object of type Double contains a single field whose type is double.

In addition, this class provides several methods for converting a double to a String and a String to a double, as well as other constants and methods useful when dealing with a double.

Author:
Lee Boynton

Arthur van Hoff


Constructor & Destructor Documentation

java::lang::Double::Double jdouble  value,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Constructs a newly allocated Double object that represents the primitive double argument.

Parameters:
value the value to be represented by the Double.
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::Double::Double const ::java::lang::String s,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Constructs a newly allocated Double object that represents the floating-point value of type double represented by the string.

The string is converted to a double value as if by the valueOf method.

Parameters:
s a string to be converted to a Double.
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::Double::byteValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the value of this Double 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 double value represented by this object converted to type byte

Reimplemented from java::lang::Number.

static jint java::lang::Double::compare jdouble  d1,
jdouble  d2,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Compares the two specified double values.

The sign of the integer value returned is the same as that of the integer that would be returned by the call:

                    new Double(d1).compareTo(new Double(d2))

Parameters:
d1 the first double to compare
d2 the second double 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 d1 is numerically equal to d2; a value less than 0 if d1 is numerically less than d2; and a value greater than 0 if d1 is numerically greater than d2.

jint java::lang::Double::compareTo const ::java::lang::Double anotherDouble,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Compares two Double 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 double values:

  • Double.NaN is considered by this method to be equal to itself and greater than all other double values (including Double.POSITIVE_INFINITY).
  • 0.0d is considered by this method to be greater than -0.0d.
This ensures that Double.compareTo(Object) (which forwards its behavior to this method) obeys the general contract for Comparable.compareTo, and that the natural order on Doubles is consistent with equals.

Parameters:
anotherDouble the Double 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 anotherDouble is numerically equal to this Double; a value less than 0 if this Double is numerically less than anotherDouble; and a value greater than 0 if this Double is numerically greater than anotherDouble.

jint java::lang::Double::compareTo const ::java::lang::Object o,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Compares this Double object to another object.

If the object is a Double, this function behaves like compareTo(Double). Otherwise, it throws a ClassCastException (as Double objects are comparable only to other Double 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 Double numerically equal to this Double; a value less than 0 if the argument is a Double numerically greater than this Double; and a value greater than 0 if the argument is a Double numerically less than this Double.

Reimplemented from java::lang::Comparable.

static jlong java::lang::Double::doubleToLongBits jdouble  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 "double format" bit layout.

Bit 63 (the bit that is selected by the mask 0x8000000000000000L) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask 0x7ff0000000000000L) represent the exponent. Bits 51-0 (the bits that are selected by the mask 0x000fffffffffffffL) represent the significand (sometimes called the mantissa) of the floating-point number.

If the argument is positive infinity, the result is 0x7ff0000000000000L.

If the argument is negative infinity, the result is 0xfff0000000000000L.

If the argument is NaN, the result is 0x7ff8000000000000L.

In all cases, the result is a long integer that, when given to the method, will produce a floating-point value the same as the argument to doubleToLongBits (except all NaN values are collapsed to a single "canonical" NaN value).

Parameters:
value a double precision 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 jlong java::lang::Double::doubleToRawLongBits jdouble  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 "double format" bit layout, preserving Not-a-Number (NaN) values.

Bit 63 (the bit that is selected by the mask 0x8000000000000000L) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask 0x7ff0000000000000L) represent the exponent. Bits 51-0 (the bits that are selected by the mask 0x000fffffffffffffL) represent the significand (sometimes called the mantissa) of the floating-point number.

If the argument is positive infinity, the result is 0x7ff0000000000000L.

If the argument is negative infinity, the result is 0xfff0000000000000L.

If the argument is NaN, the result is the long integer representing the actual NaN value. Unlike the doubleToLongBits method, doubleToRawLongBits does not collapse all the bit patterns encoding a NaN to a single "canonical" NaN value.

In all cases, the result is a long integer that, when given to the method, will produce a floating-point value the same as the argument to doubleToRawLongBits.

Parameters:
value a double precision 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.

jdouble java::lang::Double::doubleValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the double value of this Double 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 double value represented by this object

Reimplemented from java::lang::Number.

bool java::lang::Double::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 Double object that represents a double that has the same value as the double represented by this object. For this purpose, two double values are considered to be the same if and only if the method returns the identical long value when applied to each.

Note that in most cases, for two instances of class Double, d1 and d2, the value of d1.equals(d2) is true if and only if <blockquote>

                   d1.doubleValue()&nbsp;== d2.doubleValue()

</blockquote>

also has the value true. However, there are two exceptions:

  • If d1 and d2 both represent Double.NaN, then the equals method returns true, even though Double.NaN==Double.NaN has the value false.
  • If d1 represents +0.0 while d2 represents -0.0, or vice versa, the equal test has the value false, even though +0.0==-0.0 has the value true.
This definition allows hash tables to operate properly.

Parameters:
obj the object to compare with.
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.

jfloat java::lang::Double::floatValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the float value of this Double 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 double value represented by this object converted to type float

Reimplemented from java::lang::Number.

jint java::lang::Double::hashCode ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns a hash code for this Double object.

The result is the exclusive OR of the two halves of the long integer bit representation, exactly as produced by the method , of the primitive double value represented by this Double object. That is, the hash code is the value of the expression: <blockquote>

                 (int)(v^(v&gt;&gt;&gt;32))

</blockquote> where v is defined by: <blockquote>

                 long v = Double.doubleToLongBits(this.doubleValue());

</blockquote>

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.

jint java::lang::Double::intValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the value of this Double 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 double value represented by this object converted to type int

Reimplemented from java::lang::Number.

static bool java::lang::Double::isInfinite jdouble  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 value of the argument is positive infinity or negative infinity; false otherwise.

bool java::lang::Double::isInfinite ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Returns true if this Double 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::Double::isNaN jdouble  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 value of the argument is NaN; false otherwise.

bool java::lang::Double::isNaN ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Returns true if this Double 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.

static jdouble java::lang::Double::longBitsToDouble jlong  bits,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns the double value 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 "double format" bit layout.

If the argument is 0x7ff0000000000000L, the result is positive infinity.

If the argument is 0xfff0000000000000L, the result is negative infinity.

If the argument is any value in the range 0x7ff0000000000001L through 0x7fffffffffffffffL or in the range 0xfff0000000000001L through 0xffffffffffffffffL, 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 Double.doubleToRawLongBits method.

In all other cases, let s, e, and m be three values that can be computed from the argument: <blockquote>

                 int s = ((bits &gt;&gt; 63) == 0) ? 1 : -1;
                 int e = (int)((bits &gt;&gt; 52) & 0x7ffL);
                 long m = (e == 0) ?
                                 (bits & 0xfffffffffffffL) &lt;&lt; 1 :
                                 (bits & 0xfffffffffffffL) | 0x10000000000000L;

</blockquote> Then the floating-point result equals the value of the mathematical expression sm2e-1075.

Note that this method may not be able to return a double NaN with exactly same bit pattern as the long 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 longBitsToDouble may not be able to return a double with a signaling NaN bit pattern. Consequently, for some long values, doubleToRawLongBits(longBitsToDouble(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 any long 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 double floating-point value with the same bit pattern.

jlong java::lang::Double::longValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the value of this Double 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 double value represented by this object converted to type long

Reimplemented from java::lang::Number.

static jdouble java::lang::Double::parseDouble const ::java::lang::String s,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

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

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 double value represented by the string argument.

jshort java::lang::Double::shortValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns the value of this Double 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 double value represented by this object converted to type short

Reimplemented from java::lang::Number.

::java::lang::String java::lang::Double::toString jdouble  d,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns a string representation of the double 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 '-' ('&#92;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 '.' ('&#92;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 107, then it is represented in so-called "computerized scientific notation." Let n be the unique integer such that 10n <= m < 10n+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 '.' ('&#92;u002E'), followed by decimal digits representing the fractional part of a, followed by the letter 'E' ('&#92;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 double. That is, suppose that x is the exact mathematical value represented by the decimal representation produced by this method for a finite nonzero argument d. Then d must be the double value nearest to x; or if two double values are equally close to x, then d must be one of them and the least significant bit of the significand of d must be 0.

To create localized string representations of a floating-point value, use subclasses of .

Parameters:
d the double 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::Double::toString ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Returns a string representation of this Double object.

The primitive double 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::Double java::lang::Double::valueOf const ::java::lang::String s,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns a Double object holding the double 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 rule: <blockquote>

FloatValue:
Signopt NaN Signopt Infinity Signopt 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 double by the usual round-to-nearest rule of IEEE 754 floating-point arithmetic, which includes preserving the sign of a zero value. Finally, a Double object representing this double 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. The two-step sequence of conversions, string to float followed by float to double, is not equivalent to converting a string directly to double. For example, the float literal 0.1f is equal to the double value 0.10000000149011612; the float literal 0.1f represents a different numerical value than the double literal 0.1. (The numerical value 0.1 cannot be exactly represented in a binary floating-point number.)

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 Double object holding the value represented by the String argument.


Member Data Documentation

xmog_double java::lang::Double::MAX_VALUE [static]
 

A constant holding the largest positive finite value of type double, (2-2-52)21023.

It is equal to the value returned by: Double.longBitsToDouble(0x7fefffffffffffffL).

xmog_double java::lang::Double::MIN_VALUE [static]
 

A constant holding the smallest positive nonzero value of type double, 2-1074.

It is equal to the value returned by Double.longBitsToDouble(0x1L).

xmog_double java::lang::Double::NaN [static]
 

A constant holding a Not-a-Number (NaN) value of type double.

It is equivalent to the value returned by Double.longBitsToDouble(0x7ff8000000000000L).

xmog_double java::lang::Double::NEGATIVE_INFINITY [static]
 

A constant holding the negative infinity of type double.

It is equal to the value returned by Double.longBitsToDouble(0xfff0000000000000L).

xmog_double java::lang::Double::POSITIVE_INFINITY [static]
 

A constant holding the positive infinity of type double.

It is equal to the value returned by Double.longBitsToDouble(0x7ff0000000000000L).


The documentation for this class was generated from the following file:
Generated on Fri Jun 16 10:19:24 2006 for JMS Courier for C++ by  doxygen 1.4.1