Grouping<TKey>.AggregateInto Method

Definition

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

Overload List

AggregateInto<T, TResult>(Aggregator<T, TResult>, ReadOnlySpan<T>, Span<TResult>)	Aggregates values over each group and writes the results into a span.
AggregateInto<T, TResult>(Vector<T>, Aggregator<T, TResult>, Vector<TResult>)	Aggregates the specified vector over each group and returns the result.
AggregateInto<T1, T2, TResult>(Vector<T1>, Vector<T2>, BinaryAggregator<T1, T2, TResult>, Vector<TResult>)	Aggregates the specified vector over each group and returns the result.
AggregateInto<T, TResult, TPredicate>(Aggregator<T, TResult>, ReadOnlySpanSlice<T>, TPredicate, Boolean, SpanSlice<TResult>)	Aggregates the specified vector over each group and returns the result.
AggregateInto<T, TResult, TPredicate>(Vector<T>, Aggregator<T, TResult>, TPredicate, Nullable<Boolean>, Vector<TResult>)	Aggregates the specified vector over each group and returns the result.

AggregateInto<T, TResult>(Aggregator<T, TResult>, ReadOnlySpan<T>, Span<TResult>)

Aggregates values over each group and writes the results into a span.

public void AggregateInto<T, TResult>(
	Aggregator<T, TResult> aggregator,
	ReadOnlySpan<T> values,
	Span<TResult> result
)

Visual Basic

Public Sub AggregateInto(Of T, TResult) ( 
	aggregator As Aggregator(Of T, TResult),
	values As ReadOnlySpan(Of T),
	result As Span(Of TResult)
)

C++/CLI

public:
generic<typename T, typename TResult>
virtual void AggregateInto(
	Aggregator<T, TResult>^ aggregator, 
	ReadOnlySpan<T> values, 
	Span<TResult> result
) sealed

abstract AggregateInto : 
        aggregator : Aggregator<'T, 'TResult> * 
        values : ReadOnlySpan<'T> * 
        result : Span<'TResult> -> unit 
override AggregateInto : 
        aggregator : Aggregator<'T, 'TResult> * 
        values : ReadOnlySpan<'T> * 
        result : Span<'TResult> -> unit

Parameters

aggregator Aggregator<T, TResult>: The aggregator to apply to each group.
values ReadOnlySpan<T>: A contiguous read-only span of values to aggregate.
result Span<TResult>: A span that will receive one aggregated value per group.

Type Parameters

T: The element type of the input values.
TResult: The type of the result of the aggregation.

Implements

IGrouping.AggregateInto<T, TResult>(Aggregator<T, TResult>, ReadOnlySpan<T>, Span<TResult>)

AggregateInto<T, TResult>(Vector<T>, Aggregator<T, TResult>, Vector<TResult>)

Aggregates the specified vector over each group and returns the result.

public Vector<TResult> AggregateInto<T, TResult>(
	Vector<T> values,
	Aggregator<T, TResult> aggregator,
	Vector<TResult>? result
)

Visual Basic

Public Function AggregateInto(Of T, TResult) ( 
	values As Vector(Of T),
	aggregator As Aggregator(Of T, TResult),
	result As Vector(Of TResult)
) As Vector(Of TResult)

C++/CLI

public:
generic<typename T, typename TResult>
virtual Vector<TResult>^ AggregateInto(
	Vector<T>^ values, 
	Aggregator<T, TResult>^ aggregator, 
	Vector<TResult>^ result
) sealed

abstract AggregateInto : 
        values : Vector<'T> * 
        aggregator : Aggregator<'T, 'TResult> * 
        result : Vector<'TResult> -> Vector<'TResult> 
override AggregateInto : 
        values : Vector<'T> * 
        aggregator : Aggregator<'T, 'TResult> * 
        result : Vector<'TResult> -> Vector<'TResult>

Parameters

values Vector<T>: A vector.
aggregator Aggregator<T, TResult>: The aggregator to apply to each group.
result Vector<TResult>: The vector that is to hold the result of the aggregation. May be null.

Type Parameters

T: The element type of the input vector.
TResult: The type of the result of the aggregation.

Return Value

Vector<TResult>

Implements

IGrouping.AggregateInto<T, TResult>(Vector<T>, Aggregator<T, TResult>, Vector<TResult>)

Exceptions

ArgumentNullException

values is null.

-or-

aggregator is null.

DimensionMismatchException

The length of result is less than the number of groups.

AggregateInto<T1, T2, TResult>(Vector<T1>, Vector<T2>, BinaryAggregator<T1, T2, TResult>, Vector<TResult>)

Aggregates the specified vector over each group and returns the result.

public virtual Vector<TResult> AggregateInto<T1, T2, TResult>(
	Vector<T1> values1,
	Vector<T2> values2,
	BinaryAggregator<T1, T2, TResult> aggregator,
	Vector<TResult>? result
)

Visual Basic

Public Overridable Function AggregateInto(Of T1, T2, TResult) ( 
	values1 As Vector(Of T1),
	values2 As Vector(Of T2),
	aggregator As BinaryAggregator(Of T1, T2, TResult),
	result As Vector(Of TResult)
) As Vector(Of TResult)

C++/CLI

public:
generic<typename T1, typename T2, typename TResult>
virtual Vector<TResult>^ AggregateInto(
	Vector<T1>^ values1, 
	Vector<T2>^ values2, 
	BinaryAggregator<T1, T2, TResult>^ aggregator, 
	Vector<TResult>^ result
)

abstract AggregateInto : 
        values1 : Vector<'T1> * 
        values2 : Vector<'T2> * 
        aggregator : BinaryAggregator<'T1, 'T2, 'TResult> * 
        result : Vector<'TResult> -> Vector<'TResult> 
override AggregateInto : 
        values1 : Vector<'T1> * 
        values2 : Vector<'T2> * 
        aggregator : BinaryAggregator<'T1, 'T2, 'TResult> * 
        result : Vector<'TResult> -> Vector<'TResult>

Parameters

values1 Vector<T1>: A vector of values.
values2 Vector<T2>: A vector of values.
aggregator BinaryAggregator<T1, T2, TResult>: The aggregator to apply to each group.
result Vector<TResult>: The vector that is to hold the result of the aggregation. May be null.

Type Parameters

T1: The element type of the input vector.
T2: The element type of the second vector.
TResult: The type of the result of the aggregation.

Return Value

Vector<TResult>

Implements

IGrouping.AggregateInto<T1, T2, TResult>(Vector<T1>, Vector<T2>, BinaryAggregator<T1, T2, TResult>, Vector<TResult>)

Exceptions

ArgumentNullException

values1 is null.

-or-

values2 is null.

-or-

aggregator is null.

DimensionMismatchException

The length of result is less than the number of groups.

AggregateInto<T, TResult, TPredicate>(Aggregator<T, TResult>, ReadOnlySpanSlice<T>, TPredicate, Boolean, SpanSlice<TResult>)

Aggregates the specified vector over each group and returns the result.

public virtual void AggregateInto<T, TResult, TPredicate>(
	Aggregator<T, TResult> aggregator,
	ReadOnlySpanSlice<T> values,
	TPredicate predicate,
	bool skipMissingValues,
	SpanSlice<TResult> result
)
where TPredicate : struct, new(), IFastFunc<T, bool>

Visual Basic

Public Overridable Sub AggregateInto(Of T, TResult, TPredicate As {Structure, New, IFastFunc(Of T, Boolean)}) ( 
	aggregator As Aggregator(Of T, TResult),
	values As ReadOnlySpanSlice(Of T),
	predicate As TPredicate,
	skipMissingValues As Boolean,
	result As SpanSlice(Of TResult)
)

C++/CLI

public:
generic<typename T, typename TResult, typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T, bool>
virtual void AggregateInto(
	Aggregator<T, TResult>^ aggregator, 
	ReadOnlySpanSlice<T> values, 
	TPredicate predicate, 
	bool skipMissingValues, 
	SpanSlice<TResult> result
)

abstract AggregateInto : 
        aggregator : Aggregator<'T, 'TResult> * 
        values : ReadOnlySpanSlice<'T> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : SpanSlice<'TResult> -> unit  when 'TPredicate : struct, new() and IFastFunc<'T, bool>
override AggregateInto : 
        aggregator : Aggregator<'T, 'TResult> * 
        values : ReadOnlySpanSlice<'T> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : SpanSlice<'TResult> -> unit  when 'TPredicate : struct, new() and IFastFunc<'T, bool>

Parameters

aggregator Aggregator<T, TResult>: The aggregator to apply to each group.
values ReadOnlySpanSlice<T>: A span slice that contains the values to aggregate.
predicate TPredicate: A predicate that filters the values that are to be included in the aggregation.
skipMissingValues Boolean: Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.
result SpanSlice<TResult>: The vector that is to hold the result.

Type Parameters

T: The element type of the input vector.
TResult: The type of the result of the aggregation.
TPredicate

Implements

IGrouping.AggregateInto<T, TResult, TPredicate>(Aggregator<T, TResult>, ReadOnlySpanSlice<T>, TPredicate, Boolean, SpanSlice<TResult>)

AggregateInto<T, TResult, TPredicate>(Vector<T>, Aggregator<T, TResult>, TPredicate, Nullable<Boolean>, Vector<TResult>)

Aggregates the specified vector over each group and returns the result.

public virtual Vector<TResult> AggregateInto<T, TResult, TPredicate>(
	Vector<T> values,
	Aggregator<T, TResult> aggregator,
	TPredicate predicate,
	bool? skipMissingValues,
	Vector<TResult>? result
)
where TPredicate : struct, new(), IFastFunc<T, bool>

Visual Basic

Public Overridable Function AggregateInto(Of T, TResult, TPredicate As {Structure, New, IFastFunc(Of T, Boolean)}) ( 
	values As Vector(Of T),
	aggregator As Aggregator(Of T, TResult),
	predicate As TPredicate,
	skipMissingValues As Boolean?,
	result As Vector(Of TResult)
) As Vector(Of TResult)

C++/CLI

public:
generic<typename T, typename TResult, typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T, bool>
virtual Vector<TResult>^ AggregateInto(
	Vector<T>^ values, 
	Aggregator<T, TResult>^ aggregator, 
	TPredicate predicate, 
	Nullable<bool> skipMissingValues, 
	Vector<TResult>^ result
)

abstract AggregateInto : 
        values : Vector<'T> * 
        aggregator : Aggregator<'T, 'TResult> * 
        predicate : 'TPredicate * 
        skipMissingValues : Nullable<bool> * 
        result : Vector<'TResult> -> Vector<'TResult>  when 'TPredicate : struct, new() and IFastFunc<'T, bool>
override AggregateInto : 
        values : Vector<'T> * 
        aggregator : Aggregator<'T, 'TResult> * 
        predicate : 'TPredicate * 
        skipMissingValues : Nullable<bool> * 
        result : Vector<'TResult> -> Vector<'TResult>  when 'TPredicate : struct, new() and IFastFunc<'T, bool>

Parameters

values Vector<T>: A vector.
aggregator Aggregator<T, TResult>: The aggregator to apply to each group.
predicate TPredicate: A predicate that filters the values that are to be included in the aggregation.
skipMissingValues Nullable<Boolean>: Specifies whether missing values should be excluded from the aggregation. If null, then the value is inferred from values.
result Vector<TResult>: The vector that is to hold the result of the aggregation. May be null.

Type Parameters

T: The element type of the input vector.
TResult: The type of the result of the aggregation.
TPredicate: The type of predicate.

Return Value

Vector<TResult>

Implements

IGrouping.AggregateInto<T, TResult, TPredicate>(Vector<T>, Aggregator<T, TResult>, TPredicate, Nullable<Boolean>, Vector<TResult>)

Exceptions

ArgumentNullException

values is null.

-or-

aggregator is null.

DimensionMismatchException

The length of result is less than the number of groups.

Grouping<TKey>.AggregateInto Method

Definition

Overload List

AggregateInto<T, TResult>(Aggregator<T, TResult>, ReadOnlySpan<T>, Span<TResult>)

Parameters

Type Parameters

Implements

AggregateInto<T, TResult>(Vector<T>, Aggregator<T, TResult>, Vector<TResult>)

Parameters

Type Parameters

Return Value

Implements

Exceptions

AggregateInto<T1, T2, TResult>(Vector<T1>, Vector<T2>, BinaryAggregator<T1, T2, TResult>, Vector<TResult>)

Parameters

Type Parameters

Return Value

Implements

Exceptions

AggregateInto<T, TResult, TPredicate>(Aggregator<T, TResult>, ReadOnlySpanSlice<T>, TPredicate, Boolean, SpanSlice<TResult>)

Parameters

Type Parameters

Implements

AggregateInto<T, TResult, TPredicate>(Vector<T>, Aggregator<T, TResult>, TPredicate, Nullable<Boolean>, Vector<TResult>)

Parameters

Type Parameters

Return Value

Implements

Exceptions

See Also

Reference