DataFrame<R, C>.ClearColumnRole Method

Definition

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

Overload List

ClearColumnRole(ColumnSelector) Clears explicit roles assigned to columns selected by a selector.
ClearColumnRole(C) Clears any explicit role assigned to the specified column.

ClearColumnRole(ColumnSelector)

Clears explicit roles assigned to columns selected by a selector.
C#
public DataFrame<R, C> ClearColumnRole(
	ColumnSelector selector
)

Parameters

selector  ColumnSelector
The selector that identifies columns to update.

Return Value

DataFrame<R, C>
The current data frame.

Remarks

The selector is resolved against a current schema snapshot. Empty selector results are no-ops. Later schema snapshots reflect the cleared roles; previously returned schema snapshots are unchanged.

Exceptions

ArgumentNullExceptionselector is null.
KeyNotFoundException The selector contains an explicit key that is not present in the current schema.
InvalidCastException The selector contains typed keys or a typed key predicate whose key type does not match the data frame column-key type.

ClearColumnRole(C)

Clears any explicit role assigned to the specified column.
C#
public DataFrame<R, C> ClearColumnRole(
	C key
)

Parameters

key  C
The typed column key.

Return Value

DataFrame<R, C>
The current data frame.

Remarks

After this method returns, the column role is None, which means no explicit role has been assigned.

Exceptions

ArgumentNullExceptionkey is null.
KeyNotFoundExceptionkey is not present in the current column index.

See Also