Share via


DataFrameColumn Class

Definition

The base column type. All APIs should be defined here first

public abstract class DataFrameColumn : System.Collections.IEnumerable
type DataFrameColumn = class
    interface IEnumerable
Public MustInherit Class DataFrameColumn
Implements IEnumerable
Inheritance
DataFrameColumn
Derived
Implements

Constructors

DataFrameColumn(String, Int64, Type)

The base DataFrameColumn constructor.

Properties

DataType

The type of data this column holds.

Item[Int64, Int32]

Returns length number of values starting from startIndex.

Item[Int64]

Indexer to get/set values at rowIndex

Length

The length of this column

Name

The column name.

NullCount

The number of null values in this column.

Methods

Abs(Boolean)

Updates each numeric element with its absolute numeric value

Add(DataFrameColumn, Boolean)

Performs element-wise addition

Add<T>(T, Boolean)

Performs an element-wise addition on each value in the column

AddDataViewColumn(DataViewSchema+Builder)

Adds a new DataViewSchema.Column to the specified builder for the current column.

AddValueUsingCursor(DataViewRowCursor, Delegate)

Appends a value to this DataFrameColumn using cursor

All()

Returns whether all the elements are True

And(Boolean, Boolean)

Performs an element-wise boolean And on each value in the column

And(DataFrameColumn, Boolean)

Performs element-wise boolean And

Any()

Returns whether any element is True

Clamp<U>(U, U, Boolean)

Clamps values beyond the specified thresholds

ClampImplementation<U>(U, U, Boolean)

Clamps values beyond the specified thresholds

Clone(DataFrameColumn, Boolean, Int64)

Clone column to produce a copy potentially changing the order of values by supplying mapIndices and an invert flag

CloneImplementation(DataFrameColumn, Boolean, Int64)

Clone column to produce a copy potentially changing the order of values by supplying mapIndices and an invert flag

Create(String, IEnumerable<String>)

A static factory method to create a StringDataFrameColumn. It allows you to take advantage of type inference based on the type of the values supplied.

Create<T>(String, IEnumerable<Nullable<T>>)

A static factory method to create a PrimitiveDataFrameColumn<T>. It allows you to take advantage of type inference based on the type of the values supplied.

Create<T>(String, IEnumerable<T>)

A static factory method to create a PrimitiveDataFrameColumn<T>. It allows you to take advantage of type inference based on the type of the values supplied.

CumulativeMax(Boolean)

Updates each element with its cumulative maximum

CumulativeMax(IEnumerable<Int64>, Boolean)

Updates column values at rowIndices with its cumulative rowIndices maximum

CumulativeMin(Boolean)

Updates each element with its cumulative minimum

CumulativeMin(IEnumerable<Int64>, Boolean)

Updates column values at rowIndices with its cumulative rowIndices minimum

CumulativeProduct(Boolean)

Updates each element with its cumulative product

CumulativeProduct(IEnumerable<Int64>, Boolean)

Updates column values at rowIndices with its cumulative rowIndices product

CumulativeSum(Boolean)

Updates each element with its cumulative sum

CumulativeSum(IEnumerable<Int64>, Boolean)

Updates column values at rowIndices with its cumulative rowIndices sum

Description()

Returns a DataFrameColumn with statistics that describe the column

Divide(DataFrameColumn, Boolean)

Performs element-wise division

Divide<T>(T, Boolean)

Performs an element-wise division on each value in the column

ElementwiseEquals(DataFrameColumn)

Performs element-wise equals

ElementwiseEquals<T>(T)

Performs an element-wise equals on each value in the column

ElementwiseGreaterThan(DataFrameColumn)

Performs element-wise greater than

ElementwiseGreaterThan<T>(T)

Performs an element-wise greater than on each value in the column

ElementwiseGreaterThanOrEqual(DataFrameColumn)

Performs element-wise greater than or equal

ElementwiseGreaterThanOrEqual<T>(T)

Performs an element-wise greater than or equal on each value in the column

ElementwiseIsNotNull()

Performs an element-wise not equal to Null on each value in the column

ElementwiseIsNull()

Performs an element-wise equal to Null on each value in the column

ElementwiseLessThan(DataFrameColumn)

Performs element-wise less than

ElementwiseLessThan<T>(T)

Performs an element-wise less than on each value in the column

ElementwiseLessThanOrEqual(DataFrameColumn)

Performs element-wise less than or equal

ElementwiseLessThanOrEqual<T>(T)

Performs an element-wise less than or equal on each value in the column

ElementwiseNotEquals(DataFrameColumn)

Performs element-wise not-equals

ElementwiseNotEquals<T>(T)

Performs an element-wise not-equals on each value in the column

FillNulls(Object, Boolean)

Returns a new column with null elements replaced by value.

FillNullsImplementation(Object, Boolean)
Filter<U>(U, U)

Returns a new column filtered by the lower and upper bounds

FilterImplementation<U>(U, U)

Returns a new column filtered by the lower and upper bounds

GetArrowField()
GetDataViewGetter(DataViewRowCursor)

Creates a ValueGetter<TValue> that will return the value of the column for the row the cursor is referencing.

GetEnumeratorCore()

Returns an enumerator that iterates this column.

GetGroupedOccurrences(DataFrameColumn, HashSet<Int64>)

Get occurences of each value from this column in other column, grouped by this value

GetGroupedOccurrences<TKey>(DataFrameColumn, HashSet<Int64>)

Get occurences of each value from this column in other column, grouped by this value

GetMaxRecordBatchLength(Int64)

Returns the max number of values that are contiguous in memory

GetValue(Int64)

Returns the value at rowIndex.

GetValueGetterUsingCursor(DataViewRowCursor, DataViewSchema+Column)

Returns the ValueGetter for each active column in cursor as a delegate to be cached.

GetValues(Int64, Int32)

Returns length number of values starting from startIndex.

GroupBy(Int32, DataFrame)
GroupColumnValues<TKey>(HashSet<Int64>)

Groups the rows of this column by their value.

HasDescription()

Used to exclude columns from the Description method

Info()

Returns a StringDataFrameColumn containing the DataType and Length of this column

IsNumericColumn()

Determines if the column is of a numeric type

LeftShift(Int32, Boolean)

Performs an element-wise left shift on each value in the column

Max()

Returns the maximum of the values in the column

Max(IEnumerable<Int64>)

Returns the maximum of the values at rowIndices

Mean()

Returns the mean of the values in the column. Throws if this is not a numeric column

Median()

Returns the median of the values in the column. Throws if this is not a numeric column

Min()

Returns the minimum of the values in the column

Min(IEnumerable<Int64>)

Returns the minimum of the values at the rowIndices

Modulo(DataFrameColumn, Boolean)

Performs element-wise modulus

Modulo<T>(T, Boolean)

Performs an element-wise modulus operation on each value in the column

Multiply(DataFrameColumn, Boolean)

Performs element-wise multiplication

Multiply<T>(T, Boolean)

Performs an element-wise multiplication on each value in the column

Or(Boolean, Boolean)

Performs an element-wise boolean Or on each value in the column

Or(DataFrameColumn, Boolean)

Performs element-wise boolean Or

Product()

Returns the product of the values in the column

Product(IEnumerable<Int64>)

Returns the product of the values at the rowIndices

Resize(Int64)

Called internally from Append, Merge and GroupBy. Resizes the column to the specified length to allow setting values by indexing

ReverseAdd<T>(T, Boolean)

Performs a reversed element-wise addition on each value in the column

ReverseAnd(Boolean, Boolean)

Performs a reversed element-wise boolean And on each value in the column

ReverseDivide<T>(T, Boolean)

Performs a reversed element-wise division on each value in the column

ReverseModulo<T>(T, Boolean)

Performs a reversed element-wise modulus operation on each value in the column

ReverseMultiply<T>(T, Boolean)

Performs a reversed element-wise multiplication on each value in the column

ReverseOr(Boolean, Boolean)

Performs a reversed element-wise boolean Or on each value in the column

ReverseSubtract<T>(T, Boolean)

Performs a reversed element-wise subtraction on each value in the column

ReverseXor(Boolean, Boolean)

Performs a reversed element-wise boolean Xor on each value in the column

RightShift(Int32, Boolean)

Performs an element-wise right shift on each value in the column

Round(Boolean)

Calls Math.Round on each value in a column

SetName(String, DataFrame)
Obsolete.

Updates the name of this column.

SetName(String)

Updates the column name.

SetValue(Int64, Object)

Sets the value at rowIndex with value

Sort(Boolean)

Returns a copy of this column sorted by its values

Subtract(DataFrameColumn, Boolean)

Performs element-wise subtraction

Subtract<T>(T, Boolean)

Performs an element-wise subtraction on each value in the column

Sum()

Returns the sum of the values in the column

Sum(IEnumerable<Int64>)

Returns the sum of the values at the rowIndices

ToArrowArray(Int64, Int32)
ValueCounts()

Returns a DataFrame containing counts of unique values

Xor(Boolean, Boolean)

Performs an element-wise boolean Xor on each value in the column

Xor(DataFrameColumn, Boolean)

Performs element-wise boolean Xor

Operators

Addition(Byte, DataFrameColumn)
Addition(DataFrameColumn, Byte)
Addition(DataFrameColumn, DataFrameColumn)
Addition(DataFrameColumn, Decimal)
Addition(DataFrameColumn, Double)
Addition(DataFrameColumn, Int16)
Addition(DataFrameColumn, Int32)
Addition(DataFrameColumn, Int64)
Addition(DataFrameColumn, SByte)
Addition(DataFrameColumn, Single)
Addition(DataFrameColumn, UInt16)
Addition(DataFrameColumn, UInt32)
Addition(DataFrameColumn, UInt64)
Addition(Decimal, DataFrameColumn)
Addition(Double, DataFrameColumn)
Addition(Int16, DataFrameColumn)
Addition(Int32, DataFrameColumn)
Addition(Int64, DataFrameColumn)
Addition(SByte, DataFrameColumn)
Addition(Single, DataFrameColumn)
Addition(UInt16, DataFrameColumn)
Addition(UInt32, DataFrameColumn)
Addition(UInt64, DataFrameColumn)
BitwiseAnd(Boolean, DataFrameColumn)
BitwiseAnd(DataFrameColumn, Boolean)
BitwiseAnd(DataFrameColumn, DataFrameColumn)
BitwiseOr(Boolean, DataFrameColumn)
BitwiseOr(DataFrameColumn, Boolean)
BitwiseOr(DataFrameColumn, DataFrameColumn)
Division(Byte, DataFrameColumn)
Division(DataFrameColumn, Byte)
Division(DataFrameColumn, DataFrameColumn)
Division(DataFrameColumn, Decimal)
Division(DataFrameColumn, Double)
Division(DataFrameColumn, Int16)
Division(DataFrameColumn, Int32)
Division(DataFrameColumn, Int64)
Division(DataFrameColumn, SByte)
Division(DataFrameColumn, Single)
Division(DataFrameColumn, UInt16)
Division(DataFrameColumn, UInt32)
Division(DataFrameColumn, UInt64)
Division(Decimal, DataFrameColumn)
Division(Double, DataFrameColumn)
Division(Int16, DataFrameColumn)
Division(Int32, DataFrameColumn)
Division(Int64, DataFrameColumn)
Division(SByte, DataFrameColumn)
Division(Single, DataFrameColumn)
Division(UInt16, DataFrameColumn)
Division(UInt32, DataFrameColumn)
Division(UInt64, DataFrameColumn)
ExclusiveOr(Boolean, DataFrameColumn)
ExclusiveOr(DataFrameColumn, Boolean)
ExclusiveOr(DataFrameColumn, DataFrameColumn)
LeftShift(DataFrameColumn, Int32)
Modulus(Byte, DataFrameColumn)
Modulus(DataFrameColumn, Byte)
Modulus(DataFrameColumn, DataFrameColumn)
Modulus(DataFrameColumn, Decimal)
Modulus(DataFrameColumn, Double)
Modulus(DataFrameColumn, Int16)
Modulus(DataFrameColumn, Int32)
Modulus(DataFrameColumn, Int64)
Modulus(DataFrameColumn, SByte)
Modulus(DataFrameColumn, Single)
Modulus(DataFrameColumn, UInt16)
Modulus(DataFrameColumn, UInt32)
Modulus(DataFrameColumn, UInt64)
Modulus(Decimal, DataFrameColumn)
Modulus(Double, DataFrameColumn)
Modulus(Int16, DataFrameColumn)
Modulus(Int32, DataFrameColumn)
Modulus(Int64, DataFrameColumn)
Modulus(SByte, DataFrameColumn)
Modulus(Single, DataFrameColumn)
Modulus(UInt16, DataFrameColumn)
Modulus(UInt32, DataFrameColumn)
Modulus(UInt64, DataFrameColumn)
Multiply(Byte, DataFrameColumn)
Multiply(DataFrameColumn, Byte)
Multiply(DataFrameColumn, DataFrameColumn)
Multiply(DataFrameColumn, Decimal)
Multiply(DataFrameColumn, Double)
Multiply(DataFrameColumn, Int16)
Multiply(DataFrameColumn, Int32)
Multiply(DataFrameColumn, Int64)
Multiply(DataFrameColumn, SByte)
Multiply(DataFrameColumn, Single)
Multiply(DataFrameColumn, UInt16)
Multiply(DataFrameColumn, UInt32)
Multiply(DataFrameColumn, UInt64)
Multiply(Decimal, DataFrameColumn)
Multiply(Double, DataFrameColumn)
Multiply(Int16, DataFrameColumn)
Multiply(Int32, DataFrameColumn)
Multiply(Int64, DataFrameColumn)
Multiply(SByte, DataFrameColumn)
Multiply(Single, DataFrameColumn)
Multiply(UInt16, DataFrameColumn)
Multiply(UInt32, DataFrameColumn)
Multiply(UInt64, DataFrameColumn)
RightShift(DataFrameColumn, Int32)
Subtraction(Byte, DataFrameColumn)
Subtraction(DataFrameColumn, Byte)
Subtraction(DataFrameColumn, DataFrameColumn)
Subtraction(DataFrameColumn, Decimal)
Subtraction(DataFrameColumn, Double)
Subtraction(DataFrameColumn, Int16)
Subtraction(DataFrameColumn, Int32)
Subtraction(DataFrameColumn, Int64)
Subtraction(DataFrameColumn, SByte)
Subtraction(DataFrameColumn, Single)
Subtraction(DataFrameColumn, UInt16)
Subtraction(DataFrameColumn, UInt32)
Subtraction(DataFrameColumn, UInt64)
Subtraction(Decimal, DataFrameColumn)
Subtraction(Double, DataFrameColumn)
Subtraction(Int16, DataFrameColumn)
Subtraction(Int32, DataFrameColumn)
Subtraction(Int64, DataFrameColumn)
Subtraction(SByte, DataFrameColumn)
Subtraction(Single, DataFrameColumn)
Subtraction(UInt16, DataFrameColumn)
Subtraction(UInt32, DataFrameColumn)
Subtraction(UInt64, DataFrameColumn)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Applies to