DataFrame<R, C>.TryGetColumnRole Method

Attempts to get the role assigned to the specified column.

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.8.0
C#
public bool TryGetColumnRole(
	C key,
	out ColumnRole role
)

Parameters

key  C
The typed column key.
role  ColumnRole
When this method returns, the assigned role, or None when the column has no explicit role or does not exist.

Return Value

Boolean
true when key is present in the current column index; otherwise false.

Remarks

None means no explicit role has been assigned. It is returned for existing unassigned columns and for missing columns when this method returns false.

Exceptions

See Also