DataFrameSchema<R, C> Class

Describes the schema of a data frame using typed row and column keys.

Definition

Namespace: Numerics.NET.DataAnalysis.Schema
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.8.0
C#
public sealed class DataFrameSchema<R, C> : IDataFrameSchema
Inheritance
Object  →  DataFrameSchema<R, C>
Implements
IDataFrameSchema

Type Parameters

R
The element type of the data frame row index.
C
The element type of the data frame column index.

Remarks

A DataFrameSchema<R, C> is a read-only snapshot of a data frame's schema at the time it is requested. This implementation currently records column keys, ordinals, element types, missing-value representation, category-index metadata, semantic column metadata, and column role metadata. Later changes to the data frame do not update previously returned schema objects.

The schema preserves typed column keys. A schema for DataFrame<R,int> remains keyed by Int32, a schema for DataFrame<R,string> remains keyed by String, and tuple or hierarchical keys are treated as ordinary values of type C.

The row-key type R is part of the schema type as a structural type fact. Actual row key values and row count are properties of a dataframe instance and are not exposed by this schema snapshot.

Schema objects are inspection-only. They do not mutate dataframe metadata, make columns categorical, change roles or semantic metadata, or modify storage.

Properties

ColumnCount Gets the number of columns described by this schema snapshot.
ColumnIndex Gets the typed column index captured by this schema snapshot.
Columns Gets the ordered column schemas.
Item[C] Gets the column schema with the specified typed column key.
Item[Int32] Gets the column schema at the specified ordinal.

Methods

Contains Returns whether the schema contains the specified typed column key.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetColumn Gets the schema for the specified typed column key.
GetColumnAt Gets the column schema at the specified ordinal.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ResolveColumns Resolves a selector to ordered column schemas.
ResolveKeys Resolves a selector to ordered column keys.
ResolveOrdinals Resolves a selector to ordered column ordinals.
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryGetColumn Attempts to get the schema for the specified typed column key.

See Also