Vector<T>.Aggregate Method

Definition

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

Overload List

Aggregate(TypePreservingAggregatorGroup) Applies the specified aggregator to the vector.
Aggregate(TypePreservingAggregatorGroup, Boolean) Applies the specified aggregator to the vector.
Aggregate<TResult>(AggregatorGroup<TResult>) Applies the specified aggregator to the vector.
Aggregate<TResult>(Aggregator<T, TResult>, Nullable<Boolean>) Applies the specified aggregator to the vector.
Aggregate<TResult>(AggregatorGroup<TResult>, Boolean) Applies the specified aggregator to the vector.

Aggregate<TResult>(AggregatorGroup<TResult>)

Applies the specified aggregator to the vector.
C#
public TResult Aggregate<TResult>(
	AggregatorGroup<TResult> aggregator
)

Parameters

aggregator  AggregatorGroup<TResult>
An aggregator group.

Type Parameters

TResult
The type of the result of the aggregation.

Return Value

TResult

Aggregate(TypePreservingAggregatorGroup)

Applies the specified aggregator to the vector.
C#
public T Aggregate(
	TypePreservingAggregatorGroup aggregator
)

Parameters

aggregator  TypePreservingAggregatorGroup
An aggregator group.

Return Value

T
The result of the aggregation.

Aggregate<TResult>(Aggregator<T, TResult>, Nullable<Boolean>)

Applies the specified aggregator to the vector.
C#
public TResult Aggregate<TResult>(
	Aggregator<T, TResult> aggregator,
	bool? skipMissingValues = null
)

Parameters

aggregator  Aggregator<T, TResult>
An aggregator.
skipMissingValues  Nullable<Boolean>  (Optional)
Optional. Specifies whether missing values should be excluded from the aggregation. If null (the default), then the value is set to the vector's CheckForMissingValues attribute.

Type Parameters

TResult
The type of the result of the aggregation.

Return Value

TResult
The result of the aggregation.

Remarks

This overload ignores the value of the MayHaveMissingValues property.

Aggregate<TResult>(AggregatorGroup<TResult>, Boolean)

Applies the specified aggregator to the vector.
C#
public TResult Aggregate<TResult>(
	AggregatorGroup<TResult> aggregator,
	bool skipMissingValues
)

Parameters

aggregator  AggregatorGroup<TResult>
An aggregator group.
skipMissingValues  Boolean
Specifies whether missing values should be excluded from the aggregation. The default is false.

Type Parameters

TResult
The type of the result of the aggregation.

Return Value

TResult
The result of the aggregation.

Aggregate(TypePreservingAggregatorGroup, Boolean)

Applies the specified aggregator to the vector.
C#
public T Aggregate(
	TypePreservingAggregatorGroup aggregator,
	bool skipMissingValues
)

Parameters

aggregator  TypePreservingAggregatorGroup
An aggregator group.
skipMissingValues  Boolean
Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Return Value

T
The result of the aggregation.

See Also