Numeric.AreEqual Method (Single, Single, Single)

NumericAreEqual Method (Single, Single, Single)

Determines whether two values are equal (regarding a specific tolerance).

Namespace: DigitalRune.Mathematics
Assembly: DigitalRune (in DigitalRune.dll) Version: 1.20.0.0 (1.20.1.14552)

Syntax

C++

Copy

public static bool AreEqual(
	float value1,
	float value2,
	float epsilon
)

Public Shared Function AreEqual ( 
	value1 As Single,
	value2 As Single,
	epsilon As Single
) As Boolean

public:
static bool AreEqual(
	float value1, 
	float value2, 
	float epsilon
)

static member AreEqual : 
        value1 : float32 * 
        value2 : float32 * 
        epsilon : float32 -> bool

Parameters

value1: Type: SystemSingle
The first value.
value2: Type: SystemSingle
The second value.
epsilon: Type: SystemSingle
The tolerance value.

Return Value

Type: Boolean
if the specified values are equal (within the tolerance); otherwise, .

Exceptions

Exception	Condition
ArgumentOutOfRangeException	epsilon is negative or 0.

Remarks

Important: When at least one of the parameters is a NaN the result is undefined. Such cases should be handled explicitly by the calling application.

Reference

Numeric Class

AreEqual Overload

DigitalRune.Mathematics Namespace