Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Complex::Equals Method (Object^)

 

Returns a value that indicates whether the current instance and a specified object have the same value.

Namespace:   System.Numerics
Assembly:  System.Numerics (in System.Numerics.dll)

public:
virtual bool Equals(
	Object^ obj
) override

Parameters

obj
Type: System::Object^

The object to compare.

Return Value

Type: System::Boolean

true if the obj parameter is a Complex object or a type capable of implicit conversion to a Complex object, and its value is equal to the current Complex object; otherwise, false.

Two complex numbers are equal if their real parts are equal and their imaginary parts are equal. The Equals(Object^) method is equivalent to the following expression:

No code example is currently available or this language may not be supported.

If the obj parameter is not a Complex object, but it is a data type for which an implicit conversion is defined, the Equals(Object^) method converts obj to a Complex object whose real part is equal to the value of obj and whose imaginary part is equal to zero before it performs the comparison. The following example illustrates this by finding that a complex number and a double-precision floating-point value are equal.

No code example is currently available or this language may not be supported.

Notes to Callers:

Use the Equals method with caution, because two values that are apparently equivalent can be considered unequal due to the differing precision of their real and imaginary components. The problem can be accentuated if obj must be converted to a Double before performing the comparison. The following example compares a complex number whose real component appears to be equal to a Single value with that Single value. As the output shows, the comparison for equality returns False.

No code example is currently available or this language may not be supported.

One recommended technique is to define an acceptable margin of difference between the two values (such as .01% of one of the values' real and imaginary components) instead of comparing the values for equality. If the absolute value of the difference between the two values is less than or equal to that margin, the difference is likely to be due to a difference in precision and, therefore, the values are likely to be equal. The following example uses this technique to compare the two values that the previous code example found to be unequal. It now finds them to be equal.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2017 Microsoft