Aggregator<T, TResult>.Aggregate Method

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.0

Overload List

Aggregate(Vector<T>)	Aggregates the elements of a vector and returns the result.
Aggregate(IEnumerable<T>, Boolean)	Aggregates the elements of a sequence and returns the result.
Aggregate(ReadOnlySpan<T>, Boolean)	Aggregates the elements of a vector and returns the result.
Aggregate(Vector<T>, Boolean)	Aggregates the elements of a vector and returns the result.
Aggregate(ReadOnlySpan<T>, ReadOnlySpan<Boolean>, Boolean)	Aggregates over a span and returns the result.
Aggregate(Int32, ReadOnlySpan<T>, Int32, Boolean)	Aggregates the elements of a vector and returns the result.
Aggregate(Vector<T>, Int32, Int32, Nullable<Boolean>)	Aggregates the specified range of elements of a vector and returns the result.
Aggregate(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, Boolean)	Aggregates over a span and returns the result.

Aggregate(Vector<T>)

Aggregates the elements of a vector and returns the result.

public TResult Aggregate(
	Vector<T> values
)

Visual Basic

Public Function Aggregate ( 
	values As Vector(Of T)
) As TResult

C++/CLI

public:
TResult Aggregate(
	Vector<T>^ values
)

member Aggregate : 
        values : Vector<'T> -> 'TResult

Parameters

values Vector<T>: A vector of values.

Return Value

TResult
The result of the aggregation.

Remarks

Whether missing values are excluded from the aggregation is inferred from the vector's CheckForMissingValues attribute.

Exceptions

ArgumentNullException

values is null.

Aggregate(IEnumerable<T>, Boolean)

Aggregates the elements of a sequence and returns the result.

public TResult Aggregate(
	IEnumerable<T> values,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	values As IEnumerable(Of T),
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	IEnumerable<T>^ values, 
	bool skipMissingValues = false
)

member Aggregate : 
        values : IEnumerable<'T> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

values IEnumerable<T>: A sequence of values.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult

Exceptions

ArgumentNullException

values is null.

Aggregate(ReadOnlySpan<T>, Boolean)

Aggregates the elements of a vector and returns the result.

public TResult Aggregate(
	ReadOnlySpan<T> values,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	values As ReadOnlySpan(Of T),
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	ReadOnlySpan<T> values, 
	bool skipMissingValues = false
)

member Aggregate : 
        values : ReadOnlySpan<'T> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

values ReadOnlySpan<T>: A vector of values.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult
The result of the aggregation.

Aggregate(Vector<T>, Boolean)

Aggregates the elements of a vector and returns the result.

public TResult Aggregate(
	Vector<T> values,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	values As Vector(Of T),
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	Vector<T>^ values, 
	bool skipMissingValues = false
)

member Aggregate : 
        values : Vector<'T> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

values Vector<T>: A vector of values.
skipMissingValues Boolean (Optional): Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult
The result of the aggregation.

Exceptions

ArgumentNullException

values is null.

Aggregate(ReadOnlySpan<T>, ReadOnlySpan<Boolean>, Boolean)

Aggregates over a span and returns the result.

public TResult Aggregate(
	ReadOnlySpan<T> values,
	ReadOnlySpan<bool> mask,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	values As ReadOnlySpan(Of T),
	mask As ReadOnlySpan(Of Boolean),
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	ReadOnlySpan<T> values, 
	ReadOnlySpan<bool> mask, 
	bool skipMissingValues = false
)

member Aggregate : 
        values : ReadOnlySpan<'T> * 
        mask : ReadOnlySpan<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

values ReadOnlySpan<T>: A read-only span of values.
mask ReadOnlySpan<Boolean>: A read-only span of booleans.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult
The result of the aggregation.

Aggregate(Int32, ReadOnlySpan<T>, Int32, Boolean)

Aggregates the elements of a vector and returns the result.

public TResult Aggregate(
	int length,
	ReadOnlySpan<T> values,
	int stride,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	length As Integer,
	values As ReadOnlySpan(Of T),
	stride As Integer,
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	int length, 
	ReadOnlySpan<T> values, 
	int stride, 
	bool skipMissingValues = false
)

member Aggregate : 
        length : int * 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

length Int32: The number of elements to aggregate.
values ReadOnlySpan<T>: A read-only span of values.
stride Int32: The distance between successive elements in values.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult
The result of the aggregation.

Aggregate(Vector<T>, Int32, Int32, Nullable<Boolean>)

Aggregates the specified range of elements of a vector and returns the result.

public TResult Aggregate(
	Vector<T> values,
	int startIndex,
	int endIndex,
	bool? skipMissingValues = null
)

Visual Basic

Public Function Aggregate ( 
	values As Vector(Of T),
	startIndex As Integer,
	endIndex As Integer,
	Optional skipMissingValues As Boolean? = Nothing
) As TResult

C++/CLI

public:
TResult Aggregate(
	Vector<T>^ values, 
	int startIndex, 
	int endIndex, 
	Nullable<bool> skipMissingValues = nullptr
)

member Aggregate : 
        values : Vector<'T> * 
        startIndex : int * 
        endIndex : int * 
        ?skipMissingValues : Nullable<bool> 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues null
*)
-> 'TResult

Parameters

values Vector<T>: A vector of values.
startIndex Int32: The zero-based index of the first element in values that should be aggregated.
endIndex Int32: The zero-based index of the last element in values that should be aggregated.
skipMissingValues Nullable<Boolean> (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. If null (the default), then the value is inferred from values.

Return Value

TResult
The result of the aggregation.

Exceptions

ArgumentNullException

values is null.

Aggregate(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, Boolean)

Aggregates over a span and returns the result.

public TResult Aggregate(
	int length,
	ReadOnlySpan<T> values,
	int stride,
	ReadOnlySpan<bool> mask,
	int maskStride,
	bool skipMissingValues = false
)

Visual Basic

Public Function Aggregate ( 
	length As Integer,
	values As ReadOnlySpan(Of T),
	stride As Integer,
	mask As ReadOnlySpan(Of Boolean),
	maskStride As Integer,
	Optional skipMissingValues As Boolean = false
) As TResult

C++/CLI

public:
TResult Aggregate(
	int length, 
	ReadOnlySpan<T> values, 
	int stride, 
	ReadOnlySpan<bool> mask, 
	int maskStride, 
	bool skipMissingValues = false
)

member Aggregate : 
        length : int * 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        mask : ReadOnlySpan<bool> * 
        maskStride : int * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'TResult

Parameters

length Int32: The number of elements to aggregate.
values ReadOnlySpan<T>: A read-only span of values.
stride Int32: The distance between successive elements in values.
mask ReadOnlySpan<Boolean>: A read-only span of booleans.
maskStride Int32: The distance between successive elements in mask.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

TResult
The result of the aggregation.

Aggregator<T, TResult>.Aggregate Method

Definition

Overload List

Aggregate(Vector<T>)

Parameters

Return Value

Remarks

Exceptions

Aggregate(IEnumerable<T>, Boolean)

Parameters

Return Value

Exceptions

Aggregate(ReadOnlySpan<T>, Boolean)

Parameters

Return Value

Aggregate(Vector<T>, Boolean)

Parameters

Return Value

Exceptions

Aggregate(ReadOnlySpan<T>, ReadOnlySpan<Boolean>, Boolean)

Parameters

Return Value

Aggregate(Int32, ReadOnlySpan<T>, Int32, Boolean)

Parameters

Return Value

Aggregate(Vector<T>, Int32, Int32, Nullable<Boolean>)

Parameters

Return Value

Exceptions

Aggregate(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, Boolean)

Parameters

Return Value

See Also

Reference