Class SequencesAssertions

Namespace

MathAssertions.TUnit

Assembly

MathAssertions.TUnit.dll

Fluent Sequences assertions over double arrays plus the generic length predicates over any T[]. Arrays are used at the adapter surface for the same ref-struct reason documented on ArrayAssertions; null arrays are rejected at entry.

public static class SequencesAssertions

Inheritance

object

SequencesAssertions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ConvergesTo(double[], double, double)

Asserts the last value of the sequence is within tolerance of the limit.

[GenerateAssertion(ExpectationMessage = "to converge to {limit} within tolerance {tolerance}", InlineMethodBody = false)]
public static bool ConvergesTo(this double[] value, double limit, double tolerance)

Parameters

value double[]

limit double

tolerance double

Returns

bool

HasLength<T>(T[], int)

Asserts the array has exactly expected elements.

[GenerateAssertion(ExpectationMessage = "to have length {expected}", InlineMethodBody = false)]
public static bool HasLength<T>(this T[] value, int expected)

Parameters

value T[]

expected int

Returns

bool

Type Parameters

T

HasMinLength<T>(T[], int)

Asserts the array has at least expected elements.

[GenerateAssertion(ExpectationMessage = "to have at least {expected} elements", InlineMethodBody = false)]
public static bool HasMinLength<T>(this T[] value, int expected)

Parameters

value T[]

expected int

Returns

bool

Type Parameters

T

IsArithmeticProgression(double[], double)

Asserts adjacent differences are equal within tolerance (arithmetic progression).

[GenerateAssertion(ExpectationMessage = "to be an arithmetic progression within tolerance {tolerance}", InlineMethodBody = false)]
public static bool IsArithmeticProgression(this double[] value, double tolerance)

Parameters

value double[]

tolerance double

Returns

bool

IsBounded(double[], double, double)

Asserts every value is in the closed interval [min, max].

[GenerateAssertion(ExpectationMessage = "to be bounded by [{min}, {max}]", InlineMethodBody = false)]
public static bool IsBounded(this double[] value, double min, double max)

Parameters

value double[]

min double

max double

Returns

bool

IsCauchyConvergent(double[], double)

Single-step Cauchy criterion: last two values within tolerance of each other.

[GenerateAssertion(ExpectationMessage = "to be Cauchy convergent within tolerance {tolerance}", InlineMethodBody = false)]
public static bool IsCauchyConvergent(this double[] value, double tolerance)

Parameters

value double[]

tolerance double

Returns

bool

IsGeometricProgression(double[], double)

Asserts adjacent ratios are equal within tolerance (geometric progression).

[GenerateAssertion(ExpectationMessage = "to be a geometric progression within tolerance {tolerance}", InlineMethodBody = false)]
public static bool IsGeometricProgression(this double[] value, double tolerance)

Parameters

value double[]

tolerance double

Returns

bool

IsMonotonicallyDecreasing(double[])

Asserts the sequence is non-increasing.

[GenerateAssertion(ExpectationMessage = "to be monotonically decreasing", InlineMethodBody = false)]
public static bool IsMonotonicallyDecreasing(this double[] value)

Parameters

value double[]

Returns

bool

IsMonotonicallyIncreasing(double[])

Asserts the sequence is non-decreasing.

[GenerateAssertion(ExpectationMessage = "to be monotonically increasing", InlineMethodBody = false)]
public static bool IsMonotonicallyIncreasing(this double[] value)

Parameters

value double[]

Returns

bool

IsSorted(double[])

Asserts the sequence is sorted (alias for IsMonotonicallyIncreasing(double[])).

[GenerateAssertion(ExpectationMessage = "to be sorted ascending", InlineMethodBody = false)]
public static bool IsSorted(this double[] value)

Parameters

value double[]

Returns

bool

IsStrictlyMonotonicallyDecreasing(double[])

Asserts the sequence is strictly decreasing.

[GenerateAssertion(ExpectationMessage = "to be strictly monotonically decreasing", InlineMethodBody = false)]
public static bool IsStrictlyMonotonicallyDecreasing(this double[] value)

Parameters

value double[]

Returns

bool

IsStrictlyMonotonicallyIncreasing(double[])

Asserts the sequence is strictly increasing (adjacent equal values fail).

[GenerateAssertion(ExpectationMessage = "to be strictly monotonically increasing", InlineMethodBody = false)]
public static bool IsStrictlyMonotonicallyIncreasing(this double[] value)

Parameters

value double[]

Returns

bool