DataFrame<R, C>.GetColumnRole Method

Gets the role assigned to the specified column.

Definition

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

public ColumnRole GetColumnRole(
	C key
)

Visual Basic

Public Function GetColumnRole ( 
	key As C
) As ColumnRole

C++/CLI

public:
ColumnRole GetColumnRole(
	C key
)

member GetColumnRole : 
        key : 'C -> ColumnRole

Parameters

key C: The typed column key.

Return Value

ColumnRole
The assigned role, or None when the column exists and no explicit role has been assigned.

Remarks

Column role metadata is owned by the data frame and lives in the Numerics.NET.DataAnalysis namespace. It is projected into schema snapshots returned by GetSchema(), but previously returned schema objects are not updated by later role changes.

Exceptions

ArgumentNullException	key is null.
KeyNotFoundException	key is not present in the current column index.