Packages

c

org.apache.spark.sql.rapids

GpuRowBasedScalaUDF

case class GpuRowBasedScalaUDF(sparkFunc: AnyRef, dataType: DataType, children: Seq[Expression], inputEncoders: Seq[Option[ExpressionEncoder[_]]], outputEncoder: Option[ExpressionEncoder[_]], udfName: Option[String], nullable: Boolean, udfDeterministic: Boolean) extends Expression with GpuRowBasedUserDefinedFunction with Product with Serializable

Linear Supertypes
GpuRowBasedUserDefinedFunction, Logging, Serializable, Serializable, UserDefinedExpression, ShimExpression, GpuExpression, Arm, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuRowBasedScalaUDF
  2. GpuRowBasedUserDefinedFunction
  3. Logging
  4. Serializable
  5. Serializable
  6. UserDefinedExpression
  7. ShimExpression
  8. GpuExpression
  9. Arm
  10. Expression
  11. TreeNode
  12. TreePatternBits
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuRowBasedScalaUDF(sparkFunc: AnyRef, dataType: DataType, children: Seq[Expression], inputEncoders: Seq[Option[ExpressionEncoder[_]]], outputEncoder: Option[ExpressionEncoder[_]], udfName: Option[String], nullable: Boolean, udfDeterministic: Boolean)

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. val checkNull: Boolean

    Need nulls check when there are array types with nulls in the input.

    Need nulls check when there are array types with nulls in the input. This is for https://github.com/NVIDIA/spark-rapids/issues/3942.

    Definition Classes
    GpuRowBasedScalaUDF → GpuRowBasedUserDefinedFunction
  11. val children: Seq[Expression]
    Definition Classes
    GpuRowBasedScalaUDF → TreeNode
  12. def childrenResolved: Boolean
    Definition Classes
    Expression
  13. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  14. def closeOnExcept[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  15. def closeOnExcept[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  16. def closeOnExcept[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  17. def closeOnExcept[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  18. def closeOnExcept[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, closing the resource only if an exception occurs

    Executes the provided code block, closing the resource only if an exception occurs

    Definition Classes
    Arm
  19. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  20. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  21. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  22. def columnarEval(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 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
  23. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  24. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  25. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  26. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  27. 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
  28. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  29. def createInputConverter(i: Int, dataType: DataType): (Any) ⇒ Any

    Create the converter which converts the catalyst data type to the scala data type.

    Create the converter which converts the catalyst data type to the scala data type. This converter will be used for the UDF input type conversion. We use CatalystTypeConverters to create the converter for:

    • UDF which doesn't provide inputEncoders, e.g., untyped Scala UDF and Java UDF
    • type which isn't supported by ExpressionEncoder, e.g., Any
    • primitive types, in order to use identity for better performance For other cases like case class, Option[T], we use ExpressionEncoder instead since CatalystTypeConverters doesn't support these data types.
    i

    the index of the child

    dataType

    the output data type of the i-th child

    returns

    the converter

  30. val dataType: DataType
    Definition Classes
    GpuRowBasedScalaUDF → Expression
  31. lazy val deterministic: Boolean
    Definition Classes
    GpuRowBasedUserDefinedFunction → Expression
  32. 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
  33. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  36. final def evaluateRow(childrenRow: InternalRow): Any

    The input row consists of only child columns.

    The input row consists of only child columns.

    Attributes
    protected
    Definition Classes
    GpuRowBasedScalaUDF → GpuRowBasedUserDefinedFunction
  37. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  38. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  39. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  40. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  41. def foldable: Boolean
    Definition Classes
    Expression
  42. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  43. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  44. def freeOnExcept[T <: RapidsBuffer, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Definition Classes
    Arm
  45. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  46. 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
  47. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  49. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  50. 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
  51. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  53. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  55. val inputEncoders: Seq[Option[ExpressionEncoder[_]]]
  56. lazy val inputPrimitives: Seq[Boolean]

    The analyzer should be aware of Scala primitive types so as to make the UDF return null if there is any null input value of these types.

    The analyzer should be aware of Scala primitive types so as to make the UDF return null if there is any null input value of these types. On the other hand, Java UDFs can only have boxed types, thus this will return Nil(has same effect with all false) and analyzer will skip null-handling on them.

  57. def inputTypes: Seq[AbstractDataType]

    The expected input types of this UDF, used to perform type coercion.

    The expected input types of this UDF, used to perform type coercion. If we do not want to perform coercion, simply use "Nil". Note that it would've been better to use Option of Seq[DataType] so we can use "None" as the case for no type coercion. However, that would require more refactoring of the codebase.

  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  60. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  62. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  63. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  76. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  77. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  78. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  79. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  80. val name: String

    name of the UDF function

    name of the UDF function

    Definition Classes
    GpuRowBasedScalaUDF → GpuRowBasedUserDefinedFunction → UserDefinedExpression
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. def nodeName: String
    Definition Classes
    TreeNode
  83. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  86. val nullable: Boolean
    Definition Classes
    GpuRowBasedScalaUDF → Expression
  87. def numberedTreeString: String
    Definition Classes
    TreeNode
  88. val origin: Origin
    Definition Classes
    TreeNode
  89. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  90. val outputEncoder: Option[ExpressionEncoder[_]]
  91. def p(number: Int): Expression
    Definition Classes
    TreeNode
  92. def prettyJson: String
    Definition Classes
    TreeNode
  93. def prettyName: String
    Definition Classes
    Expression
  94. def references: AttributeSet
    Definition Classes
    Expression
  95. lazy val resolved: Boolean
    Definition Classes
    Expression
  96. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  97. def semanticHash(): Int
    Definition Classes
    Expression
  98. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  99. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  100. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  101. val sparkFunc: AnyRef
  102. def sql: String
    Definition Classes
    Expression
  103. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  104. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  105. def toJSON: String
    Definition Classes
    TreeNode
  106. def toString(): String
    Definition Classes
    GpuRowBasedScalaUDF → Expression → TreeNode → AnyRef → Any
  107. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  108. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  109. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  110. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  111. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  112. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  113. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  114. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  115. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  116. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  117. final def treeString: String
    Definition Classes
    TreeNode
  118. val udfDeterministic: Boolean

    True if the UDF is deterministic

    True if the UDF is deterministic

    Definition Classes
    GpuRowBasedScalaUDF → GpuRowBasedUserDefinedFunction
  119. val udfName: Option[String]
  120. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  121. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  122. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  123. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  125. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  127. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode
  128. def withResource[T <: AutoCloseable, V](h: CloseableHolder[T])(block: (CloseableHolder[T]) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  129. def withResource[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block and then closes the array buffer of resources

    Executes the provided code block and then closes the array buffer of resources

    Definition Classes
    Arm
  130. def withResource[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block and then closes the array of resources

    Executes the provided code block and then closes the array of resources

    Definition Classes
    Arm
  131. def withResource[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block and then closes the sequence of resources

    Executes the provided code block and then closes the sequence of resources

    Definition Classes
    Arm
  132. def withResource[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block and then closes the Option[resource]

    Executes the provided code block and then closes the Option[resource]

    Definition Classes
    Arm
  133. def withResource[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  134. def withResourceIfAllowed[T, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the value if it is AutoCloseable

    Executes the provided code block and then closes the value if it is AutoCloseable

    Definition Classes
    Arm

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from GpuRowBasedUserDefinedFunction

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from UserDefinedExpression

Inherited from ShimExpression

Inherited from GpuExpression

Inherited from Arm

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped