Single.Equals Method (Object)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Returns a value indicating whether this instance is equal to a specified object.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Overrides Function Equals ( _
obj As Object _
) As Boolean
public override bool Equals(
Object obj
)
Parameters
- obj
Type: System.Object
An object to compare with this instance.
Return Value
Type: System.Boolean
true if obj is an instance of Single and equals the value of this instance; otherwise, false.
Remarks
The Equals method should be used with caution, because two apparently equivalent values can be unequal due to the differing precision of the two values. The following example reports that the Single value .3333 and the Single returned by dividing 1 by 3 are unequal.
' Initialize two singles with apparently identical values
Dim single1 As Single = 0.33333
Dim single2 As Object = 1 / 3
' Compare them for equality
outputBlock.Text &= single1.Equals(single2) & vbCrLf ' displays False
// Initialize two floats with apparently identical values
float float1 = .33333f;
object float2 = 1 / 3;
// Compare them for equality
outputBlock.Text += float1.Equals(float2) + "\n"; // displays false
Rather than comparing for equality, one recommended technique involves defining an acceptable margin of difference between two values (such as .01% of one of the values). 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 differences in precision and, therefore, the values are likely to be equal. The following example uses this technique to compare .33333 and 1/3, the two Single values that the previous code example found to be unequal.
' Initialize two singles with apparently identical values
Dim single1 As Single = 0.33333
Dim single2 As Object = 1 / 3
' Define the tolerance for variation in their values
Dim difference As Single = Math.Abs(single1 * 0.0001F)
' Compare the values
' The output indicates that the two values are equal
If Math.Abs(single1 - CSng(single2)) <= difference Then
outputBlock.Text &= "single1 and single2 are equal." & vbCrLf
Else
outputBlock.Text &= "single1 and single2 are unequal." & vbCrLf
End If
// Initialize two floats with apparently identical values
float float1 = .33333f;
object float2 = (float)1 / 3;
// Define the tolerance for variation in their values
float difference = Math.Abs(float1 * .0001f);
// Compare the values
// The output indicates that the two values are equal
if (Math.Abs(float1 - (float)float2) <= difference)
outputBlock.Text += "float1 and float2 are equal." + "\n";
else
outputBlock.Text += "float1 and float2 are unequal." + "\n";
In this case, the values are equal.
.gif "Note") Note: |
|---|
Because Epsilon defines the minimum expression of a positive value whose range is near zero, the margin of difference must be greater than Epsilon. Typically, it is many times greater than Epsilon. |
The precision of floating-point numbers beyond the documented precision is specific to the implementation and version of the .NET Framework. Consequently, a comparison of two particular numbers might change between versions of the .NET Framework because the precision of the numbers' internal representation might change.
Examples
The following code example demonstrates the Equals method.
Obj1 = CType(500, Single)
If A.Equals(Obj1) Then
outputBlock.Text &= "The value type and reference type values are equal." & vbCrLf
End If
obj1 = (Single)500;
if (a.Equals(obj1))
{
outputBlock.Text += "The value type and reference type values are equal." + "\n";
}
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.