Packages

t

com.nvidia.spark.rapids

GpuGenerator

trait GpuGenerator extends Expression with GpuUnevaluable

GPU overrides of Generator, corporate with GpuGenerateExec.

Linear Supertypes
GpuUnevaluable, GpuExpression, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Known Subclasses
GpuExplode, GpuExplodeBase, GpuJsonTuple, GpuPosExplode, GpuReplicateRows
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuGenerator
  2. GpuUnevaluable
  3. GpuExpression
  4. Expression
  5. TreeNode
  6. TreePatternBits
  7. Product
  8. Equals
  9. AnyRef
  10. 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 elementSchema: StructType

    The output element schema.

  4. abstract def generate(batches: Iterator[SpillableColumnarBatch], generatorOffset: Int, outer: Boolean): Iterator[ColumnarBatch]

    Apply generator to produce result ColumnarBatch from input batch.

    Apply generator to produce result ColumnarBatch from input batch.

    This is a specialized method for GPU runtime, which is called by GpuGenerateExec who owns the generator. The reason of creating a new method rather than implementing columnarEval is that generator is an integrated Table transformer instead of column transformer in terms of cuDF.

    batches

    iterator of spillable batches

    generatorOffset

    column offset of generator's input columns in inputBatch

    outer

    when true, each input row will be output at least once, even if the output of the given generator is empty.

    returns

    result ColumnarBatch

  5. abstract def inputSplitIndices(inputBatch: ColumnarBatch, generatorOffset: Int, outer: Boolean, targetSizeBytes: Long, maxRows: Int = Int.MaxValue): Array[Int]

    Compute split indices for generator's input batches.

    Compute split indices for generator's input batches.

    This is a specialized method for GPU runtime, which is called by GpuGenerateExec to split up input batches to reduce total memory cost during generating. It is necessary because most of generators may produce multiple records for each input record, which make output batch size much larger than input size.

    inputBatch

    projected input data, which ensures appending columns are ahead of generators' inputs. So, generators can distinguish them with an offset.

    generatorOffset

    column offset of generator's input columns in inputBatch

    outer

    when true, each input row will be output at least once, even if the output of the given generator is empty.

    targetSizeBytes

    the target number of bytes for a GPU batch, one of RapidsConf

    maxRows

    the target number of rows for a GPU batch, exposed for testing purposes.

    returns

    split indices of input batch

  6. abstract def productArity: Int
    Definition Classes
    Product
  7. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  8. abstract def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode

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. final 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
    GpuUnevaluable → GpuExpression
  16. final 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
    GpuUnevaluable → 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. def dataType: DataType
    Definition Classes
    GpuGenerator → Expression
  24. lazy val deterministic: Boolean
    Definition Classes
    Expression
  25. 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
  26. 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
  27. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  31. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  34. def fixedLenLazyArrayGenerate(inputIterator: Iterator[ColumnarBatch], boundLazyProjectList: Seq[Expression], boundOthersProjectList: Seq[Expression], outputSchema: Array[DataType], outer: Boolean, numOutputRows: GpuMetric, numOutputBatches: GpuMetric, opTime: GpuMetric): Iterator[ColumnarBatch]

    Optimized lazy generation interface which is specialized for fixed length array input.

    Optimized lazy generation interface which is specialized for fixed length array input.

    For some generators (like explode), it is possible to improve performance through lazy evaluation when input schema is fixed length array.

    inputIterator

    input iterator from child plan

    boundLazyProjectList

    lazy expressions bounded with child outputs

    boundOthersProjectList

    other required expressions bounded with child outputs

    outputSchema

    result schema of GpuGenerateExec

    outer

    when true, each input row will be output at least once, even if the output of the given generator is empty.

    numOutputRows

    Gpu spark metric of output rows

    numOutputBatches

    Gpu spark metric of output batches

    opTime

    Gpu spark metric of time on GPU by GpuGenerateExec

    returns

    result iterator

  35. def fixedLenLazyExpressions: Seq[Expression]

    Extract lazy expressions from generator if exists.

    Extract lazy expressions from generator if exists.

    This is a specialized method for GPU runtime, which is called by GpuGenerateExec to determine whether current generation plan can be executed with optimized lazy array generation or not.

    returns

    fixed length lazy expressions for generation. Nil value means no lazy expressions to extract, which indicates fixed length lazy array generation is unavailable.

  36. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  37. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  38. def foldable: Boolean
    Definition Classes
    GpuGenerator → Expression
  39. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  40. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  41. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  42. 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
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  45. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  46. 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
    GpuExpression
  47. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  48. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  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 makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  54. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  55. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  56. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  57. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  58. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def nodeName: String
    Definition Classes
    TreeNode
  60. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  61. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  62. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  63. def nullable: Boolean
    Definition Classes
    GpuGenerator → Expression
  64. def numberedTreeString: String
    Definition Classes
    TreeNode
  65. val origin: Origin
    Definition Classes
    TreeNode
  66. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  67. def p(number: Int): Expression
    Definition Classes
    TreeNode
  68. def prettyJson: String
    Definition Classes
    TreeNode
  69. def prettyName: String
    Definition Classes
    Expression
  70. def productIterator: Iterator[Any]
    Definition Classes
    Product
  71. def productPrefix: String
    Definition Classes
    Product
  72. def references: AttributeSet
    Definition Classes
    Expression
  73. lazy val resolved: Boolean
    Definition Classes
    Expression
  74. 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
  75. 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
    GpuExpression
  76. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  77. def semanticHash(): Int
    Definition Classes
    Expression
  78. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  79. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  80. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  81. def sql: String
    Definition Classes
    Expression
  82. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  83. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  84. def toJSON: String
    Definition Classes
    TreeNode
  85. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  86. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  87. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  88. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  89. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  90. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  91. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  92. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  93. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  94. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  95. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  96. final def treeString: String
    Definition Classes
    TreeNode
  97. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  98. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  99. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  100. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  103. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode

Inherited from GpuUnevaluable

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