DataFrameR, C Class

public class DataFrame<R, C> : IDataFrame, 
	ISummarizable, IList<DataFrameRow<R, C>>, ICollection<DataFrameRow<R, C>>, 
	IEnumerable<DataFrameRow<R, C>>, IEnumerable

Public Class DataFrame(Of R, C)
	Implements IDataFrame, ISummarizable, IList(Of DataFrameRow(Of R, C)), 
	ICollection(Of DataFrameRow(Of R, C)), IEnumerable(Of DataFrameRow(Of R, C)), 
	IEnumerable

generic<typename R, typename C>
public ref class DataFrame : IDataFrame, 
	ISummarizable, IList<DataFrameRow<R, C>^>, ICollection<DataFrameRow<R, C>^>, 
	IEnumerable<DataFrameRow<R, C>^>, IEnumerable

type DataFrame<'R, 'C> =  
    class
        interface IDataFrame
        interface ISummarizable
        interface IList<DataFrameRow<'R, 'C>>
        interface ICollection<DataFrameRow<'R, 'C>>
        interface IEnumerable<DataFrameRow<'R, 'C>>
        interface IEnumerable
    end

Type Parameters

R

The element type of the row index.

C

The element type of the column index.

The DataFrameR, C type exposes the following members.

	Name	Description
	DataFrameR, C	Constructs a new empty data frame.

	Name	Description
	ColumnCount	Gets the number of columns in the data frame.
	ColumnIndex	Gets or sets the column index of the data frame.
	Columns	Gets an enumerator over the columns of the data frame.
	ItemC	Gets, sets or adds a column with the specified key.
	ItemInt32	Gets the column at the specified index.
	NamedColumns	Gets an enumerator over pairs of column key values and the corresponding columns.
	NamedRows	Gets an enumerator over pairs of row key values and the corresponding rows.
	RowCount	Gets the number of rows in the data frame.
	RowIndex	Gets the row index of the data frame.
	Rows	Gets an enumerator over the rows of the data frame.

	Name	Description
	AddColumn(C, IVector)	Adds a column to the data frame.
	AddColumnT(C, VectorT)	Adds a column to the data frame.
	AddColumnT(C, IListT)	Adds a column to the data frame.
	AggregateT(AggregatorGroupT)	Applies the specified aggregator to all the columns in the data frame.
	AggregateT(AggregatorGroupT)	Applies the specified aggregators to all the columns in the data frame.
	AggregateT, U(FuncVectorT, U)	Applies the specified aggregators to all the columns in the data frame.
	AggregateT, U, V(FuncVectorT, V, FuncVectorU, V)	Applies the specified aggregators to all the columns in the data frame.
	AggregateT, U, V, W(FuncVectorT, W, FuncVectorU, W, FuncVectorV, W)	Applies the specified aggregators to all the columns in the data frame.
	AggregateByR1(C, AggregatorGroup)	Returns a new data frame that aggregates the columns grouped by the specified column.
	AggregateByR1(C, ValueTupleC, AggregatorGroup)	Returns a new data frame that aggregates the columns grouped by the specified column.
	AggregateByR1(GroupingR1, AggregatorGroup)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1(GroupingR1, IDictionaryC, AggregatorGroup)	Applies the aggregators from a dictionary to selected columns in the data frame.
	AggregateByR1(GroupingR1, ValueTupleC, AggregatorGroup)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1(IGrouping, AggregatorGroup)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1(IGrouping, ValueTupleC, AggregatorGroup)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1(IListR1, AggregatorGroup)	Returns a new data frame that aggregates the columns grouped by the specified vector.
	AggregateByR1(IListR1, ValueTupleC, AggregatorGroup)	Returns a new data frame that aggregates the columns grouped by the specified vector.
	AggregateByR1, T(C, AggregatorGroupT)	Returns a new data frame that aggregates the columns grouped by the specified column.
	AggregateByR1, T(GroupingR1, AggregatorGroupT)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1, T(IGrouping, AggregatorGroupT)	Returns a new data frame that aggregates the columns according to the specified grouping.
	AggregateByR1, T(IListR1, AggregatorGroupT)	Returns a new data frame that aggregates the columns grouped by the specified vector.
	AggregateByR1, C1(GroupingR1, IEnumerableValueTupleC, AggregatorGroup, IndexC1)	Applies the specified aggregators to all the columns in the data frame.
	AggregateByR1, T, U(C, FuncVectorT, U)	Applies the specified aggregation function to the values in each column grouped by the specified grouping column.
	Append(DataFrameR, C, IndexC, Boolean)	Combines two data frames by appending the rows of the right data frame to the rows of this data frame.
	Append(DataFrameR, C, JoinType, Boolean)	Combines two data frames by appending the rows of the right data frame to the rows of this data frame.
	ApplyWithT	Applies a matrix function to this data frame and another and returns the result as a data frame.
	Clone	Makes a copy of the data frame.
	CombineWithT	Combines the data frame with another data frame, aligning the two data frames and using the specified function to generate the value for common values.
	Describe	Returns a data frame containing descriptive statistics for each column in the data frame.
	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.)
	GetColumn(C)	Gets the specified column as a Double vector.
	GetColumnT(C)	Gets the specified column as a strongly typed vector.
	GetColumns(C)	Returns a new data frame that contains only the specified columns.
	GetColumns(IEnumerableC)	Returns a new data frame that contains only the specified columns.
	GetColumnsAt(IEnumerableInt32)	Returns a new data frame that contains only the specified columns.
	GetColumnsAt(Int32)	Returns a new data frame that contains only the specified columns.
	GetEnumerator	Gets an enumerator for the rows of the data frame.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNearestRow	Gets the row nearest to the specified row key.
	GetNearestRowAsT	Gets the row at the specified row index as a vector of the specified type.
	GetNearestRows	Returns a new data frame that contains only the rows in the specified sequence.
	GetRow	Gets the row with the specified row key.
	GetRowAsT	Gets the row at the specified row index as a vector of the specified type.
	GetRowAt	Gets the row with the specified row key.
	GetRowAtAsT	Gets the row at the specified row index.
	GetRows(R)	Returns a new data frame that contains only the rows with keys in the specified array.
	GetRows(IEnumerableR)	Returns a new data frame that contains only the rows in the specified sequence.
	GetRows(Subset)	Returns a new data frame that contains only the rows in the specified subset.
	GetRows(VectorBoolean)	Returns a new data frame that contains only the rows specified by a boolean mask.
	GetRows(R, R)	Returns a new data frame that contains only the rows specified by a range.
	GetRowsAt	Returns a new data frame that contains only the rows in the specified sequence.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GroupByR1(C)	Returns a hierarchical index consisting of the current index grouped by the specified column.
	GroupByR1(IListR1)	Returns a hierarchical grouping consisting of the current index grouped by the specified grouping values.
	GroupByR1, R2(C, C)	Returns a hierarchical grouping on two columns.
	GroupedByR1	Returns a new data frame by grouping the index by the specified column.
	Head	Returns the first few rows of the data frame.
	MakeCategorical(C)	Marks the specified column as containing categorical data.
	MakeCategorical(C)	Marks the specified columns as containing categorical data.
	MakeCategoricalT(C, IndexT)	Marks the specified column as containing categorical data.
	MakeCategoricalAt(Int32)	Marks the column at the specified index as containing categorical data.
	MakeCategoricalAtT(Int32, IndexT)	Marks the column at the specified index as containing categorical data.
	Map(IListC, FuncIVector, IVector, IListC)	Applies the specified function to selected columns and returns the result in a new data frame.
	Map(IListC, FuncIVector, IVector, FuncC, C)	Applies the specified function to selected columns and returns the result in a new data frame.
	MapT(FuncVectorT, IVector)	Applies the specified function to all columns with the specified element type and returns the result in a new data frame.
	MapT(IListC, FuncVectorT, IVector, IListC)	Applies the specified function to selected columns.
	MapT(IListC, FuncVectorT, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndAppend(C, FuncIVector, IVector, C)	Applies the specified function to selected columns and appends the results to the end of the data frame.
	MapAndAppend(IListC, FuncIVector, IVector, IListC)	Applies the specified function to selected columns and appends the results to the end of the data frame.
	MapAndAppend(IListC, FuncIVector, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndAppendT(C, FuncVectorT, IVector, C)	Applies the specified function to selected columns and appends the results to the end of the data frame.
	MapAndAppendT(IListC, FuncVectorT, IVector, IListC)	Applies the specified function to selected columns and appends the results to the end of the data frame.
	MapAndAppendT(IListC, FuncVectorT, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndInsertAfter(C, FuncIVector, IVector, C)	Applies the specified function to selected columns.
	MapAndInsertAfter(IListC, FuncIVector, IVector, IListC)	Applies the specified function to selected columns and inserts the result after each mapped column in the data frame.
	MapAndInsertAfter(IListC, FuncIVector, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndInsertAfterT(C, FuncVectorT, IVector, C)	Applies the specified function to selected columns.
	MapAndInsertAfterT(IListC, FuncVectorT, IVector, IListC)	Applies the specified function to selected columns and inserts the result after each mapped column in the data frame.
	MapAndInsertAfterT(IListC, FuncVectorT, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndReplace(C, FuncIVector, IVector, C)	Applies the specified function to selected columns.
	MapAndReplace(IListC, FuncIVector, IVector, IListC)	Applies the specified function to selected columns and replaces the columns with the mapped columns.
	MapAndReplace(IListC, FuncIVector, IVector, FuncC, C)	Applies the specified function to selected columns.
	MapAndReplaceT(C, FuncVectorT, IVector, C)	Applies the specified function to selected columns.
	MapAndReplaceT(IListC, FuncVectorT, IVector, IListC)	Applies the specified function to selected columns and replaces the columns with the mapped columns.
	MapAndReplaceT(IListC, FuncVectorT, IVector, FuncC, C)	Applies the specified function to selected columns.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PivotR1, C1, T(C, C, C)	Constructs a new data frame using the specified columns as row and column indexes.
	PivotR1, C1, T(C, C, C, AggregatorGroupT)	Constructs a new data frame using the specified columns as row and column indexes and aggregates the values corresponding to each row-column pair.
	PivotByR1, C1	Returns a two-dimensional grouping on the specified columns.
	RemoveColumn	Removes the specified column from the data frame.
	RemoveColumnAt	Removes the column at the specified position from the data frame.
	RemoveColumnsAt	Removes the column at the specified position from the data frame.
	RemoveColumnsWithMissingValues	Returns a new data frame with any columns containing missing values removed.
	RemoveRowIndex	Returns a new data frame that has a default numeric row index. The row index is discarded.
	RemoveRowIndex(C)	Returns a new data frame that has a default numeric row index. The row index is moved to a new column in the data frame.
	RemoveRows(IEnumerableR)	Returns a new data frame that has the specified rows removed.
	RemoveRows(VectorBoolean)	Returns a new data frame that has the specified rows removed.
	RemoveRowsAt	Returns a new data frame that has the specified rows removed.
	RemoveRowsWithMissingValues	Returns a new data frame with any rows containing missing values removed.
	RemoveRowsWithMissingValues(C)	Returns a new data frame with any rows containing missing values removed.
	RenameColumn(C, C)	Renames the specified column.
	RenameColumn(IEnumerableC, IEnumerableC)	Renames the specified column.
	RenameColumns	Renames the columns that satisfy a condition using the specified key generator.
	ReplaceMissingValues(Direction, Int32)	Returns a new data frame whose columns have their missing values replaced with the next or previous non-missing value.
	ReplaceMissingValuesT(T)	Returns a new data frame whose columns of the specified type have their missing values replaced with the specified value.
	ReplaceMissingValuesT(VectorT)	Returns a new data frame whose columns of the specified type have their missing values replaced with the corresponding value from a row vector.
	SelectRowsR1(IndexR1, Subset)	Returns a new data frame that contains the selected rows and uses the specified row index.
	SelectRowsR1(IndexR1, Int32)	Returns a new data frame that contains the selected rows and uses the specified row index.
	SelectRowsR1(IndexR1, Int32, Int32, Int32)	Returns a new data frame that contains the selected rows and uses the specified row index.
	SortBy(C)	Sorts the data frame by the specified column.
	SortBy(Int32)	Sorts the data frame by the specified column.
	SortBy(C, SortOrder)	Sorts the data frame by the specified column.
	SortBy(Int32, SortOrder)	Sorts the data frame by the specified column.
	SortByIndex	Sorts the data frame by the row index in ascending order.
	SortByIndex(SortOrder)	Sorts the data frame by the row index.
	Stack	Returns a data frame containing all values in the data frame as row-column-value pairs.
	StackT(IEnumerableC, IEnumerableC, C, C)	Converts a data frame from wide to long format.
	Summarize	Returns a summary of the contents of the data frame using the default summary options.
	Summarize(SummaryOptions)	Returns a summary of the contents of the data frame using the specified options.
	Tail	Returns the last few rows of the data frame.
	ToMatrixT	Converts the data frame to a matrix with elements of the specified type.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	TransformColumns(FuncIVector, IVector)	Applies the specified transformation to each column in the data frame.
	TransformColumnsT, U(FuncT, U)	Applies the specified transformation to each element of each column in the data frame.
	TransformColumnsT, U(FuncVectorT, VectorU)	Applies the specified transformation to each column in the data frame.
	TransformColumnsT, U, R1(FuncVectorT, VectorU)	Applies the specified transformation to each column in the data frame.
	TryGetRow	Attempts to get the row at the specified row index.
	UnstackT	Converts a data frame from long to wide format.
	WithColumnIndexC1	Returns a new data frame that relabels the columns using the specified index.
	WithRowIndexR1(C)	Returns a new data frame using the specified column as the index.
	WithRowIndexR1(IndexR1)	Returns a new data frame that uses the specified row index.
	WithRowIndexR1, R2(C, C)	Returns a new data frame using the specified columns as a hierarchical index.
	WithRowIndexR1, R2, R3(C, C, C)	Returns a new data frame using the specified columns as a hierarchical index.

	Name	Description
	Dynamic	Gets the specified column as a vector of Double.
	DynamicAssignment	Sets the specified column.

	Name	Description
	GroupDataFrameRowR, C	Overloaded. Returns a grouping by the unique elements in a list. (Defined by Grouping.)
	GroupDataFrameRowR, C	Overloaded. Returns a grouping by the unique elements in a sequence. (Defined by Grouping.)
	GroupDataFrameRowR, C(IEqualityComparerDataFrameRowR, C)	Overloaded. Returns a grouping by the unique elements in a list using the specified comparer to determine equality. (Defined by Grouping.)
	GroupDataFrameRowR, C(IEqualityComparerDataFrameRowR, C)	Overloaded. Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality. (Defined by Grouping.)
	SumDataFrameRowR, C	Overloaded. Computes the sum of the sequence of values. (Defined by ArrayMath.)
	SumDataFrameRowR, C, U(FuncDataFrameRowR, C, U)	Overloaded. Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence. (Defined by ArrayMath.)
	ToDataTable	Overloaded. Constructs a data table from a data frame. (Defined by DataExtensions.)
	ToDataTable(String)	Overloaded. Constructs a data table from a data frame. (Defined by DataExtensions.)
	ToDataTableC(IEnumerableC)	Overloaded. Constructs a data table from the specified columns a data frame. (Defined by DataExtensions.)
	ToDataTableC(String, IEnumerableC)	Overloaded. Constructs a data table from the specified columns a data frame. (Defined by DataExtensions.)

Use the DataFrameR, C type to represent a 2-dimensional collection of possibly heterogeneous data. The rows and columns are indexed by keys of type R and C, respectively. Rows and columns can be accessed through their keys or ordinal position.

Any operation that changes the rows of a data frame always returns a new data frame. Columns can be added and removed from a data frame without creating a new data frame. The values in a column are immutable, so direct modification of data values is not supported.

The columns of a data frame are stored as strongly typed vectors. However, the column types are not part of the type definition of the data frame. This means that the element type of the column must be specified when accessing a column, or an untyped vector is returned as an IVector object. Some care must be taken to specify the correct element type, or an exception may be thrown at runtime.

The fact that the data is stored in columns means that accessing the data is most efficient column-wise. When computing values based on multiple columns, it is better to write the operation in terms of the column vectors than to iterate through the rows of the data frame.

The data frame class supports many data manipulation and transformation operations, including adding and removing columns, selecting rows, structural operations like stacking and creating pivot tables, processing missing values and aggregation. By including the Extreme.DataAnalysis.Linq namespace, LINQ queries are also supported.

Hierarchical row and column indexes are supported. In order to return the proper type of the indexes, some structural operations are defined as extension methods in the static DataFrame class.

Reference