Grouping<TKey> Class

Represents a grouping of elements with an index of the specified type.

Definition

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

public abstract class Grouping<TKey> : IGrouping

Visual Basic

Public MustInherit Class Grouping(Of TKey)
	Implements IGrouping

C++/CLI

generic<typename TKey>
public ref class Grouping abstract : IGrouping

[<AbstractClassAttribute>]
type Grouping<'TKey> = 
    class
        interface IGrouping
    end

Inheritance: Object → Grouping<TKey>

Implements: IGrouping

Type Parameters

TKey: The element type of the index.

Remarks

Use the Grouping<TKey> type to represent a grouping of elements where each group has a key of type TKey. Groupings can be used in aggregation and pivoting operations.

Grouping objects are created using static methods of the Grouping class.

Constructors

Grouping<TKey>

Constructs a new grouping object with the specified index.

Properties

Count	Gets the number of groups.
Index	Gets the index that contains the unique keys to the groups.
Item	Gets a sequence of indexes for the grouping with the specified key.

Methods

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>(Vector<T>, Aggregator<T, TResult>, TPredicate, Nullable<Boolean>, Vector<TResult>)	Aggregates the specified vector over each group and returns the result.
AggregateInto<T, TResult, TPredicate>(Aggregator<T, TResult>, Int32, ReadOnlySpanSlice<T>, TPredicate, Boolean, SpanSlice<TResult>)	Aggregates the specified vector over each group and returns the result.
As<T>	Returns a strongly typed version of a grouping object.
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)
GetCounts	Returns a histogram of the number of observations in each group.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetIndexes	Gets a sequence of indexes for the grouping.
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)