Vector.CumulativeMaximumInto<T> Method

Returns the cumulative maximum of the elements of the vector.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0
C#
public static Vector<T> CumulativeMaximumInto<T>(
	this Vector<T> vector,
	Vector<T>? result
)

Parameters

vector  Vector<T>
A vector.
result  Vector<T>
The vector that is to hold the result. May be null.

Type Parameters

T

Return Value

Vector<T>
The cumulative maximum of the elements. The returned vector has the same length as vector. An empty vector returns an empty vector. Floating-point NaN values propagate from the first NaN onward. For missing-aware vectors, missing positions in the result are missing and missing values are skipped by the cumulative maximum state.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<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).

Remarks

Writing the result back to the source is supported when each vector position has its own storage location. Overlapping source and result storage is used directly only when later source values stay unchanged; otherwise the source values are copied first. Indexed results are not supported.

Exceptions

DimensionMismatchException

result does not have the same length as vector.

See Also