Packages

t

com.nvidia.spark.rapids

GpuExpression

trait GpuExpression extends Expression

An Expression that cannot be evaluated in the traditional row-by-row sense (hence Unevaluable) but instead can be evaluated on an entire column batch at once.

Linear Supertypes
Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Known Subclasses
BatchedByKey, CoalesceGoal, CoalesceSizeGoal, CudfBinaryExpression, CudfBinaryOperator, CudfUnaryExpression, GpuAlias, GpuArrayExists, GpuArrayTransform, GpuArrayTransformBase, GpuAtLeastNNonNulls, GpuBinaryExpression, GpuBinaryExpressionArgsAnyScalar, GpuBinaryOperator, GpuBoundReference, GpuCaseWhen, GpuCast, GpuCheckOverflow, GpuCoalesce, GpuComplexTypeMergingExpression, GpuConditionalExpression, GpuDynamicPruningExpression, GpuExplode, GpuExplodeBase, GpuGenerator, GpuGetJsonObject, GpuGetJsonObjectLegacy, GpuHashPartitioningBase, GpuHigherOrderFunction, GpuIf, GpuInSet, GpuIsNan, GpuIsNotNull, GpuIsNull, GpuJsonTuple, GpuKnownFloatingPointNormalized, GpuKnownNotNull, GpuLambdaFunction, GpuLeafExpression, GpuLiteral, GpuMakeDecimal, GpuMapFilter, GpuMapSimpleHigherOrderFunction, GpuMonotonicallyIncreasingID, GpuNaNvl, GpuNamedLambdaVariable, GpuNansToNulls, GpuPosExplode, GpuPromotePrecision, GpuRangePartitioner, GpuReplicateRows, GpuRoundRobinPartitioning, GpuRowBasedUserDefinedFunction, GpuSimpleHigherOrderFunction, GpuSinglePartitioning, GpuSparkPartitionID, GpuString2TrimExpression, GpuTernaryExpression, GpuTernaryExpressionArgsAnyScalarScalar, GpuTernaryExpressionArgsScalarAnyScalar, GpuTransformKeys, GpuTransformValues, GpuUnaryExpression, GpuUnevaluable, GpuUnevaluableUnaryExpression, GpuUnscaledValue, GpuUserDefinedFunction, RequireSingleBatch, RequireSingleBatchWithFilter, TargetSize, GpuHashPartitioning, GpuRangePartitioning, GpuAggregateWindowFunction, GpuDenseRank, GpuLag, GpuLead, GpuOffsetWindowFunction, GpuPercentRank, GpuRank, GpuReplaceWindowFunction, GpuRowNumber, GpuRunningWindowFunction, GpuSpecialFrameBoundary, GpuSpecifiedWindowFrame, GpuUnboundedToUnboundedWindowAgg, GpuUnspecifiedFrame, GpuWindowExpression, GpuWindowFrame, GpuWindowFunction, GpuWindowSpecDefinition, GpuHiveGenericUDF, GpuHiveSimpleUDF, GpuHiveUDFBase, GpuRowBasedHiveGenericUDF, GpuRowBasedHiveSimpleUDF, GpuRowBasedHiveUDFBase, BasePad, CudfBinaryArithmetic, CudfBinaryComparison, CudfBinaryMathExpression, CudfBinaryPredicateWithSideEffect, CudfUnaryMathExpression, GpuAbs, GpuAcos, GpuAcoshCompat, GpuAcoshImproved, GpuAdd, GpuAddBase, GpuAnd, GpuArrayBinaryLike, GpuArrayContains, GpuArrayExcept, GpuArrayIntersect, GpuArrayMax, GpuArrayMin, GpuArrayRemove, GpuArrayRepeat, GpuArrayUnion, GpuArraysOverlap, GpuArraysZip, GpuAsin, GpuAsinhCompat, GpuAsinhImproved, GpuAtan, GpuAtanh, GpuBRound, GpuBasicArrayMax, GpuBasicArrayMin, GpuBitLength, GpuBitwiseAnd, GpuBitwiseNot, GpuBitwiseOr, GpuBitwiseXor, GpuCbrt, GpuCeil, GpuConcat, GpuConcatWs, GpuContains, GpuConv, GpuCos, GpuCosh, GpuCot, GpuCreateArray, GpuCreateMap, GpuCreateNamedStruct, GpuDateAdd, GpuDateAddInterval, GpuDateDiff, GpuDateFormatClass, GpuDateMathBase, GpuDateSub, GpuDateUnaryExpression, GpuDayOfMonth, GpuDayOfWeek, GpuDayOfYear, GpuDecimalDivide, GpuDecimalDivideBase, GpuDecimalMultiply, GpuDecimalMultiplyBase, GpuDivModLike, GpuDivide, GpuElementAt, GpuEndsWith, GpuEqualNullSafe, GpuEqualTo, GpuEqualToNoNans, GpuExp, GpuExpm1, GpuFlattenArray, GpuFloatArrayMax, GpuFloatArrayMin, GpuFloor, GpuFormatNumber, GpuFromUTCTimestamp, GpuFromUnixTime, GpuGetArrayItem, GpuGetArrayStructFields, GpuGetMapValue, GpuGetStructField, GpuGetTimestamp, GpuGreaterThan, GpuGreaterThanOrEqual, GpuGreatest, GpuGreatestLeastBase, GpuHashExpression, GpuHour, GpuHypot, GpuInitCap, GpuInputFileBlockLength, GpuInputFileBlockStart, GpuInputFileName, GpuIntegralDivide, GpuIntegralDivideParent, GpuJsonToStructs, GpuLastDay, GpuLeast, GpuLength, GpuLessThan, GpuLessThanOrEqual, GpuLike, GpuLog, GpuLogarithm, GpuLower, GpuMapConcat, GpuMapEntries, GpuMapKeys, GpuMapValues, GpuMd5, GpuMicrosToTimestamp, GpuMillisToTimestamp, GpuMinute, GpuMonth, GpuMultiply, GpuMurmur3Hash, GpuNormalizeNaNAndZero, GpuNot, GpuNumberToTimestampUnaryExpression, GpuOctetLength, GpuOr, GpuParseUrl, GpuPmod, GpuPmodBase, GpuPow, GpuPreciseTimestampConversion, GpuQuarter, GpuRLike, GpuRaiseError, GpuRegExpExtract, GpuRegExpExtractAll, GpuRegExpReplace, GpuRegExpReplaceWithBackref, GpuRegExpTernaryBase, GpuRemainder, GpuRemainderBase, GpuReverse, GpuRint, GpuRound, GpuRoundBase, GpuRowBasedScalaUDF, GpuScalaUDF, GpuScalarSubquery, GpuSecond, GpuSecondsToTimestamp, GpuSequence, GpuShiftBase, GpuShiftLeft, GpuShiftRight, GpuShiftRightUnsigned, GpuSignum, GpuSin, GpuSinh, GpuSize, GpuSortArray, GpuSqrt, GpuStartsWith, GpuStringInstr, GpuStringLPad, GpuStringLocate, GpuStringRPad, GpuStringRepeat, GpuStringReplace, GpuStringSplit, GpuStringToMap, GpuStringTranslate, GpuStringTrim, GpuStringTrimLeft, GpuStringTrimRight, GpuStructsToJson, GpuSubstring, GpuSubstringIndex, GpuSubtract, GpuSubtractBase, GpuTan, GpuTanh, GpuTimeMath, GpuTimeUnaryExpression, GpuToDegrees, GpuToRadians, GpuToTimestamp, GpuToUTCTimestamp, GpuToUnixTimestamp, GpuUnaryMathExpression, GpuUnaryMinus, GpuUnaryPositive, GpuUnaryString2StringExpression, GpuUnixTimestamp, GpuUpper, GpuEmpty2Null, GpuWeekDay, GpuXxHash64, GpuYear, ApproxPercentileFromTDigestExpr, GpuAggregateExpression, GpuAggregateFunction, GpuApproximatePercentile, GpuAssembleSumChunks, GpuAverage, GpuBasicAverage, GpuBasicDecimalAverage, GpuBasicDecimalSum, GpuBasicMax, GpuBasicMin, GpuBasicSum, GpuCheckOverflowAfterSum, GpuCollectBase, GpuCollectList, GpuCollectSet, GpuCount, GpuCreateHistogramIfValid, GpuDecimal128Average, GpuDecimal128Sum, GpuDecimalAverage, GpuDecimalAverageBase, GpuDecimalSum, GpuDecimalSumHighDigits, GpuExtractChunk32, GpuFirst, GpuFloatMax, GpuFloatMin, GpuLast, GpuM2, GpuMax, GpuMin, GpuNthValue, GpuPercentile, GpuPercentileDefault, GpuPercentileEvaluation, GpuPercentileWithFrequency, GpuPivotFirst, GpuStddevPop, GpuStddevSamp, GpuSum, GpuVariancePop, GpuVarianceSamp, WindowStddevSamp, WrappedAggFunction, GpuRand, GpuPythonFunction, GpuPythonUDAF, GpuPythonUDF, GpuAscii, GpuTimeAdd, GpuHilbertLongIndex, GpuInterleaveBits, GpuPartitionerExpr
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuExpression
  2. Expression
  3. TreeNode
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def children: Seq[Expression]
    Definition Classes
    TreeNode
  3. abstract def columnarEval(batch: ColumnarBatch): GpuColumnVector

    Returns the result of evaluating this expression on the entire ColumnarBatch.

    Returns the result of evaluating this expression on the entire ColumnarBatch. The result of calling this is a GpuColumnVector.

    By convention any GpuColumnVector returned by columnarEval is owned by the caller and will need to be closed by them. This can happen by putting it into a ColumnarBatch and closing the batch or by closing the vector directly if it is a temporary value.

  4. abstract def dataType: DataType
    Definition Classes
    Expression
  5. abstract def nullable: Boolean
    Definition Classes
    Expression
  6. abstract def productArity: Int
    Definition Classes
    Product
  7. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  5. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  6. def asCode: String
    Definition Classes
    TreeNode
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. lazy val canonicalized: Expression
    Definition Classes
    GpuExpression → Expression
  9. def checkInputDataTypes(): TypeCheckResult
    Definition Classes
    Expression
  10. def childrenResolved: Boolean
    Definition Classes
    Expression
  11. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  12. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  13. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  14. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  15. def columnarEvalAny(batch: ColumnarBatch): Any

    Returns the result of evaluating this expression on the entire ColumnarBatch.

    Returns the result of evaluating this expression on the entire ColumnarBatch. The result of calling this may be a single GpuColumnVector or a scalar value. Scalar values typically happen if they are a part of the expression i.e. col("a") + 100. In this case the 100 is a literal that Add would have to be able to handle.

    By convention any AutoCloseable returned by columnarEvalAny is owned by the caller and will need to be closed by them.

  16. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  17. def convertToAst(numFirstTableColumns: Int): AstExpression

    Build an equivalent representation of this expression in a cudf AST.

    Build an equivalent representation of this expression in a cudf AST.

    numFirstTableColumns

    number of columns in the leftmost input table. Spark places the columns of all inputs in a single sequence, while cudf AST uses an explicit table reference to make column indices unique. This parameter helps translate input column references from Spark's single sequence into cudf's separate sequences.

    returns

    top node of the equivalent AST

  18. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  19. lazy val deterministic: Boolean
    Definition Classes
    Expression
  20. def disableCoalesceUntilInput(): Boolean

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them.

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them. These are for things like getting the input file name. Which for spark is stored in a thread local variable which means we have to jump through some hoops to make this work.

  21. def disableTieredProjectCombine: Boolean

    If this returns true then tiered project will stop looking to combine expressions when this is seen.

  22. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  26. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  29. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  30. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  31. def foldable: Boolean
    Definition Classes
    Expression
  32. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  33. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  34. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  35. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  38. def hasSideEffects: Boolean

    Could evaluating this expression cause side-effects, such as throwing an exception?

  39. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  40. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  43. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  44. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  45. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  46. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def nodeName: String
    Definition Classes
    TreeNode
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. def numberedTreeString: String
    Definition Classes
    TreeNode
  52. val origin: Origin
    Definition Classes
    TreeNode
  53. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  54. def p(number: Int): Expression
    Definition Classes
    TreeNode
  55. def prettyJson: String
    Definition Classes
    TreeNode
  56. def prettyName: String
    Definition Classes
    Expression
  57. def productIterator: Iterator[Any]
    Definition Classes
    Product
  58. def productPrefix: String
    Definition Classes
    Product
  59. def references: AttributeSet
    Definition Classes
    Expression
  60. lazy val resolved: Boolean
    Definition Classes
    Expression
  61. lazy val retryable: Boolean

    true means this expression can be used inside a retry block, otherwise false.

    true means this expression can be used inside a retry block, otherwise false. An expression is retryable when

    • it is deterministic, or
    • when being non-deterministic, it is a Retryable and its children are all retryable.
  62. val selfNonDeterministic: Boolean

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children.

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children. An expression is actually a tree, and deterministic being false means there is at least one tree node is non-deterministic, but we need to know the exact nodes which are non-deterministic to check if it implements the Retryable.

    Default to false because Spark checks only children by default in Expression. So it is non-deterministic iff it has non-deterministic children.

    NOTE When overriding "deterministic", this should be taken care of.

  63. def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  64. def semanticHash(): Int
    Definition Classes
    Expression
  65. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  66. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  67. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  68. def sql: String
    Definition Classes
    Expression
  69. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toJSON: String
    Definition Classes
    TreeNode
  72. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  73. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  74. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  75. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  76. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  77. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  78. final def treeString: String
    Definition Classes
    TreeNode
  79. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  80. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  81. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  85. def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped