2 out of 5 rated this helpful - Rate this topic

Double Structure

Represents a double-precision floating-point number.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
public struct Double : IComparable, IFormattable, 
	IConvertible, IComparable<double>, IEquatable<double>

The Double type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library CompareTo(Double) Compares this instance to a specified double-precision floating-point number and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified double-precision floating-point number.
Public method Supported by the XNA Framework CompareTo(Object) Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Double) Returns a value indicating whether this instance and a specified Double object represent the same value.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Returns a value indicating whether this instance is equal to a specified object. (Overrides ValueType.Equals(Object).)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Overrides ValueType.GetHashCode().)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Supported by the XNA Framework GetTypeCode Returns the TypeCode for value type Double.
Public method Static member Supported by the XNA Framework Supported by Portable Class Library IsInfinity Returns a value indicating whether the specified number evaluates to negative or positive infinity
Public method Static member Supported by the XNA Framework Supported by Portable Class Library IsNaN Returns a value indicating whether the specified number evaluates to a value that is not a number (NaN).
Public method Static member Supported by the XNA Framework Supported by Portable Class Library IsNegativeInfinity Returns a value indicating whether the specified number evaluates to negative infinity.
Public method Static member Supported by the XNA Framework Supported by Portable Class Library IsPositiveInfinity Returns a value indicating whether the specified number evaluates to positive infinity.
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Static member Supported by the XNA Framework Parse(String) Converts the string representation of a number to its double-precision floating-point number equivalent.
Public method Static member Supported by the XNA Framework Parse(String, NumberStyles) Converts the string representation of a number in a specified style to its double-precision floating-point number equivalent.
Public method Static member Supported by the XNA Framework Supported by Portable Class Library Parse(String, IFormatProvider) Converts the string representation of a number in a specified culture-specific format to its double-precision floating-point number equivalent.
Public method Static member Supported by the XNA Framework Supported by Portable Class Library Parse(String, NumberStyles, IFormatProvider) Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString() Converts the numeric value of this instance to its equivalent string representation. (Overrides ValueType.ToString().)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString(IFormatProvider) Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
Public method Supported by the XNA Framework ToString(String) Converts the numeric value of this instance to its equivalent string representation, using the specified format.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString(String, IFormatProvider) Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.
Public method Static member TryParse(String, Double) Converts the string representation of a number to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.
Public method Static member Supported by Portable Class Library TryParse(String, NumberStyles, IFormatProvider, Double) Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.
Top
  Name Description
Public operator Static member Equality Returns a value that indicates whether two specified Double values are equal.
Public operator Static member GreaterThan Returns a value that indicates whether a specified Double value is greater than another specified Double value.
Public operator Static member GreaterThanOrEqual Returns a value that indicates whether a specified Double value is greater than or equal to another specified Double value.
Public operator Static member Inequality Returns a value that indicates whether two specified Double values are not equal.
Public operator Static member LessThan Returns a value that indicates whether a specified Double value is less than another specified Double value.
Public operator Static member LessThanOrEqual Returns a value that indicates whether a specified Double value is less than or equal to another specified Double value.
Top
  Name Description
Public field Static member Supported by the XNA Framework Supported by Portable Class Library Epsilon Represents the smallest positive Double value that is greater than zero. This field is constant.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library MaxValue Represents the largest possible value of a Double. This field is constant.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library MinValue Represents the smallest possible value of a Double. This field is constant.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library NaN Represents a value that is not a number (NaN). This field is constant.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library NegativeInfinity Represents negative infinity. This field is constant.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library PositiveInfinity Represents positive infinity. This field is constant.
Top
  Name Description
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToBoolean Infrastructure. For a description of this member, see IConvertible.ToBoolean.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToByte Infrastructure. For a description of this member, see IConvertible.ToByte.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToChar Infrastructure. This conversion is not supported. Attempting to use this method throws an InvalidCastException.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToDateTime Infrastructure. This conversion is not supported. Attempting to use this method throws an InvalidCastException
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToDecimal Infrastructure. For a description of this member, see IConvertible.ToDecimal.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToDouble Infrastructure. For a description of this member, see IConvertible.ToDouble.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToInt16 Infrastructure. For a description of this member, see IConvertible.ToInt16.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToInt32 Infrastructure. For a description of this member, see IConvertible.ToInt32.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToInt64 Infrastructure. For a description of this member, see IConvertible.ToInt64.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToSByte Infrastructure. For a description of this member, see IConvertible.ToSByte.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToSingle Infrastructure. For a description of this member, see IConvertible.ToSingle.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToType Infrastructure. For a description of this member, see IConvertible.ToType.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToUInt16 Infrastructure. For a description of this member, see IConvertible.ToUInt16.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToUInt32 Infrastructure. For a description of this member, see IConvertible.ToUInt32.
Explicit interface implemetation Private method Supported by the XNA Framework IConvertible.ToUInt64 Infrastructure. For a description of this member, see IConvertible.ToUInt64.
Top

The Double value type represents a double-precision 64-bit number with values ranging from negative 1.79769313486232e308 to positive 1.79769313486232e308, as well as positive or negative zero, PositiveInfinity, NegativeInfinity, and Not-a-Number (NaN).

Double complies with the IEC 60559:1989 (IEEE 754) standard for binary floating-point arithmetic.

Double provides methods to compare instances of this type, convert the value of an instance to its string representation, and convert the string representation of a number to an instance of this type. For information about how format specification codes control the string representation of value types, see Formatting Types, Standard Numeric Format Strings, and Custom Numeric Format Strings.

Using Floating-Point Numbers

When performing binary operations, if one of the operands is a Double, then the other operand is required to be an integral type or a floating-point type (Double or Single). Prior to performing the operation, if the other operand is not a Double, it is converted to Double, and the operation is performed using at least Double range and precision. If the operation produces a numeric result, the type of the result is Double.

The floating-point operators, including the assignment operators, do not throw exceptions. Instead, in exceptional situations the result of a floating-point operation is zero, infinity, or NaN, as described below:

  • If the result of a floating-point operation is too small for the destination format, the result of the operation is zero.

  • If the magnitude of the result of a floating-point operation is too large for the destination format, the result of the operation is PositiveInfinity or NegativeInfinity, as appropriate for the sign of the result.

  • If a floating-point operation is invalid, the result of the operation is NaN.

  • If one or both operands of a floating-point operation are NaN, the result of the operation is NaN.

Floating-Point Values and Loss of Precision

Remember that a floating-point number can only approximate a decimal number, and that the precision of a floating-point number determines how accurately that number approximates a decimal number. By default, a Double value contains 15 decimal digits of precision, although a maximum of 17 digits is maintained internally. The precision of a floating-point number has several consequences:

  • Two floating-point numbers that appear equal for a particular precision might not compare equal because their least significant digits are different.

  • A mathematical or comparison operation that uses a floating-point number might not yield the same result if a decimal number is used because the floating-point number might not exactly approximate the decimal number.

  • A value might not roundtrip if a floating-point number is involved. A value is said to roundtrip if an operation converts an original floating-point number to another form, an inverse operation transforms the converted form back to a floating-point number, and the final floating-point number is equal to the original floating-point number. The roundtrip might fail because one or more least significant digits are lost or changed in a conversion.

In addition, the result of arithmetic and assignment operations with Double values may differ slightly by platform because of the loss of precision of the Double type. For example, the result of assigning a literal Double value may differ in the 32-bit and 64-bit versions of the .NET Framework. The following example illustrates this difference when the literal value -4.42330604244772E-305 and a variable whose value is -4.42330604244772E-305 are assigned to a Double variable. Note that the result of the Parse(String) method in this case does not suffer from a loss of precision.


double value = -4.42330604244772E-305;

double fromLiteral = -4.42330604244772E-305;
double fromVariable = value;
double fromParse = Double.Parse("-4.42330604244772E-305");

Console.WriteLine("Double value from literal: {0,29:R}", fromLiteral);
Console.WriteLine("Double value from variable: {0,28:R}", fromVariable);
Console.WriteLine("Double value from Parse method: {0,24:R}", fromParse);      
// On 32-bit versions of the .NET Framework, the output is:
//    Double value from literal:        -4.42330604244772E-305
//    Double value from variable:       -4.42330604244772E-305
//    Double value from Parse method:   -4.42330604244772E-305
//
// On other versions of the .NET Framework, the output is:
//    Double value from literal:      -4.4233060424477198E-305
//    Double value from variable:     -4.4233060424477198E-305
//    Double value from Parse method:   -4.42330604244772E-305      


The following code example illustrates the use of Double:


	// The Temperature class stores the temperature as a Double
	// and delegates most of the functionality to the Double
	// implementation.
	public class Temperature : IComparable, IFormattable 
    {
		// IComparable.CompareTo implementation.
		public int CompareTo(object obj) {
            if (obj == null) return 1;

			Temperature temp = obj as Temperature;
            if (obj != null) 
				return m_value.CompareTo(temp.m_value);
			else
     			throw new ArgumentException("object is not a Temperature");	
		}

		// IFormattable.ToString implementation.
		public string ToString(string format, IFormatProvider provider) {
			if( format != null ) {
				if( format.Equals("F") ) {
					return String.Format("{0}'F", this.Value.ToString());
				}
				if( format.Equals("C") ) {
					return String.Format("{0}'C", this.Celsius.ToString());
				}
			}

			return m_value.ToString(format, provider);
		}

		// Parses the temperature from a string in the form
		// [ws][sign]digits['F|'C][ws]
		public static Temperature Parse(string s, NumberStyles styles, IFormatProvider provider) {
			Temperature temp = new Temperature();

			if( s.TrimEnd(null).EndsWith("'F") ) {
				temp.Value = Double.Parse( s.Remove(s.LastIndexOf('\''), 2), styles, provider);
			}
			else if( s.TrimEnd(null).EndsWith("'C") ) {
				temp.Celsius = Double.Parse( s.Remove(s.LastIndexOf('\''), 2), styles, provider);
			}
			else {
				temp.Value = Double.Parse(s, styles, provider);
			}

			return temp;
		}

		// The value holder
		protected double m_value;

		public double Value {
			get {
				return m_value;
			}
			set {
				m_value = value;
			}
		}

		public double Celsius {
			get {
				return (m_value-32.0)/1.8;
			}
			set {
				m_value = 1.8*value+32.0;
			}
		}
	}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

All members of this type are thread safe. Members that appear to modify instance state actually return a new instance initialized with the new value. As with any other type, reading and writing to a shared variable that contains an instance of this type must be protected by a lock to guarantee thread safety.

Caution note Caution

Assigning an instance of this type is not thread safe on all hardware platforms because the binary representation of that instance might be too large to assign in a single atomic operation.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Examples of Currency Value Types With a Decimal Point
using System;
using System.Globalization;
using System.Runtime;
using System.Runtime.Serialization;
using System.Security;


// currency value types:
namespace Currency
{
    [Serializable]
    public struct CAD : IComparable, IFormattable, IConvertible, ISerializable, IComparable<CAD>, IEquatable<CAD>
    {
        /* constructors... */
       /* properties */
        public long WholeNumbers
        {
            get;
        }
        public long DigitsAfterDecimal
        {
            get;
        }
        // other properties and fields...
        /* operators */
        public static CAD operator +(CAD cad1, CAD cad2);
        public static CAD operator +(CAD cad, USD usd);
        public static CAD operator +(CAD cad, decimal m);
        public static CAD operator +(CAD cad, double d);
        public static CAD operator +(CAD cad, float f);
        public static CAD operator +(CAD cad, object o);
        // other operators...
        /* other methods... */
    }
   [Serializable]
    public struct USD : IComparable, IFormattable, IConvertible, ISerializable, IComparable<USD>, IEquatable<USD>
    {
        /* constructors... */
        /* properties */
        public long WholeNumbers
        {
            get;
        }
        public long DigitsAfterDecimal
        {
            get;
        }
        // other properties and fields...
       /* operators... */
       /* other methods... */
    }
    /* other structs of currency value types... */
}