AccumulatingAggregator<T, TResult, TAccumulator> Class

Represents an aggregator that uses an accumulator.

Definition

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

public class AccumulatingAggregator<T, TResult, TAccumulator> : Aggregator<T, TResult>
where TAccumulator : struct, new(), IAccumulator<T>

Visual Basic

Public Class AccumulatingAggregator(Of T, TResult, TAccumulator As {Structure, New, IAccumulator(Of T)})
	Inherits Aggregator(Of T, TResult)

C++/CLI

generic<typename T, typename TResult, typename TAccumulator>
where TAccumulator : value class, gcnew(), IAccumulator<T>
public ref class AccumulatingAggregator : public Aggregator<T, TResult>

type AccumulatingAggregator<'T, 'TResult, 'TAccumulator when 'TAccumulator : struct, new() and IAccumulator<'T>> = 
    class
        inherit Aggregator<'T, 'TResult>
    end

Inheritance: Object → Aggregator<T, TResult> → AccumulatingAggregator<T, TResult, TAccumulator>

Type Parameters

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

Remarks

The constructor accepts a function that applies a transformation to the result of the accumulator.

Constructors

AccumulatingAggregator<T, TResult, TAccumulator>

Constructs a new aggregator.

Properties

EmptyGroupsHaveValue	Gets whether the aggregator produces a value for empty groups. (Inherited from Aggregator<T, TResult>)
EmptyValue	Gets the result of the aggregation when the input is empty. (Inherited from Aggregator<T, TResult>)
IsIncremental	Gets whether the aggregator operates on individual elements or on the input as a whole. (Inherited from Aggregator<T, TResult>)
MissingValuesAffectResult	Gets whether the result of the outcome is different if missing values are present in the input but the other values are the same. (Inherited from Aggregator<T, TResult>)
OrderingAffectsResult	Gets whether the result of the outcome is different if elements are in a different order. (Inherited from Aggregator<T, TResult>)
RequiresTemporaryWorkspace	Gets whether the aggregator requires O(N) storage during the computation. (Inherited from Aggregator<T, TResult>)
SupportsDirectAggregation	Gets whether the aggregator supports computing the aggregation for all groups directly from the group levels. (Inherited from Aggregator<T, TResult>)
Transformation	Gets the delegate that performs the transformation of the result of the accumulation to produce the final result.
ZerosAffectResult	Gets whether the result of the outcome is different if zero elements are omitted. (Inherited from Aggregator<T, TResult>)

Methods

Aggregate(Vector<T>)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(IEnumerable<T>, Boolean)	Aggregates the elements of a sequence and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(ReadOnlySpan<T>, Boolean)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(Vector<T>, Boolean)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(ReadOnlySpan<T>, ReadOnlySpan<Boolean>, Boolean)	Aggregates over a span and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(Int32, ReadOnlySpan<T>, Int32, Boolean)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(Vector<T>, Int32, Int32, Nullable<Boolean>)	Aggregates the specified range of elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Aggregate(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, Boolean)	Aggregates over a span and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateBy(Vector<T>, IGrouping, Vector<TResult>)	Groups the elements of a vector according to the specified grouping. (Inherited from Aggregator<T, TResult>)
AggregateBy(Vector<T>, ReadOnlySpan<Int32>, Nullable<Boolean>, Vector<TResult>)	Aggregates the elements of a vector according to the specified level indexes. (Overrides Aggregator<T, TResult>.AggregateBy(Vector<T>, ReadOnlySpan<Int32>, Nullable<Boolean>, Vector<TResult>))
AggregateBy<TPredicate>(Vector<T>, ReadOnlySpan<Int32>, TPredicate, Nullable<Boolean>, Vector<TResult>)	Groups the elements of a vector according to the specified level indexes. (Inherited from Aggregator<T, TResult>)
AggregateColumns	Aggregates the columns of a matrix. (Inherited from Aggregator<T, TResult>)
AggregateColumnsListwise	Aggregates the columns of a matrix disregarding the entire row if any of its entries are missing. (Overrides Aggregator<T, TResult>.AggregateColumnsListwise(Matrix<T>, Vector<TResult>))
AggregateInto(Matrix<T>, Vector<TResult>)	Aggregates the columns of a matrix. (Inherited from Aggregator<T, TResult>) Obsolete.
AggregateInto(Vector<T>, IGrouping, Vector<TResult>)	Groups the elements of a vector according to the specified grouping. (Inherited from Aggregator<T, TResult>) Obsolete.
AggregateInto(Vector<T>, ReadOnlySpan<Int32>, Nullable<Boolean>, Vector<TResult>)	Aggregates the elements of a vector according to the specified level indexes. (Inherited from Aggregator<T, TResult>) Obsolete.
AggregateInto<TPredicate>(Vector<T>, ReadOnlySpan<Int32>, TPredicate, Nullable<Boolean>, Vector<TResult>)	Groups the elements of a vector according to the specified level indexes. (Inherited from Aggregator<T, TResult>) Obsolete.
AggregateInto<TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Int32>, Int32, Int32, TPredicate, Boolean, SpanSlice<TResult>)	Groups the elements of a vector according to the specified level indexes. (Inherited from Aggregator<T, TResult>)
AggregateListwiseInto	Aggregates the columns of a matrix disregarding the entire row if any of its entries are missing. (Inherited from Aggregator<T, TResult>) Obsolete.
AggregateWhere(Int32, ReadOnlySpan<T>, Int32, Func<T, Boolean>, Boolean)	Aggregates over a span and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(IEnumerable<T>, TPredicate, Boolean)	Aggregates the elements of a sequence and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(ReadOnlySpan<T>, TPredicate, Boolean)	Aggregates the elements of a span and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(Vector<T>, TPredicate, Nullable<Boolean>)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, TPredicate, Boolean)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(Vector<T>, Int32, Int32, TPredicate, Nullable<Boolean>)	Aggregates the specified range of elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Int32>, TPredicate, Boolean)	Aggregates the specified range of elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
AggregateWhere<T2, TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<T2>, Int32, TPredicate, Boolean)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ToString	Returns a string that represents the current object. (Inherited from Object)
TryAggregate(Vector<T>, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregate(IEnumerable<T>, Boolean, TResult)	Aggregates the elements of a sequence and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregate(ReadOnlySpan<T>, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregate(Vector<T>, Int32, Int32, TResult)	Aggregates the specified range of elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregate(Int32, ReadOnlySpan<T>, Int32, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregate(Int32, ReadOnlySpan<T>, Int32, Boolean, TResult))
TryAggregate(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregateWhere(Int32, ReadOnlySpan<T>, Int32, Func<T, Boolean>, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregateWhere<TPredicate>(IEnumerable<T>, TPredicate, Boolean, TResult)	Aggregates the elements of a sequence and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<TPredicate>(IEnumerable<T>, TPredicate, Boolean, TResult))
TryAggregateWhere<TPredicate>(ReadOnlySpan<T>, TPredicate, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<TPredicate>(ReadOnlySpan<T>, TPredicate, Boolean, TResult))
TryAggregateWhere<TPredicate>(Vector<T>, TPredicate, Nullable<Boolean>, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryAggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, TPredicate, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, TPredicate, Boolean, TResult))
TryAggregateWhere<TPredicate>(Vector<T>, Int32, Int32, TPredicate, Nullable<Boolean>, TResult)	Aggregates the specified range of elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<TPredicate>(Vector<T>, Int32, Int32, TPredicate, Nullable<Boolean>, TResult))
TryAggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Int32>, TPredicate, Boolean, TResult)	Aggregates the specified range of elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<Int32>, TPredicate, Boolean, TResult))
TryAggregateWhere<T2, TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<T2>, Int32, TPredicate, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Overrides Aggregator<T, TResult>.TryAggregateWhere<T2, TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<T2>, Int32, TPredicate, Boolean, TResult))
TryAggregateWhere<T2, TPredicate>(Int32, ReadOnlySpan<T>, Int32, ReadOnlySpan<T2>, Int32, TPredicate, Boolean, TResult)	Aggregates the elements of a vector and returns the result. (Inherited from Aggregator<T, TResult>)
TryGetAccumulator	Attempts to get an accumulator with the specified capability. (Overrides Aggregator<T, TResult>.TryGetAccumulator(Boolean, IAccumulator<T, TResult>))