 | DataFrame Class |
Class DataFrame represents a two-dimensional data object consisting of
a list of columns of the same length.
Inheritance HierarchySystemObject
CenterSpace.NMath.CoreDataFrame
CenterSpace.NMath.CoreKruskalWallisTable
CenterSpace.NMath.CoreOneWayAnovaTable
CenterSpace.NMath.CoreOneWayRanovaTable
CenterSpace.NMath.CoreTwoWayAnovaTable
CenterSpace.NMath.CoreDataFrame
CenterSpace.NMath.CoreKruskalWallisTable
CenterSpace.NMath.CoreOneWayAnovaTable
CenterSpace.NMath.CoreOneWayRanovaTable
CenterSpace.NMath.CoreTwoWayAnovaTable
Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.3
SyntaxThe DataFrame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataFrame |
Default constructor. Constructs an empty data frame.
|
| DataFrame(DataTable) |
Constructs a DataFrame instance from the given DataTable.
|
| DataFrame(String) |
Constructs a DataFrame instance from the given string.
|
| DataFrame(DFColumn) |
Constructs a DataFrame instance from the given array of columns.
|
| DataFrame(DataTable, Int32) |
Constructs a DataFrame instance from the given DataTable. Row keys are
set to the values in the specified column.
|
| DataFrame(DataTable, Object) |
Constructs a DataFrame instance from the given DataTable. Row keys are
set to the given array of objects.
|
| DataFrame(DataTable, String) |
Constructs a DataFrame instance from the given DataTable. Row keys are
set to the values in the specified column.
|
| DataFrame(DFColumn, ICollection) |
Constructs a DataFrame instance from the given array of columns
and a collection of row keys.
|
| DataFrame(DoubleMatrix, String) |
Constructs a DataFrame instance from the given matrix.
|
| DataFrame(String, Boolean, Boolean, String, Boolean) |
Constructs a DataFrame instance from the given string.
|
Properties| Name | Description | |
|---|---|---|
 | Cols |
Gets the number of columns in this data frame.
|
| ColumnHeaders |
Gets and sets the array of column labels in this data frame.
|
| ColumnNames |
Gets an array of the column names in this data frame.
|
| CreateDate |
Gets the creation datetime for this data object.
|
| ItemInt32 |
Gets the column indicated by the given column index.
|
| ItemString |
Gets the column indicated by the given column name.
|
| ItemInt32, Slice |
Gets the subcolumn indicated by the given column index and row slice.
|
| ItemInt32, Subset |
Gets the subcolumn indicated by the given column index and row subset.
|
| ItemInt32, Int32 |
Gets and sets the element at the given row and column index.
|
| ItemObject, String |
Gets and sets the element specified by the given row key and column name.
|
| ItemSlice, Slice |
Gets a new data frame containing the portion of this data frame indicated by
the given row slice and column slice.
|
| ItemSlice, Subset |
Gets a new data frame containing the portion of this data frame indicated by
the given row slice and column subset.
|
| ItemSubset, Slice |
Gets a new data frame containing the portion of this data frame indicated by
the given row subset and column slice.
|
| ItemSubset, Subset |
Gets a new data frame containing the portion of this data frame indicated by
the given row subset and column subset.
|
| Name |
Gets and sets the name for this data frame.
|
| RowKeyHeader |
Gets and sets the header for the row keys in this data frame.
|
| RowKeys |
Gets an object array of the row keys in this data frame.
|
| Rows |
Gets the number of rows in this data frame.
|
| StringRowKeys |
Gets a string array of the row keys in this data frame.
|
| Type |
Gets the type of this data object.
|
Methods| Name | Description | |
|---|---|---|
| AddColumn(DataColumn) |
Adds the given DataColumn to this data frame.
|
| AddColumn(IDFColumn) |
Adds a column to this data frame.
|
| AddColumn(DataColumn, DataRowCollection) |
Adds the given DataColumn and accompanying data to this data frame.
|
| AddColumns(DataColumnCollection) |
Adds a collection of DataColumns to this data frame.
|
| AddColumns(DataColumnCollection, DataRowCollection) |
Adds a collection of DataColumns and accompanying data to this data frame.
|
| AddColumns(DataFrame, Boolean) |
Adds all columns from another data frame to this data frame, optionally
copying the data in the columns.
|
| AddRow(ICollection) |
Adds a row to this data frame using default row key (this.Rows + 1).
|
| AddRow(DataRow) |
Adds the data from the given DataRow to this data frame.
|
| AddRow(Int32, DataRow) |
Adds the data from the given DataRow using the specified column in the row
as the row key.
|
| AddRow(Object, DoubleVector) |
Adds a row to this data frame.
|
| AddRow(Object, ICollection) |
Adds a row to this data frame.
|
| AddRow(Object, IDictionary) |
Adds a row to this data frame from the given dictionary.
|
| AddRow(Object, DataRow) |
Adds the data from the given DataRow using the given row key.
|
| AddRow(Object, Object) |
Adds a row to this data frame.
|
| AddRows(DataRowCollection) |
Adds the data from the given DataRowCollection.
|
| AddRows(Int32, DataRowCollection) |
Adds the data from the given DataRow using the specified column as row keys.
|
| AddRows(Object, DataRowCollection) |
Adds the data from the given DataRowCollection using the specified row keys.
|
| CleanAndRemoveCols |
Removes all columns that contain missing values.
|
| CleanAndRemoveCols(Int32) |
Removes columns that contain missing values in the given rows.
|
| CleanAndRemoveRows |
Removes rows that contain missing values.
|
| CleanAndRemoveRows(Int32) |
Removes rows in this data frame that missing values in the given
columns.
|
| CleanCols |
Returns a new data frame containing the columns in this data frame that
do not contain missing values.
|
| CleanCols(Int32) |
Returns a new data frame containing the columns in this data frame that
do not contain missing values in the given rows.
|
| CleanRows |
Returns a new data frame containing the rows in this data frame that
do not contain missing values.
|
| CleanRows(Int32) |
Returns a new data frame containing the rows in this data frame that
do not contain missing values in the given columns.
|
| Clear |
Removes all columns and all rows from this data frame.
|
| Clone |
Returns a deep copy of this data frame.
|
| ContainsColumn |
Tests whether this data frame contains a column of the given name.
|
| ContainsRow |
Tests whether this data frame contains a row with the given row key.
|
| GetColumnDictionary(Int32) |
Returns a dictionary for values in the given column. The row keys are
used as keys in the dictionary.
|
| GetColumnDictionary(String) |
Returns a dictionary for values in the given column. The row keys are
used as keys in the dictionary.
|
| GetColumnDictionary(Int32, Int32) |
Returns a dictionary for values in the given column. The dictionary keys are
taken from the specified key column.
|
| GetColumns(Slice) |
Gets a new data frame containing the portion of this data frame specified by the
given column slice.
|
| GetColumns(Subset) |
Gets a new data frame containing the portion of this data frame specified by the
given column subset.
|
| GetFactor(Int32) |
Creates a factor from the given column.
|
| GetFactor(String) |
Creates a factor from the given column.
|
| GetFactor(Int32, Object) |
Creates a factor from the given column.
|
| GetFactor(String, Object) |
Creates a factor from the given column.
|
| GetRow(Int32) |
Gets the data for a given row index.
|
| GetRow(Object) |
Gets the data for the first row with a given row key.
|
| GetRowDictionary(Int32) |
Gets a row dictionary for the given row index. The dictionary keys are
the column names.
|
| GetRowDictionary(Object) |
Gets a row dictionary for the given row key. The dictionary keys are
the column names.
|
| GetRows(Slice) |
Gets a new data frame containing the portion of this data frame specified by the
given row slice.
|
| GetRows(Subset) |
Gets a new data frame containing the portion of this data frame specified by the
given row subset.
|
| GetSubRow(Int32, Slice) |
Gets the portion of the row in this data frame indicated by the given row index and
column slice.
|
| GetSubRow(Int32, Subset) |
Gets the portion of the row in this data frame indicated by the given row index and
column subset.
|
| IndexOf |
Returns the index of the first row with a given value in a specified column.
|
| IndexOfColumn |
Return the index of the first column with a given column name.
|
| IndexOfKey |
Returns the index of the first row with a given row key.
|
| IndexRowKeys |
Resets the row keys for all rows to rowIndex + 1.
|
| IndicesOf |
Returns the indices of all rows with a given value in a specified column.
|
| IndicesOfColumn |
Returns an array of column indices for the given column name. Column
names need not be unique, so multiple columns may share a single name.
|
| IndicesOfKey |
Returns the indices of all rows with a given row key.
|
| InsertColumn |
Inserts the given column at the given column index.
|
| InsertRow(Int32, Object, DoubleVector) |
Inserts the given row at the given row index.
|
| InsertRow(Int32, Object, ICollection) |
Inserts the given row at the given row index.
|
| InsertRow(Int32, Object, IDictionary) |
Inserts the given row at the given row index.
|
 | Load(String) |
Imports a data frame from the given text file.
|
| Load(Stream, String) |
Imports a data frame from the given stream.
|
| Load(StreamReader, String) |
Imports a data frame from the given stream reader.
|
| Load(String, Boolean, Boolean, String, Boolean) |
Imports a data frame from the given text file.
|
| Load(Stream, String, Boolean, Boolean, String, Boolean) |
Imports a data frame from the given stream.
|
| Load(StreamReader, String, Boolean, Boolean, String, Boolean) |
Imports a data frame from the given stream reader.
|
| OpenInEditor |
Opens the contents of this data frame in the default text editor.
|
| PermuteColumns |
Reorders the columns in this data frame according to the given permutation array.
|
| PermuteRows |
Reorders the rows in this data frame according to the given permutation array.
|
| RemoveAllColumns |
Removes all columns from this data frame, but preserves the existing row keys.
|
| RemoveAllRows |
Removes all rows from this data frame.
|
| RemoveColumn(Int32) |
Removes the column from this data frame with the given column index.
|
| RemoveColumn(String) |
Removes all columns from this data frame with the given column name.
|
| RemoveColumns(Slice) |
Removes the columns from this data frame specified by the given column slice.
|
| RemoveColumns(Subset) |
Removes the columns from this data frame specified by the given column subset.
|
| RemoveRow(Int32) |
Removes the row from this data table at the given row index.
|
| RemoveRow(Object) |
Removes all rows from this data table with the given row key.
|
| RemoveRows(Slice) |
Removes the rows from this data frame specified by the given row slice.
|
| RemoveRows(Subset) |
Removes the rows from this data frame specified by the given row subset.
|
| Save(String) |
Exports the contents of this data frame to a text file.
|
| Save(String, Boolean, Boolean, String) |
Exports the contents of this data frame to a text file.
|
| Save(String, Boolean, Boolean, String, String, String, String) |
Exports the contents of this data frame to a text file.
|
| SetRowKey |
Sets the row key for the given row index to the given value.
|
| SetRowKeys |
Sets the row keys in this data frame to the elements of the given collection.
|
| SortByColumnHeader |
Sorts the columns in this data frame by the column headers.
|
| SortRows(Int32) |
Sorts the rows in this data frame according to the given ordered array of column
indices.
|
| SortRows(Int32, SortingType) |
Sorts the rows in this data frame according to the given ordered array of column
indices. Sort order is determined by the matching array of sorting types (ascending
or descending).
|
| SortRowsByKeys |
Sorts the rows in this data frame by their row keys in ascending order.
|
| SortRowsByKeys(SortingType) |
Sorts the rows in this data frame by their row keys.
|
| SwapColumns |
Swaps the position of the given columns in the data frame.
|
| SwapRows |
Swaps the position of the given rows in the data frame.
|
| Tabulate(Int32, Int32, FuncIDFColumn, Boolean) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, FuncIDFColumn, DateTime) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, FuncIDFColumn, Double) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, FuncIDFColumn, Int32) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, FuncIDFColumn, Object) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, FuncIDFColumn, String) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, Boolean) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, DateTime) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, Double) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, Int32) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, Object) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(String, String, FuncIDFColumn, String) |
Tabulates the results of applying the given delegate to the values in the specified data
column for each level of the specified factor.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, Boolean) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, DateTime) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, Double) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, Int32) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, Object) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(Int32, Int32, Int32, FuncIDFColumn, String) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, Boolean) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, DateTime) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, Double) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, Int32) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, Object) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| Tabulate(String, String, String, FuncIDFColumn, String) |
Tabulates the results of applying the given delegate to the values in the specified data
column for every combination of the two specified factors.
|
| ToDataTable |
Returns a data table containing all data in this data frame.
|
| ToDoubleMatrix |
Returns a double matrix containing all numeric data in this data frame.
|
| ToString |
Returns a formatted string representation of this data frame.
(Overrides ObjectToString.) |
| ToString(Boolean, Boolean, String) |
Returns a formatted string representation of this data frame.
|
| ToString(Boolean, Boolean, String, String, String, String) |
Returns a formatted string representation of this data frame.
|
Fields| Name | Description | |
|---|---|---|
 | creationDate_ |
The creation DateTime of this data object.
|
| name_ |
The name of this data object.
|
| rowKeyHeader_ |
Heading for row keys
|
 | rowKeys_ |
List of row keys
|
Remarks
Columns may contain difference types of data: numeric, string, boolean,
generic, and so on. Methods are provided for appending, inserting, removing,
sorting, and permuting rows and columns.
Columns can be accessed by index or name. Rows can be accessed by index or key. Column names and row keys do not need to be unique.
Columns can be accessed by index or name. Rows can be accessed by index or key. Column names and row keys do not need to be unique.
See Also