# BinaryArithmetic

### Related Docs: object BinaryArithmetic | package expressions

#### abstract class BinaryArithmetic extends BinaryOperator

Linear Supertypes
Known Subclasses
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. BinaryArithmetic
2. BinaryOperator
3. ExpectsInputTypes
4. BinaryExpression
5. Expression
6. TreeNode
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 inputType: AbstractDataType

Expected input type from both left/right child expressions, similar to the ImplicitCastInputTypes trait.

Expected input type from both left/right child expressions, similar to the ImplicitCastInputTypes trait.

Definition Classes
BinaryOperator
3. #### abstract def left: Expression

Definition Classes
BinaryExpression
4. #### abstract def productArity: Int

Definition Classes
Product
5. #### abstract def productElement(n: Int): Any

Definition Classes
Product
6. #### abstract def right: Expression

Definition Classes
BinaryExpression
7. #### abstract def symbol: String

Definition Classes
BinaryOperator

### 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[_]

Returns the tree node at the specified number, used primarily for interactive debugging.

Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.

Note that this cannot return BaseType because logical plan's plan node might return physical plan for innerChildren, e.g. in-memory relation logical plan node has a reference to the physical plan node it is referencing.

Definition Classes
TreeNode
5. #### def argString: String

Returns a string representing the arguments to this node, minus any children

Returns a string representing the arguments to this node, minus any children

Definition Classes
TreeNode
6. #### def asCode: String

Returns a 'scala code' representation of this `TreeNode` and its children.

Returns a 'scala code' representation of this `TreeNode` and its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure' `TreeNodes` that only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.

Definition Classes
TreeNode
7. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
8. #### lazy val canonicalized: Expression

Returns an expression where a best effort attempt has been made to transform `this` in a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.) See Canonicalize for more details.

Returns an expression where a best effort attempt has been made to transform `this` in a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.) See Canonicalize for more details.

`deterministic` expressions where `this.canonicalized == other.canonicalized` will always evaluate to the same result.

Definition Classes
Expression
9. #### def checkInputDataTypes(): TypeCheckResult

Checks the input data types, returns `TypeCheckResult.success` if it's valid, or returns a `TypeCheckResult` with an error message if invalid.

Checks the input data types, returns `TypeCheckResult.success` if it's valid, or returns a `TypeCheckResult` with an error message if invalid. Note: it's not valid to call this method until `childrenResolved == true`.

Definition Classes
BinaryOperatorExpectsInputTypesExpression
10. #### final def children: Seq[Expression]

Returns a Seq of the children of this node.

Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization

Definition Classes
BinaryExpressionTreeNode
11. #### def childrenResolved: Boolean

Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

Definition Classes
Expression
12. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
13. #### def collect[B](pf: PartialFunction[Expression, B]): Seq[B]

Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

Definition Classes
TreeNode
14. #### def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]

Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

Definition Classes
TreeNode
15. #### def collectLeaves(): Seq[Expression]

Returns a Seq containing the leaves in this tree.

Returns a Seq containing the leaves in this tree.

Definition Classes
TreeNode
16. #### lazy val containsChild: Set[TreeNode[_]]

Definition Classes
TreeNode
17. #### def dataType: DataType

Returns the DataType of the result of evaluating this expression.

Returns the DataType of the result of evaluating this expression. It is invalid to query the dataType of an unresolved expression (i.e., when `resolved` == false).

Definition Classes
BinaryArithmeticExpression
18. #### def decimalMethod: String

Name of the function for this expression on a Decimal type.

19. #### def defineCodeGen(ctx: CodegenContext, ev: ExprCode, f: (String, String) ⇒ String): ExprCode

Short hand for generating binary evaluation code.

Short hand for generating binary evaluation code. If either of the sub-expressions is null, the result of this computation is assumed to be null.

f

accepts two variable names and returns Java code to compute the output.

Attributes
protected
Definition Classes
BinaryExpression
20. #### def deterministic: Boolean

Returns true when the current expression always return the same result for fixed inputs from children.

Returns true when the current expression always return the same result for fixed inputs from children.

Note that this means that an expression should be considered as non-deterministic if: - it relies on some mutable internal state, or - it relies on some implicit input that is not part of the children expression list. - it has non-deterministic child or children.

An example would be `SparkPartitionID` that relies on the partition id returned by TaskContext. By default leaf expressions are deterministic as Nil.forall(_.deterministic) returns true.

Definition Classes
Expression
21. #### def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode

Returns Java source code that can be compiled to evaluate this expression.

Returns Java source code that can be compiled to evaluate this expression. The default behavior is to call the eval method of the expression. Concrete expression implementations should override this to do actual code generation.

ctx

a CodegenContext

ev

an ExprCode with unique terms.

returns

an ExprCode containing the Java source code to generate the given expression

Definition Classes
BinaryArithmeticExpression
22. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
23. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
24. #### def eval(input: InternalRow): Any

Default behavior of evaluation according to the default nullability of BinaryExpression.

Default behavior of evaluation according to the default nullability of BinaryExpression. If subclass of BinaryExpression override nullable, probably should also override this.

Definition Classes
BinaryExpressionExpression
25. #### def fastEquals(other: TreeNode[_]): Boolean

Faster version of equality which short-circuits when two treeNodes are the same instance.

Faster version of equality which short-circuits when two treeNodes are the same instance. We don't just override Object.equals, as doing so prevents the scala compiler from generating case class `equals` methods

Definition Classes
TreeNode
26. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
27. #### def find(f: (Expression) ⇒ Boolean): Option[Expression]

Find the first TreeNode that satisfies the condition specified by `f`.

Find the first TreeNode that satisfies the condition specified by `f`. The condition is recursively applied to this node and all of its children (pre-order).

Definition Classes
TreeNode
28. #### def flatArguments: Iterator[Any]

Attributes
protected
Definition Classes
Expression
29. #### def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]

Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

Definition Classes
TreeNode
30. #### def foldable: Boolean

Returns true when an expression is a candidate for static evaluation before the query is executed.

Returns true when an expression is a candidate for static evaluation before the query is executed.

The following conditions are used to determine suitability for constant folding:

Definition Classes
BinaryExpressionExpression
31. #### def foreach(f: (Expression) ⇒ Unit): Unit

Runs the given function on this node and then recursively on children.

Runs the given function on this node and then recursively on children.

f

the function to be applied to each node in the tree.

Definition Classes
TreeNode
32. #### def foreachUp(f: (Expression) ⇒ Unit): Unit

Runs the given function recursively on children then on this node.

Runs the given function recursively on children then on this node.

f

the function to be applied to each node in the tree.

Definition Classes
TreeNode
33. #### def genCode(ctx: CodegenContext): ExprCode

Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.

Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.

ctx

a CodegenContext

returns

ExprCode

Definition Classes
Expression
34. #### def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String = ""): StringBuilder

Appends the string represent of this node and its children to the given StringBuilder.

Appends the string represent of this node and its children to the given StringBuilder.

The `i`-th element in `lastChildren` indicates whether the ancestor of the current node at depth `i + 1` is the last child of its own parent node. The depth of the root node is 0, and `lastChildren` for the root node should be empty.

Note that this traversal (numbering) order must be the same as getNodeNumbered.

Definition Classes
TreeNode
35. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
36. #### def hashCode(): Int

Definition Classes
TreeNode → AnyRef → Any
37. #### def innerChildren: Seq[TreeNode[_]]

All the nodes that should be shown as a inner nested tree of this node.

All the nodes that should be shown as a inner nested tree of this node. For example, this can be used to show sub-queries.

Attributes
protected
Definition Classes
TreeNode
38. #### def inputTypes: Seq[AbstractDataType]

Expected input types from child expressions.

Expected input types from child expressions. The i-th position in the returned seq indicates the type requirement for the i-th child.

The possible values at each position are: 1. a specific data type, e.g. LongType, StringType. 2. a non-leaf abstract data type, e.g. NumericType, IntegralType, FractionalType.

Definition Classes
BinaryOperatorExpectsInputTypes
39. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
40. #### def jsonFields: List[JField]

Attributes
protected
Definition Classes
TreeNode
41. #### def makeCopy(newArgs: Array[AnyRef]): Expression

Creates a copy of this type of tree node after a transformation.

Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.

newArgs

the new product arguments.

Definition Classes
TreeNode
42. #### def map[A](f: (Expression) ⇒ A): Seq[A]

Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

f

the function to be applied.

Definition Classes
TreeNode
43. #### def mapChildren(f: (Expression) ⇒ Expression): Expression

Returns a copy of this node where `f` has been applied to all the nodes children.

Returns a copy of this node where `f` has been applied to all the nodes children.

Definition Classes
TreeNode
44. #### def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

Efficient alternative to `productIterator.map(f).toArray`.

Efficient alternative to `productIterator.map(f).toArray`.

Attributes
protected
Definition Classes
TreeNode
45. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
46. #### def nodeName: String

Returns the name of this type of TreeNode.

Returns the name of this type of TreeNode. Defaults to the class name. Note that we remove the "Exec" suffix for physical operators here.

Definition Classes
TreeNode
47. #### final def notify(): Unit

Definition Classes
AnyRef
48. #### final def notifyAll(): Unit

Definition Classes
AnyRef
49. #### def nullSafeCodeGen(ctx: CodegenContext, ev: ExprCode, f: (String, String) ⇒ String): ExprCode

Short hand for generating binary evaluation code.

Short hand for generating binary evaluation code. If either of the sub-expressions is null, the result of this computation is assumed to be null.

f

function that accepts the 2 non-null evaluation result names of children and returns Java code to compute the output.

Attributes
protected
Definition Classes
BinaryExpression
50. #### def nullSafeEval(input1: Any, input2: Any): Any

Called by default eval implementation.

Called by default eval implementation. If subclass of BinaryExpression keep the default nullability, they can override this method to save null-check code. If we need full control of evaluation process, we should override eval.

Attributes
protected
Definition Classes
BinaryExpression
51. #### def nullable: Boolean

Definition Classes
BinaryExpressionExpression
52. #### def numberedTreeString: String

Returns a string representation of the nodes in this tree, where each operator is numbered.

Returns a string representation of the nodes in this tree, where each operator is numbered. The numbers can be used with TreeNode.apply to easily access specific subtrees.

The numbers are based on depth-first traversal of the tree (with innerChildren traversed first before children).

Definition Classes
TreeNode
53. #### val origin: Origin

Definition Classes
TreeNode
54. #### def otherCopyArgs: Seq[AnyRef]

Args to the constructor that should be copied, but not transformed.

Args to the constructor that should be copied, but not transformed. These are appended to the transformed args automatically by makeCopy

Attributes
protected
Definition Classes
TreeNode
55. #### def p(number: Int): Expression

Returns the tree node at the specified number, used primarily for interactive debugging.

Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.

This is a variant of apply that returns the node as BaseType (if the type matches).

Definition Classes
TreeNode
56. #### def prettyJson: String

Definition Classes
TreeNode
57. #### def prettyName: String

Returns a user-facing string representation of this expression's name.

Returns a user-facing string representation of this expression's name. This should usually match the name of the function in SQL.

Definition Classes
Expression
58. #### def productIterator: Iterator[Any]

Definition Classes
Product
59. #### def productPrefix: String

Definition Classes
Product
60. #### def references: AttributeSet

Definition Classes
Expression
61. #### lazy val resolved: Boolean

Returns `true` if this expression and all its children have been resolved to a specific schema and input data types checking passed, and `false` if it still contains any unresolved placeholders or has data types mismatch.

Returns `true` if this expression and all its children have been resolved to a specific schema and input data types checking passed, and `false` if it still contains any unresolved placeholders or has data types mismatch. Implementations of expressions should override this if the resolution of this type of expression involves more than just the resolution of its children and type checking.

Definition Classes
BinaryArithmeticExpression
62. #### def semanticEquals(other: Expression): Boolean

Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e.

Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e. capitalization of names in attributes may be different).

See Canonicalize for more details.

Definition Classes
Expression
63. #### def semanticHash(): Int

Returns a `hashCode` for the calculation performed by this expression.

Returns a `hashCode` for the calculation performed by this expression. Unlike the standard `hashCode`, an attempt has been made to eliminate cosmetic differences.

See Canonicalize for more details.

Definition Classes
Expression
64. #### def simpleString: String

ONE line description of this node.

ONE line description of this node.

Definition Classes
ExpressionTreeNode
65. #### def sql: String

Returns SQL representation of this expression.

Returns SQL representation of this expression. For expressions extending NonSQLExpression, this method may return an arbitrary user facing string.

Definition Classes
BinaryOperatorExpression
66. #### def sqlOperator: String

Definition Classes
BinaryOperator
67. #### def stringArgs: Iterator[Any]

The arguments that should be included in the arg string.

The arguments that should be included in the arg string. Defaults to the `productIterator`.

Attributes
protected
Definition Classes
TreeNode
68. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
69. #### def toJSON: String

Definition Classes
TreeNode
70. #### def toString(): String

Definition Classes
BinaryOperatorExpressionTreeNode → AnyRef → Any
71. #### def transform(rule: PartialFunction[Expression, Expression]): Expression

Returns a copy of this node where `rule` has been recursively applied to the tree.

Returns a copy of this node where `rule` has been recursively applied to the tree. When `rule` does not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.

rule

the function use to transform this nodes children

Definition Classes
TreeNode
72. #### def transformDown(rule: PartialFunction[Expression, Expression]): Expression

Returns a copy of this node where `rule` has been recursively applied to it and all of its children (pre-order).

Returns a copy of this node where `rule` has been recursively applied to it and all of its children (pre-order). When `rule` does not apply to a given node it is left unchanged.

rule

the function used to transform this nodes children

Definition Classes
TreeNode
73. #### def transformUp(rule: PartialFunction[Expression, Expression]): Expression

Returns a copy of this node where `rule` has been recursively applied first to all of its children and then itself (post-order).

Returns a copy of this node where `rule` has been recursively applied first to all of its children and then itself (post-order). When `rule` does not apply to a given node, it is left unchanged.

rule

the function use to transform this nodes children

Definition Classes
TreeNode
74. #### def treeString(verbose: Boolean): String

Definition Classes
TreeNode
75. #### def treeString: String

Returns a string representation of the nodes in this tree

Returns a string representation of the nodes in this tree

Definition Classes
TreeNode
76. #### final def verboseString: String

Definition Classes
ExpressionTreeNode
77. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
78. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
79. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
80. #### def withNewChildren(newChildren: Seq[Expression]): Expression

Returns a copy of this node with the children replaced.

Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

Definition Classes
TreeNode