Compare.AlmostEqualsUlps<T> Method

Returns whether the specified value is close to the reference value within the given tolerance expressed in ULPs (units in the last place).

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.1.0

public static bool AlmostEqualsUlps<T>(
	this T value1,
	T value2,
	T ulps,
	bool equalNaN = false,
	bool equalInfinity = true,
	bool symmetric = false
)
where T : Object, IComparable<T>

Visual Basic

<ExtensionAttribute>
Public Shared Function AlmostEqualsUlps(Of T As {Object, IComparable(Of T)}) ( 
	value1 As T,
	value2 As T,
	ulps As T,
	Optional equalNaN As Boolean = false,
	Optional equalInfinity As Boolean = true,
	Optional symmetric As Boolean = false
) As Boolean

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
where T : Object, IComparable<T>
static bool AlmostEqualsUlps(
	T value1, 
	T value2, 
	T ulps, 
	bool equalNaN = false, 
	bool equalInfinity = true, 
	bool symmetric = false
)

[<ExtensionAttribute>]
static member AlmostEqualsUlps : 
        value1 : 'T * 
        value2 : 'T * 
        ulps : 'T * 
        ?equalNaN : bool * 
        ?equalInfinity : bool * 
        ?symmetric : bool 
(* Defaults:
        let _equalNaN = defaultArg equalNaN false
        let _equalInfinity = defaultArg equalInfinity true
        let _symmetric = defaultArg symmetric false
*)
-> bool  when 'T : Object and IComparable<'T>

Parameters

value1 T: The value to compare.
value2 T: The reference value to compare against.
ulps T: Optional. The tolerance in ULPs (units in the last place).
equalNaN Boolean (Optional): Optional. Specifies whether NaN values are considered equal. The default is false.
equalInfinity Boolean (Optional): Optional. Specifies whether infinite values with the same sign are considered equal. The default is true.
symmetric Boolean (Optional): Optional. If false (the default), value2 is used as the reference value. If true, the value with the largest magnitude is used as the reference value.

Type Parameters

T: The type of the values to compare.

Return Value

Boolean
true if the values are close; otherwise, false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).