Packages

class Column extends Expression

Linear Supertypes
Expression, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Column
  2. Expression
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def %(value: Any): Column

    Modulus.

  4. def &&(value: Any): Column

    And.

  5. def *(value: Any): Column

    Divide.

  6. def +(value: Any): Column

    Plus.

  7. def -(value: Any): Column

    Minus.

  8. def /(value: Any): Column

    Divide.

  9. def <(value: Any): Column

    LessThan.

  10. def <=(value: Any): Column

    LessThanEqualTo.

  11. def <>(value: Any): Column

    NotEqualTo.

  12. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def ===(value: Any): Column

    EqualTo.

  14. def >(value: Any): Column

    GreaterThan.

  15. def >=(value: Any): Column

    GreaterThanEqualTo.

  16. val _ptr: Long
    Attributes
    protected[polars]
    Definition Classes
    Expression
  17. def abs(): Column

    Compute the absolute value of each value.

    Compute the absolute value of each value.

    Definition Classes
    Expression
  18. def alias(name: String): Column

    Rename the expression.

    Rename the expression.

    name

    new name for the expression

    Definition Classes
    Expression
  19. def all(): Column

    Return whether all of the values in the boolean expression are true (ignoring nulls).

    Return whether all of the values in the boolean expression are true (ignoring nulls).

    Definition Classes
    Expression
  20. def all(ignoreNulls: Boolean): Column

    Return whether all of the values in the boolean expression are true.

    Return whether all of the values in the boolean expression are true.

    ignoreNulls

    whether to ignore null values

    Definition Classes
    Expression
  21. def and(other: Any): Column
  22. def any(): Column

    Return whether any of the values in the boolean expression are true (ignoring nulls).

    Return whether any of the values in the boolean expression are true (ignoring nulls).

    Definition Classes
    Expression
  23. def any(ignoreNulls: Boolean): Column

    Return whether any of the values in the boolean expression are true.

    Return whether any of the values in the boolean expression are true.

    ignoreNulls

    whether to ignore null values

    Definition Classes
    Expression
  24. def approxNUnique(): Column

    Return the approximate number of unique values.

    Return the approximate number of unique values.

    Definition Classes
    Expression
  25. def arccos(): Column

    Compute the inverse cosine (arccosine) of each value, returning radians.

    Compute the inverse cosine (arccosine) of each value, returning radians.

    Definition Classes
    Expression
  26. def arccosh(): Column

    Compute the inverse hyperbolic cosine of each value.

    Compute the inverse hyperbolic cosine of each value.

    Definition Classes
    Expression
  27. def arcsin(): Column

    Compute the inverse sine (arcsine) of each value, returning radians.

    Compute the inverse sine (arcsine) of each value, returning radians.

    Definition Classes
    Expression
  28. def arcsinh(): Column

    Compute the inverse hyperbolic sine of each value.

    Compute the inverse hyperbolic sine of each value.

    Definition Classes
    Expression
  29. def arctan(): Column

    Compute the inverse tangent (arctangent) of each value, returning radians.

    Compute the inverse tangent (arctangent) of each value, returning radians.

    Definition Classes
    Expression
  30. def arctanh(): Column

    Compute the inverse hyperbolic tangent of each value.

    Compute the inverse hyperbolic tangent of each value.

    Definition Classes
    Expression
  31. def argMax(): Column

    Return the index of the maximum value.

    Return the index of the maximum value.

    Definition Classes
    Expression
  32. def argMin(): Column

    Return the index of the minimal value.

    Return the index of the minimal value.

    Definition Classes
    Expression
  33. def argSort(): Column

    Return the indices that would sort the values ascending.

    Return the indices that would sort the values ascending.

    Definition Classes
    Expression
  34. def argSort(descending: Boolean, nullsLast: Boolean): Column

    Return the indices that would sort the values.

    Return the indices that would sort the values.

    descending

    whether to sort descending

    nullsLast

    whether to put nulls last

    Definition Classes
    Expression
  35. def as(name: String): Column

    Alias for alias.

    Alias for alias.

    name

    new name for the expression

    Definition Classes
    Expression
  36. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  37. def cast(dataType: DataType): Column

    Cast the expression to the specified DataType.

    Cast the expression to the specified DataType.

    dataType

    target data type

    Definition Classes
    Expression
  38. def cbrt(): Column

    Compute the cube root of each value.

    Compute the cube root of each value.

    Definition Classes
    Expression
  39. def ceil(): Column

    Round the values up to the nearest integer (ceiling).

    Round the values up to the nearest integer (ceiling).

    Definition Classes
    Expression
  40. def clip(lower: Expression, upper: Expression): Column

    Clip (limit) the values to the inclusive range defined by the given bounds.

    Clip (limit) the values to the inclusive range defined by the given bounds.

    Values below lower become lower; values above upper become upper. Null values are preserved.

    lower

    lower bound expression

    upper

    upper bound expression

    Definition Classes
    Expression
  41. def clipMax(upper: Expression): Column

    Clip (limit) the values so none exceed the given upper bound.

    Clip (limit) the values so none exceed the given upper bound.

    Values above upper become upper; lower values are unchanged. Null values are preserved.

    upper

    upper bound expression

    Definition Classes
    Expression
  42. def clipMin(lower: Expression): Column

    Clip (limit) the values so none fall below the given lower bound.

    Clip (limit) the values so none fall below the given lower bound.

    Values below lower become lower; higher values are unchanged. Null values are preserved.

    lower

    lower bound expression

    Definition Classes
    Expression
  43. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  44. def close(): Unit
    Definition Classes
    Expression → AutoCloseable
  45. def cos(): Column

    Compute the cosine of each value (in radians).

    Compute the cosine of each value (in radians).

    Definition Classes
    Expression
  46. def cosh(): Column

    Compute the hyperbolic cosine of each value.

    Compute the hyperbolic cosine of each value.

    Definition Classes
    Expression
  47. def cot(): Column

    Compute the cotangent of each value (in radians).

    Compute the cotangent of each value (in radians).

    Definition Classes
    Expression
  48. def count(): Column

    Count the non-null values.

    Count the non-null values.

    Definition Classes
    Expression
  49. def cumSum(): Column

    Compute the cumulative sum of the values.

    Compute the cumulative sum of the values.

    Definition Classes
    Expression
  50. def cumSum(reverse: Boolean): Column

    Compute the cumulative sum of the values.

    Compute the cumulative sum of the values.

    reverse

    whether to compute the sum in reverse order

    Definition Classes
    Expression
  51. def degrees(): Column

    Convert each value from radians to degrees.

    Convert each value from radians to degrees.

    Definition Classes
    Expression
  52. def diff(): Column

    Compute the difference between each value and the immediately preceding one.

    Compute the difference between each value and the immediately preceding one.

    Definition Classes
    Expression
  53. def diff(n: Long): Column

    Compute the first discrete difference between consecutive values, ignoring nulls.

    Compute the first discrete difference between consecutive values, ignoring nulls.

    n

    number of positions to look back when computing the difference

    Definition Classes
    Expression
  54. def diff(n: Long, nullBehavior: String): Column

    Compute the first discrete difference between consecutive values.

    Compute the first discrete difference between consecutive values.

    n

    number of positions to look back when computing the difference

    nullBehavior

    how to handle nulls: "ignore" (default) keeps them, "drop" removes them before differencing

    Definition Classes
    Expression
  55. def divide(other: Any): Column
  56. def dropNans(): Column

    Drop NaN values from this expression.

    Drop NaN values from this expression.

    Definition Classes
    Expression
  57. def dropNulls(): Column

    Drop null values from this expression.

    Drop null values from this expression.

    Definition Classes
    Expression
  58. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def equalTo(other: Any): Column
  60. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  61. def exp(): Column

    Compute the exponential (e raised to the value) of each value.

    Compute the exponential (e raised to the value) of each value.

    Definition Classes
    Expression
  62. def finalize(): Unit
    Definition Classes
    Expression → AnyRef
  63. def first(): Column

    Reduce groups to the first value.

    Reduce groups to the first value.

    Definition Classes
    Expression
  64. def floor(): Column

    Round the values down to the nearest integer (floor).

    Round the values down to the nearest integer (floor).

    Definition Classes
    Expression
  65. def floorDiv(other: Expression): Column

    Floor-divide the values by another expression.

    Floor-divide the values by another expression.

    other

    divisor expression

    Definition Classes
    Expression
  66. def gatherEvery(n: Long): Column

    Gather every nth element.

    Gather every nth element.

    n

    gather elements with this step size (must be >= 1)

    Definition Classes
    Expression
  67. def gatherEvery(n: Long, offset: Long): Column

    Gather every nth element, starting at the offset.

    Gather every nth element, starting at the offset.

    n

    gather elements with this step size (must be >= 1)

    offset

    start gathering from this index (default is 0, must be >= 0)

    Definition Classes
    Expression
  68. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  69. def greaterThan(other: Any): Column
  70. def greaterThanEqualTo(other: Any): Column
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  72. def head(): Column

    Get the first 10 elements of this expression.

    Get the first 10 elements of this expression.

    Definition Classes
    Expression
  73. def head(n: Long): Column

    Get the first n elements of this expression.

    Get the first n elements of this expression.

    n

    number of elements to return

    Definition Classes
    Expression
  74. def isBetween(lower: Any, upper: Any): Column

    Check if the expression values are between the lower and upper bounds (inclusive).

    Check if the expression values are between the lower and upper bounds (inclusive).

    lower

    lower bound

    upper

    upper bound

    Definition Classes
    Expression
  75. def isDuplicated: Column

    Mask indicating duplicated values in this expression.

    Mask indicating duplicated values in this expression.

    Definition Classes
    Expression
  76. def isEmpty: Column

    Check if the expression is empty.

    Check if the expression is empty.

    This is a whole-column aggregation returning a single boolean scalar, not a per-element check. Null values are not ignored.

    Definition Classes
    Expression
  77. def isFinite: Column

    Check if the values in this expression are finite.

    Check if the values in this expression are finite.

    Definition Classes
    Expression
  78. def isFirstDistinct: Column

    Mask indicating the first occurrence of distinct values in this expression.

    Mask indicating the first occurrence of distinct values in this expression.

    Definition Classes
    Expression
  79. def isIn(values: Array[Any]): Column

    Check if the expression values are present in the provided array.

    Check if the expression values are present in the provided array.

    values

    array of values to match

    Definition Classes
    Expression
  80. def isInfinite: Column

    Check if the values in this expression are infinite.

    Check if the values in this expression are infinite.

    Definition Classes
    Expression
  81. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  82. def isLastDistinct: Column

    Mask indicating the last occurrence of distinct values in this expression.

    Mask indicating the last occurrence of distinct values in this expression.

    Definition Classes
    Expression
  83. def isNaN: Column

    Is NaN.

  84. def isNotNaN: Column

    Is Not NaN.

  85. def isNotNull: Column

    Is Not Null.

  86. def isNull: Column

    Is Null.

  87. def isUnique: Column

    Mask indicating unique values in this expression.

    Mask indicating unique values in this expression.

    Definition Classes
    Expression
  88. def kurtosis(): Column

    Compute the kurtosis of the values with Fisher's definition and bias correction.

    Compute the kurtosis of the values with Fisher's definition and bias correction.

    Definition Classes
    Expression
  89. def kurtosis(fisher: Boolean, bias: Boolean): Column

    Compute the kurtosis of the values.

    Compute the kurtosis of the values.

    fisher

    whether to use Fisher's definition of kurtosis (default is true)

    bias

    whether to correct for statistical bias (default is true)

    Definition Classes
    Expression
  90. def last(): Column

    Reduce groups to the last value.

    Reduce groups to the last value.

    Definition Classes
    Expression
  91. def len(): Column

    Return the number of elements (including nulls).

    Return the number of elements (including nulls).

    Definition Classes
    Expression
  92. def lessThan(other: Any): Column
  93. def lessThanEqualTo(other: Any): Column
  94. def like(pattern: String): Column

    Check if the string expression matches the given SQL-like wildcard pattern.

    Check if the string expression matches the given SQL-like wildcard pattern.

    pattern

    SQL-like pattern (e.g. "ap%")

    Definition Classes
    Expression
  95. def limit(): Column

    Alias for head.

    Alias for head.

    Definition Classes
    Expression
  96. def limit(n: Long): Column

    Alias for head.

    Alias for head.

    n

    number of elements to return

    Definition Classes
    Expression
  97. def log(): Column

    Compute the natural logarithm (base e) of each value.

    Compute the natural logarithm (base e) of each value.

    Definition Classes
    Expression
  98. def log(base: Double): Column

    Compute the logarithm of each value to the given base.

    Compute the logarithm of each value to the given base.

    base

    logarithm base

    Definition Classes
    Expression
  99. def log10(): Column

    Compute the base-10 logarithm of each value.

    Compute the base-10 logarithm of each value.

    Definition Classes
    Expression
  100. def log1p(): Column

    Compute the natural logarithm of one plus each value (log(1 + x)).

    Compute the natural logarithm of one plus each value (log(1 + x)).

    Definition Classes
    Expression
  101. def max(): Column

    Reduce groups to the maximum value.

    Reduce groups to the maximum value.

    Definition Classes
    Expression
  102. def mean(): Column

    Reduce groups to the mean value.

    Reduce groups to the mean value.

    Definition Classes
    Expression
  103. def median(): Column

    Reduce groups to the median value.

    Reduce groups to the median value.

    Definition Classes
    Expression
  104. def min(): Column

    Reduce groups to the minimal value.

    Reduce groups to the minimal value.

    Definition Classes
    Expression
  105. def minus(other: Any): Column
  106. def mod(other: Any): Column
  107. def mode(): Column

    Return the most frequent values in this expression.

    Return the most frequent values in this expression.

    Definition Classes
    Expression
  108. def multiply(other: Any): Column
  109. def nUnique(): Column

    Return the number of unique values.

    Return the number of unique values.

    Definition Classes
    Expression
  110. def name: ColumnNameNameSpace

    Returns the namespace accessor for expression name manipulation.

    Returns the namespace accessor for expression name manipulation.

    Definition Classes
    Expression
  111. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  112. def neg(): Column

    Negate the values (unary minus).

    Negate the values (unary minus).

    Definition Classes
    Expression
  113. def notEqualTo(other: Any): Column
  114. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  115. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  116. def nullCount(): Column

    Return the number of null values.

    Return the number of null values.

    Definition Classes
    Expression
  117. def or(other: Any): Column
  118. def pctChange(): Column

    Compute the fractional change between consecutive values.

    Compute the fractional change between consecutive values.

    Definition Classes
    Expression
  119. def pctChange(n: Long): Column

    Compute the fractional change between each value and the one n positions before it.

    Compute the fractional change between each value and the one n positions before it.

    n

    number of positions to look back

    Definition Classes
    Expression
  120. def plus(other: Any): Column
  121. def pow(exponent: Double): Column

    Raise the values to the given power.

    Raise the values to the given power.

    exponent

    exponent to raise each value to

    Definition Classes
    Expression
  122. def product(): Column

    Reduce groups to the product of all the values.

    Reduce groups to the product of all the values.

    Definition Classes
    Expression
  123. def quantile(q: Double): Column

    Return the quantile value of the values with "nearest" interpolation.

    Return the quantile value of the values with "nearest" interpolation.

    q

    quantile value (must be between 0.0 and 1.0)

    Definition Classes
    Expression
  124. def quantile(q: Double, method: String): Column

    Return the quantile value of the values.

    Return the quantile value of the values.

    q

    quantile value (must be between 0.0 and 1.0)

    method

    interpolation method (e.g. "nearest", "linear")

    Definition Classes
    Expression
  125. def radians(): Column

    Convert each value from degrees to radians.

    Convert each value from degrees to radians.

    Definition Classes
    Expression
  126. def reinterpret(): Column

    Reinterpret the bits of an integer column as a signed integer of the same width.

    Reinterpret the bits of an integer column as a signed integer of the same width.

    Definition Classes
    Expression
  127. def reinterpret(signed: Boolean): Column

    Reinterpret the bits of an integer column as another integer type of the same width.

    Reinterpret the bits of an integer column as another integer type of the same width.

    signed

    whether to reinterpret as a signed integer; false reinterprets as unsigned

    Definition Classes
    Expression
  128. def reverse(): Column

    Reverse the order of elements in this expression.

    Reverse the order of elements in this expression.

    Definition Classes
    Expression
  129. def round(): Column

    Round the values to the nearest whole number.

    Round the values to the nearest whole number.

    Definition Classes
    Expression
  130. def round(decimals: Int): Column

    Round the values to the given number of decimal places.

    Round the values to the given number of decimal places.

    Rounding uses the round-half-to-even (banker's rounding) rule.

    decimals

    number of decimal places to round to (must be >= 0)

    Definition Classes
    Expression
  131. def roundSigFigs(digits: Int): Column

    Round the values to the given number of significant figures.

    Round the values to the given number of significant figures.

    digits

    number of significant figures to keep (must be >= 1)

    Definition Classes
    Expression
  132. def shift(): Column

    Shift elements in this expression by 1 position.

    Shift elements in this expression by 1 position.

    Definition Classes
    Expression
  133. def shift(periods: Long): Column

    Shift elements in this expression by periods.

    Shift elements in this expression by periods.

    periods

    number of positions to shift

    Definition Classes
    Expression
  134. def sign(): Column

    Return the sign of each value: -1 for negatives, 1 for positives, 0 for zero.

    Return the sign of each value: -1 for negatives, 1 for positives, 0 for zero.

    Null values are preserved and NaN maps to NaN.

    Definition Classes
    Expression
  135. def sin(): Column

    Compute the sine of each value (in radians).

    Compute the sine of each value (in radians).

    Definition Classes
    Expression
  136. def sinh(): Column

    Compute the hyperbolic sine of each value.

    Compute the hyperbolic sine of each value.

    Definition Classes
    Expression
  137. def skew(): Column

    Compute the skewness of the values with bias correction.

    Compute the skewness of the values with bias correction.

    Definition Classes
    Expression
  138. def skew(bias: Boolean): Column

    Compute the skewness of the values.

    Compute the skewness of the values.

    bias

    whether to correct for statistical bias

    Definition Classes
    Expression
  139. def slice(offset: Long, length: Long): Column

    Get a slice of this expression.

    Get a slice of this expression.

    offset

    start index of the slice (negative indexing is supported)

    length

    length of the slice

    Definition Classes
    Expression
  140. def sqrt(): Column

    Compute the square root of each value.

    Compute the square root of each value.

    Definition Classes
    Expression
  141. def std(): Column

    Standard deviation of the values with ddof = 1.

    Standard deviation of the values with ddof = 1.

    Definition Classes
    Expression
  142. def std(ddof: Int): Column

    Standard deviation of the values.

    Standard deviation of the values.

    ddof

    Delta Degrees of Freedom (default is 1, must be between 0 and 255)

    Definition Classes
    Expression
  143. def str: ColumnStrNameSpace

    Returns the namespace accessor for string-related expressions.

    Returns the namespace accessor for string-related expressions.

    Definition Classes
    Expression
  144. def sum(): Column

    Reduce groups to the sum of all the values.

    Reduce groups to the sum of all the values.

    Definition Classes
    Expression
  145. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  146. def tail(): Column

    Get the last 10 elements of this expression.

    Get the last 10 elements of this expression.

    Definition Classes
    Expression
  147. def tail(n: Long): Column

    Get the last n elements of this expression.

    Get the last n elements of this expression.

    n

    number of elements to return

    Definition Classes
    Expression
  148. def tan(): Column

    Compute the tangent of each value (in radians).

    Compute the tangent of each value (in radians).

    Definition Classes
    Expression
  149. def tanh(): Column

    Compute the hyperbolic tangent of each value.

    Compute the hyperbolic tangent of each value.

    Definition Classes
    Expression
  150. def toPhysical(): Column

    Cast the values to their underlying physical representation.

    Cast the values to their underlying physical representation.

    This exposes the physical storage type of logical dtypes (for example, the integer codes backing a categorical, or the primitive backing a temporal type).

    Definition Classes
    Expression
  151. def toString(): String
    Definition Classes
    AnyRef → Any
  152. def truncate(): Column

    Truncate the values toward zero, dropping any fractional part.

    Truncate the values toward zero, dropping any fractional part.

    Definition Classes
    Expression
  153. def truncate(decimals: Int): Column

    Truncate the values to the given number of decimal places, rounding toward zero.

    Truncate the values to the given number of decimal places, rounding toward zero.

    decimals

    number of decimal places to keep (must be >= 0)

    Definition Classes
    Expression
  154. def unary_!: Column

    Not.

  155. def unary_-: Column

    Negate the values (unary minus).

    Negate the values (unary minus).

    Definition Classes
    Expression
  156. def unique(): Column

    Get unique values from this expression.

    Get unique values from this expression.

    Definition Classes
    Expression
  157. def unique(maintainOrder: Boolean): Column

    Get unique values from this expression.

    Get unique values from this expression.

    maintainOrder

    whether to maintain the original order of elements

    Definition Classes
    Expression
  158. def uniqueCounts(): Column

    Return the counts of unique values in this expression.

    Return the counts of unique values in this expression.

    Definition Classes
    Expression
  159. def var(): Column

    Variance of the values with ddof = 1.

    Variance of the values with ddof = 1.

    Definition Classes
    Expression
  160. def var(ddof: Int): Column

    Variance of the values.

    Variance of the values.

    ddof

    Delta Degrees of Freedom (default is 1, must be between 0 and 255)

    Definition Classes
    Expression
  161. def variance(): Column

    Variance of the values with ddof = 1.

    Variance of the values with ddof = 1.

    Definition Classes
    Expression
  162. def variance(ddof: Int): Column

    Variance of the values.

    Variance of the values.

    ddof

    Delta Degrees of Freedom (default is 1)

    Definition Classes
    Expression
  163. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  164. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  165. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  166. def ||(value: Any): Column

    And.

Inherited from Expression

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped