VectorSpacingEvaluator (FsODE)

FsODE

Documentation for 0.0.2

VectorSpacingEvaluator Type

Namespace: Altaxo.Calc.LinearAlgebra
Assembly: AltaxoCore.Redist.dll
Base Type: obj

Statistics of the spacing between adjacent vector elements. The spaces are defined in the forward direction, i.e. as vec[i+1]-vec[i].

Constructors

Constructor	Description
`VectorSpacingEvaluator(vec)` Full Usage: `VectorSpacingEvaluator(vec)` Parameters: vec : `IReadOnlyList<float>` - The vector.	Constructor. Takes an read only vector and evaluates the spaces between the vector elements. vec : `IReadOnlyList<float>` The vector.

Instance members

Instance member	Description
`this.HasInvalidSpaces` Full Usage: `this.HasInvalidSpaces` Returns: `bool`	True if there are invalid spaces, i.e. vector elements that are not numbers. Returns: `bool`
`this.HasValidSpaces` Full Usage: `this.HasValidSpaces` Returns: `bool`	Returns true if the vector has at least one valid space. This is fulfilled if there is one adjacent pair of vector elements, which are both valid numbers. Returns: `bool`
`this.IsMonotonicallyDecreasing` Full Usage: `this.IsMonotonicallyDecreasing` Returns: `bool`	True if all elements are mononton decreasing and there are no invalid spaces. Returns: `bool`
`this.IsMonotonicallyIncreasing` Full Usage: `this.IsMonotonicallyIncreasing` Returns: `bool`	True if all elements are mononton increasing and there are no invalid spaces. Returns: `bool`
`this.IsStrictlyEquallySpaced` Full Usage: `this.IsStrictlyEquallySpaced` Returns: `bool`	True if all elements are strictly equally spaced. Due to the limited accuracy of floating point arithmetic, this is in generally only fulfilled when having integer vector elements. Otherwise, please use VectorSpacingEvaluator.RelativeSpaceDeviation to calculate the space deviation. Returns: `bool`
`this.IsStrictlyMonotonicDecreasing` Full Usage: `this.IsStrictlyMonotonicDecreasing` Returns: `bool`	True if all elements are strongly mononton decreasing and there are no invalid spaces. Returns: `bool`
`this.IsStrictlyMonotonicIncreasing` Full Usage: `this.IsStrictlyMonotonicIncreasing` Returns: `bool`	True if all elements are strongly mononton increasing and there are no invalid spaces. Returns: `bool`
`this.RelativeSpaceDeviation` Full Usage: `this.RelativeSpaceDeviation` Returns: `float`	Calculates the relative deviation of spaces. The return value is a positive number, which indicates the relative space deviation. In case the deviation is undefined, the return value is PositiveInfinity. Returns: `float`
`this.SpaceMeanValue` Full Usage: `this.SpaceMeanValue` Returns: `float`	Returns the mean value of the valid spaces. Returns: `float`