This documentation is archived and is not being maintained.

BigInteger::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 BigInteger object or a type capable of implicit conversion to a BigInteger value, and its value is equal to the value of the current BigInteger object; otherwise, false.

If the obj parameter is not a BigInteger value, but it is a data type for which an implicit conversion is defined, the Equals(Object) method converts obj to a BigInteger value before it performs the comparison. If obj is not a BigInteger value and cannot be implicitly converted to BigInteger, the method returns false. If no conversion from obj to a BigInteger value exists, the method does not throw an exception; instead, it returns false.

To determine the relationship between the two objects instead of just testing for equality, call the CompareTo(Object) method.

The following example compares the approximate distance of several stars from Earth with the distance of Epsilon Indi from Earth to determine whether they are equal. The example uses each overload of the Equals method to test for equality.

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

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.
Show: