CodegenContext

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. final var INPUT_ROW: String

   

   The variable name of the input row in generated code.

5. final val JAVA_BOOLEAN: String("boolean")

   

6. final val JAVA_BYTE: String("byte")

   

7. final val JAVA_DOUBLE: String("double")

   

8. final val JAVA_FLOAT: String("float")

   

9. final val JAVA_INT: String("int")

   

10. final val JAVA_LONG: String("long")

    

11. final val JAVA_SHORT: String("short")

    

12. def addBufferedState(dataType: DataType, variableName: String, initCode: String): ExprCode

    

    Add buffer variable which stores data coming from an InternalRow.

    Add buffer variable which stores data coming from an InternalRow. This methods guarantees that the variable is safely stored, which is important for (potentially) byte array backed data types like: UTF8String, ArrayData, MapData & InternalRow.

13. def addMutableState(javaType: String, variableName: String, initCode: String): Unit

    

14. def addNewFunction(funcName: String, funcCode: String): Unit

    

15. def addPartitionInitializationStatement(statement: String): Unit

    

16. def addReferenceObj(name: String, obj: Any, className: String = null): String

    

    Add an object to references, create a class member to access it.

    Add an object to references, create a class member to access it.

    Returns the name of class member.

17. def addReferenceObj(obj: Any): String

    

    Add an object to references.

    Add an object to references.

    Returns the code to access it.

    This is for minor objects not to store the object into field but refer it from the references field at the time of use because number of fields in class is limited so we should reduce it.

18. val addedFunctions: Map[String, String]

    

    Holding all the functions those will be added into generated class.

19. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

20. def boxedType(dt: DataType): String

    

21. def boxedType(jt: String): String

    

    Returns the boxed type in Java.

22. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

23. var copyResult: Boolean

    

    Whether should we copy the result rows or not.

    Whether should we copy the result rows or not.

    If any operator inside WholeStageCodegen generate multiple rows from a single row (for example, Join), this should be true.

    If an operator starts a new pipeline, this should be reset to false before calling consume().

24. var currentVars: Seq[ExprCode]

    

    Holding a list of generated columns as input of current operator, will be used by BoundReference to generate code.

25. def declareAddedFunctions(): String

    

26. def declareMutableStates(): String

    

27. def defaultValue(dt: DataType): String

    

28. def defaultValue(jt: String): String

    

    Returns the representation of default value for a given Java Type.

29. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

30. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

31. val equivalentExpressions: EquivalentExpressions

    

    Holds expressions that are equivalent.

    Holds expressions that are equivalent. Used to perform subexpression elimination during codegen.

    For expressions that appear more than once, generate additional code to prevent recomputing the value.

    For example, consider two expression generated from this SQL statement: SELECT (col1 + col2), (col1 + col2) / col3.

    equivalentExpressions will match the tree containing col1 + col2 and it will only be evaluated once.

32. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

33. def freshName(name: String): String

    

    Returns a term name that is unique within this instance of a CodegenContext.

34. var freshNamePrefix: String

    

    A prefix used to generate fresh name.

35. def genComp(dataType: DataType, c1: String, c2: String): String

    

    Generates code for comparing two expressions.

    Generates code for comparing two expressions.

    dataType

    data type of the expressions

    c1

    name of the variable of expression 1's output

    c2

    name of the variable of expression 2's output

36. def genEqual(dataType: DataType, c1: String, c2: String): String

    

    Generates code for equal expression in Java.

37. def genGreater(dataType: DataType, c1: String, c2: String): String

    

    Generates code for greater of two expressions.

    Generates code for greater of two expressions.

    dataType

    data type of the expressions

    c1

    name of the variable of expression 1's output

    c2

    name of the variable of expression 2's output

38. def generateExpressions(expressions: Seq[Expression], doSubexpressionElimination: Boolean = false): Seq[ExprCode]

    

    Generates code for expressions.

    Generates code for expressions. If doSubexpressionElimination is true, subexpression elimination will be performed. Subexpression elimination assumes that the code will for each expression will be combined in the expressions order.

39. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

40. def getPlaceHolderToComments(): Map[String, String]

    

    get a map of the pair of a place holder and a corresponding comment

41. def getValue(batch: String, row: String, dataType: DataType, ordinal: Int): String

    

    Returns the specialized code to access a value from a column vector for a given DataType.

42. def getValue(input: String, dataType: DataType, ordinal: String): String

    

    Returns the specialized code to access a value from inputRow at ordinal.

43. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

44. def initMutableStates(): String

    

45. def initPartition(): String

    

46. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

47. def isPrimitiveType(dt: DataType): Boolean

    

48. def isPrimitiveType(jt: String): Boolean

    

    Returns true if the Java type has a special accessor and setter in InternalRow.

49. def javaType(dt: DataType): String

    

    Returns the Java type for a DataType.

50. val mutableStates: ArrayBuffer[(String, String, String)]

    

    Holding expressions' mutable states like MonotonicallyIncreasingID.count as a 3-tuple: java type, variable name, code to init it.

    Holding expressions' mutable states like MonotonicallyIncreasingID.count as a 3-tuple: java type, variable name, code to init it. As an example, ("int", "count", "count = 0;") will produce code:

    private int count;

    as a member variable, and add

    count = 0;

    to the constructor.

    They will be kept as member variables in generated classes like SpecificProjection.

51. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

52. final def notify(): Unit

    

    Definition Classes

    AnyRef

53. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

54. def nullSafeExec(nullable: Boolean, isNull: String)(execute: String): String

    

    Generates code to do null safe execution, i.e.

    Generates code to do null safe execution, i.e. only execute the code when the input is not null by adding null check if necessary.

    nullable

    used to decide whether we should add null check or not.

    isNull

    the code to check if the input is null.

    execute

    the code that should only be executed when the input is not null.

55. val partitionInitializationStatements: ArrayBuffer[String]

    

    Code statements to initialize states that depend on the partition index.

    Code statements to initialize states that depend on the partition index. An integer partitionIndex will be made available within the scope.

56. def primitiveTypeName(dt: DataType): String

    

57. def primitiveTypeName(jt: String): String

    

    Returns the name used in accessor and setter for a Java primitive type.

58. val primitiveTypes: Seq[String]

    

    List of java data types that have special accessors and setters in InternalRow.

59. val references: ArrayBuffer[Any]

    

    Holding a list of objects that could be used passed into generated class.

60. def registerComment(text: ⇒ String): String

    

    Register a comment and return the corresponding place holder

61. def setColumn(row: String, dataType: DataType, ordinal: Int, value: String): String

    

    Returns the code to update a column in Row for a given DataType.

62. def setValue(batch: String, row: String, dataType: DataType, ordinal: Int, value: String): String

    

    Returns the specialized code to set a given value in a column vector for a given DataType.

63. def splitExpressions(expressions: Seq[String], funcName: String, arguments: Seq[(String, String)], returnType: String = "void", makeSplitFunction: (String) ⇒ String = identity, foldFunctions: (Seq[String]) ⇒ String = _.mkString("", ";\n", ";")): String

    

    Splits the generated code of expressions into multiple functions, because function has 64kb code size limit in JVM

    Splits the generated code of expressions into multiple functions, because function has 64kb code size limit in JVM

    expressions

    the codes to evaluate expressions.

    funcName

    the split function name base.

    arguments

    the list of (type, name) of the arguments of the split function.

    returnType

    the return type of the split function.

    makeSplitFunction

    makes split function body, e.g. add preparation or cleanup.

    foldFunctions

    folds the split function calls.

64. def splitExpressions(row: String, expressions: Seq[String]): String

    

    Splits the generated code of expressions into multiple functions, because function has 64kb code size limit in JVM

    Splits the generated code of expressions into multiple functions, because function has 64kb code size limit in JVM

    row

    the variable name of row that is used by expressions

    expressions

    the codes to evaluate expressions.

65. val subExprEliminationExprs: HashMap[Expression, SubExprEliminationState]

    

66. val subexprFunctions: ArrayBuffer[String]

    

67. def subexpressionEliminationForWholeStageCodegen(expressions: Seq[Expression]): SubExprCodes

    

    Checks and sets up the state and codegen for subexpression elimination.

    Checks and sets up the state and codegen for subexpression elimination. This finds the common subexpressions, generates the code snippets that evaluate those expressions and populates the mapping of common subexpressions to the generated code snippets. The generated code snippets will be returned and should be inserted into generated codes before these common subexpressions actually are used first time.

68. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

69. def toString(): String

    

    Definition Classes

    AnyRef → Any

70. def updateColumn(batch: String, row: String, dataType: DataType, ordinal: Int, ev: ExprCode, nullable: Boolean): String

    

    Returns the specialized code to set a given value in a column vector for a given DataType that could potentially be nullable.

71. def updateColumn(row: String, dataType: DataType, ordinal: Int, ev: ExprCode, nullable: Boolean, isVectorized: Boolean = false): String

    

    Update a column in MutableRow from ExprCode.

    Update a column in MutableRow from ExprCode.

    isVectorized

    True if the underlying row is of type ColumnarBatch.Row, false otherwise

72. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

73. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

74. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

75. def withSubExprEliminationExprs(newSubExprEliminationExprs: Map[Expression, SubExprEliminationState])(f: ⇒ Seq[ExprCode]): Seq[ExprCode]

    

    Perform a function which generates a sequence of ExprCodes with a given mapping between expressions and common expressions, instead of using the mapping in current context.