# UnaryMathExpression

### Related Doc: package expressions

#### abstract class UnaryMathExpression extends UnaryExpression with Serializable with ImplicitCastInputTypes

A unary expression specifically for math functions. Math Functions expect a specific type of input format, therefore these functions extend `ExpectsInputTypes`.

Linear Supertypes
ImplicitCastInputTypes, ExpectsInputTypes, Serializable, Serializable, UnaryExpression, Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. UnaryMathExpression
2. ImplicitCastInputTypes
3. ExpectsInputTypes
4. Serializable
5. Serializable
6. UnaryExpression
7. Expression
8. TreeNode
9. Product
10. Equals
11. AnyRef
12. Any
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Instance Constructors

1. #### new UnaryMathExpression(f: (Double) ⇒ Double, name: String)

f

The math function.

name

The short name of the function

### Abstract Value Members

1. #### abstract def canEqual(that: Any): Boolean

Definition Classes
Equals
2. #### abstract def child: Expression

Definition Classes
UnaryExpression
3. #### abstract def productArity: Int

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

Definition Classes
Product

### 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): Expression

Returns the tree node at the specified number.

Returns the tree node at the specified number. Numbers for each node can be found in the numberedTreeString.

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. #### 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
ExpectsInputTypesExpression
9. #### 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
UnaryExpressionTreeNode
10. #### 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
11. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
12. #### 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
13. #### 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
14. #### lazy val containsChild: Set[TreeNode[_]]

Definition Classes
TreeNode
15. #### 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
UnaryMathExpressionExpression
16. #### def defineCodeGen(ctx: CodeGenContext, ev: GeneratedExpressionCode, f: (String) ⇒ String): String

Called by unary expressions to generate a code block that returns null if its parent returns null, and if not not null, use `f` to generate the expression.

Called by unary expressions to generate a code block that returns null if its parent returns null, and if not not null, use `f` to generate the expression.

As an example, the following does a boolean inversion (i.e. NOT).

`defineCodeGen(ctx, ev, c => s"!(\$c)")`
f

function that accepts a variable name and returns Java code to compute the output.

Attributes
protected
Definition Classes
UnaryExpression
17. #### 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: - if it relies on some mutable internal state, or - if it relies on some implicit input that is not part of the children expression list. - if 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
18. #### final def eq(arg0: AnyRef): Boolean

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

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

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

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

Definition Classes
UnaryExpressionExpression
21. #### val f: (Double) ⇒ Double

The math function.

22. #### 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
23. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
24. #### 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
25. #### 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
26. #### 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
UnaryExpressionExpression
27. #### 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
28. #### 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

30. #### def gen(ctx: CodeGenContext): GeneratedExpressionCode

Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.

Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.

ctx

a CodeGenContext

returns

GeneratedExpressionCode

Definition Classes
Expression
31. #### def genCode(ctx: CodeGenContext, ev: GeneratedExpressionCode): String

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 GeneratedExpressionCode with unique terms.

returns

Java source code

Definition Classes
UnaryMathExpressionExpression
32. #### def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder): 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.

Attributes
protected
Definition Classes
TreeNode
33. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
34. #### def getNodeNumbered(number: trees.MutableInt): Expression

Attributes
protected
Definition Classes
TreeNode
35. #### def hashCode(): Int

Definition Classes
AnyRef → Any
36. #### 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
UnaryMathExpressionExpectsInputTypes
37. #### final def isInstanceOf[T0]: Boolean

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

Attributes
protected
Definition Classes
TreeNode
39. #### 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
40. #### 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
41. #### 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
42. #### final def ne(arg0: AnyRef): Boolean

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

Returns the name of this type of TreeNode.

Returns the name of this type of TreeNode. Defaults to the class name.

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

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

Definition Classes
AnyRef
46. #### def nullSafeCodeGen(ctx: CodeGenContext, ev: GeneratedExpressionCode, f: (String) ⇒ String): String

Called by unary expressions to generate a code block that returns null if its parent returns null, and if not not null, use `f` to generate the expression.

Called by unary expressions to generate a code block that returns null if its parent returns null, and if not not null, use `f` to generate the expression.

f

function that accepts the non-null evaluation result name of child and returns Java code to compute the output.

Attributes
protected
Definition Classes
UnaryExpression
47. #### def nullSafeEval(input: Any): Any

Called by default eval implementation.

Called by default eval implementation. If subclass of UnaryExpression 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
UnaryMathExpressionUnaryExpression

49. #### 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 apply to easily access specific subtrees.

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

Definition Classes
TreeNode
51. #### 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
52. #### def prettyJson: String

Definition Classes
TreeNode
53. #### 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
54. #### def prettyString: String

Returns a user-facing string representation of this expression, i.e.

Returns a user-facing string representation of this expression, i.e. does not have developer centric debugging information like the expression id.

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

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

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

Definition Classes
Expression
58. #### 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
Expression
59. #### 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).

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

Returns the hash for this expression.

Returns the hash for this expression. Expressions that compute the same result, even if they differ cosmetically should return the same hash.

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

String representation of this node without any children

String representation of this node without any children

Definition Classes
ExpressionTreeNode
62. #### 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
63. #### final def synchronized[T0](arg0: ⇒ T0): T0

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

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

Definition Classes
UnaryMathExpressionExpressionTreeNode → AnyRef → Any
66. #### 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
67. #### def transformChildren(rule: PartialFunction[Expression, Expression], nextOperation: (Expression, PartialFunction[Expression, Expression]) ⇒ Expression): Expression

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

Returns a copy of this node where `rule` has been recursively applied to all the children of this node. When `rule` does not apply to a given node it is left unchanged.

rule

the function used to transform this nodes children

Attributes
protected
Definition Classes
TreeNode
68. #### 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
69. #### 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
70. #### 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
71. #### final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
74. #### 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