Packages

t

com.nvidia.spark.rapids

GpuRowBasedUserDefinedFunction

trait GpuRowBasedUserDefinedFunction extends Expression with GpuExpression with ShimExpression with UserDefinedExpression with Serializable with Logging

Execute a row based UDF efficiently by pulling back only the columns the UDF needs to host and do the processing on CPU.

Linear Supertypes
Logging, Serializable, Serializable, UserDefinedExpression, ShimExpression, GpuExpression, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Known Subclasses
GpuRowBasedHiveGenericUDF, GpuRowBasedHiveSimpleUDF, GpuRowBasedHiveUDFBase, GpuRowBasedScalaUDF
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuRowBasedUserDefinedFunction
  2. Logging
  3. Serializable
  4. Serializable
  5. UserDefinedExpression
  6. ShimExpression
  7. GpuExpression
  8. Expression
  9. TreeNode
  10. TreePatternBits
  11. Product
  12. Equals
  13. AnyRef
  14. 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 val checkNull: Boolean

    True if the UDF needs null check when converting input columns to rows

  3. abstract def children: Seq[Expression]
    Definition Classes
    TreeNode
  4. abstract def dataType: DataType
    Definition Classes
    Expression
  5. abstract def evaluateRow(childrenRow: InternalRow): Any

    The row based function of the UDF.

    The row based function of the UDF.

    Attributes
    protected
  6. abstract val name: String

    name of the UDF function

    name of the UDF function

    Definition Classes
    GpuRowBasedUserDefinedFunction → UserDefinedExpression
  7. abstract def nullable: Boolean
    Definition Classes
    Expression
  8. abstract def productArity: Int
    Definition Classes
    Product
  9. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  10. abstract val udfDeterministic: Boolean

    True if the UDF is deterministic

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 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.

    Definition Classes
    GpuRowBasedUserDefinedFunction → GpuExpression
  16. 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.

    Definition Classes
    GpuExpression
  17. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  18. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  19. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  20. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  21. 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

    Definition Classes
    GpuExpression
  22. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  23. lazy val deterministic: Boolean
    Definition Classes
    GpuRowBasedUserDefinedFunction → Expression
  24. 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.

    Definition Classes
    GpuExpression
  25. def disableTieredProjectCombine: Boolean

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

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

    Definition Classes
    GpuExpression
  26. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  30. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  33. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  34. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  35. def foldable: Boolean
    Definition Classes
    Expression
  36. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  37. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  38. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  39. 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
  40. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  42. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  43. def hasSideEffects: Boolean

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

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

    Definition Classes
    GpuRowBasedUserDefinedFunction → GpuExpression
  44. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  45. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  50. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  51. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  52. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  53. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  66. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  67. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  68. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  69. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. def nodeName: String
    Definition Classes
    TreeNode
  72. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  75. def numberedTreeString: String
    Definition Classes
    TreeNode
  76. val origin: Origin
    Definition Classes
    TreeNode
  77. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  78. def p(number: Int): Expression
    Definition Classes
    TreeNode
  79. def prettyJson: String
    Definition Classes
    TreeNode
  80. def prettyName: String
    Definition Classes
    Expression
  81. def productIterator: Iterator[Any]
    Definition Classes
    Product
  82. def productPrefix: String
    Definition Classes
    Product
  83. def references: AttributeSet
    Definition Classes
    Expression
  84. lazy val resolved: Boolean
    Definition Classes
    Expression
  85. 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.
    Definition Classes
    GpuExpression
  86. 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.

    Definition Classes
    GpuRowBasedUserDefinedFunction → GpuExpression
  87. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  88. def semanticHash(): Int
    Definition Classes
    Expression
  89. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  90. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  91. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  92. def sql: String
    Definition Classes
    Expression
  93. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  94. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  95. def toJSON: String
    Definition Classes
    TreeNode
  96. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  97. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  98. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  99. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  100. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  101. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  102. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  103. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  104. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  105. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  106. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  107. final def treeString: String
    Definition Classes
    TreeNode
  108. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  109. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  110. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  111. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  112. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  114. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  115. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from UserDefinedExpression

Inherited from ShimExpression

Inherited from GpuExpression

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped