Class FloatingPointComparer<T>

Namespace

Utils.Mathematics

Assembly

Utils.dll

Provides floating-point comparisons that allow for small deviations using a configurable interval. Implements only IComparer<T>: fuzzy equality cannot be used for hashing.

public class FloatingPointComparer<T> : IComparer<T> where T : struct, IFloatingPointIeee754<T>

Type Parameters

T

Inheritance

object

FloatingPointComparer<T>

Implements

IComparer<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DataUtils.ToDbValue(object?)

MathEx.Clamp<T>(T, T, T, IComparer<T>)

FluentExtensions.Failure<T>(T)

FluentExtensions.IsEqualTo<T, CT>(T, CT)

FluentExtensions.IsGreaterOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsGreaterThan<T, CT>(T, CT)

FluentExtensions.IsIn<T>(T, params T[])

FluentExtensions.IsLowerOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsLowerThan<T, CT>(T, CT)

FluentExtensions.IsNotIn<T>(T, params T[])

FluentExtensions.IsNotNull<T>(T)

FluentExtensions.IsNull<T>(T)

FluentExtensions.Success<T>(T)

FluentExtensions.Test<T>(T, Func<T, bool>)

ObjectUtils.Between<T>(T, IComparer<T>, T, T)

ObjectUtils.Between<T>(T, IComparer<T>, T, T, bool, bool)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Func<Task<Result>>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Result)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.In<T>(T, params T[])

ObjectUtils.NotIn<T>(T, params T[])

Validations.ArgMustBe<T>(T, Func<T, bool>, string, string)

Validations.ArgMustNotBe<T>(T, Func<T, bool>, string, string)

Validations.Arg<T>(T, string)

Validations.ValueMustNotBeNull<T>(T, string)

Validations.Variable<T>(T, string)

Remarks

This comparer is intentionally non-transitive: two values that are each within Interval of a middle value may not be within Interval of each other. Do not use with SortedSet<T>, SortedDictionary<TKey, TValue>, or any algorithm that requires a total strict order.

Constructors

FloatingPointComparer(int)

Initializes a new instance of the FloatingPointComparer<T> class using a decimal precision.

public FloatingPointComparer(int precision)

Parameters

precision int

The number of decimal places that must match.

FloatingPointComparer(T)

Initializes a new instance of the FloatingPointComparer<T> class with a custom interval.

public FloatingPointComparer(T interval)

Parameters

interval T

The maximum allowed difference between two values.

Properties

Interval

Gets the tolerance interval used to consider two numbers equal.

public T Interval { get; }

Property Value

T

Methods

Compare(T, T)

Compares two values, treating them as equal when their absolute difference is at most Interval.

public int Compare(T x, T y)

Parameters

x T

y T

Returns

int

0 when |x − y| ≤ Interval; otherwise the sign of x − y.

Remarks

Because this uses a tolerance zone, the ordering is not transitive: Compare(a, b) == 0 and Compare(b, c) == 0 do not imply Compare(a, c) == 0.

ForPrecision(int)

Returns a cached FloatingPointComparer<T> for the specified decimal precision. Repeated calls with the same precision return the same instance.

public static FloatingPointComparer<T> ForPrecision(int precision)

Parameters

precision int

The number of decimal places that must match.

Returns

FloatingPointComparer<T>