/
Covariance.scala
140 lines (118 loc) · 4.88 KB
/
Covariance.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.spark.sql.catalyst.expressions.aggregate
import org.apache.spark.sql.catalyst.dsl.expressions._
import org.apache.spark.sql.catalyst.expressions._
import org.apache.spark.sql.catalyst.trees.BinaryLike
import org.apache.spark.sql.internal.SQLConf
import org.apache.spark.sql.types._
/**
* Compute the covariance between two expressions.
* When applied on empty data (i.e., count is zero), it returns NULL.
*/
abstract class Covariance(x: Expression, y: Expression, nullOnDivideByZero: Boolean)
extends DeclarativeAggregate with ImplicitCastInputTypes with BinaryLike[Expression] {
override def left: Expression = x
override def right: Expression = y
override def nullable: Boolean = true
override def dataType: DataType = DoubleType
override def inputTypes: Seq[AbstractDataType] = Seq(DoubleType, DoubleType)
protected val n = AttributeReference("n", DoubleType, nullable = false)()
protected val xAvg = AttributeReference("xAvg", DoubleType, nullable = false)()
protected val yAvg = AttributeReference("yAvg", DoubleType, nullable = false)()
protected val ck = AttributeReference("ck", DoubleType, nullable = false)()
protected def divideByZeroEvalResult: Expression = {
if (nullOnDivideByZero) Literal.create(null, DoubleType) else Double.NaN
}
override def stringArgs: Iterator[Any] =
super.stringArgs.filter(_.isInstanceOf[Expression])
override val aggBufferAttributes: Seq[AttributeReference] = Seq(n, xAvg, yAvg, ck)
override val initialValues: Seq[Expression] = Array.fill(4)(Literal(0.0))
override lazy val updateExpressions: Seq[Expression] = updateExpressionsDef
override val mergeExpressions: Seq[Expression] = {
val n1 = n.left
val n2 = n.right
val newN = n1 + n2
val dx = xAvg.right - xAvg.left
val dxN = If(newN === 0.0, 0.0, dx / newN)
val dy = yAvg.right - yAvg.left
val dyN = If(newN === 0.0, 0.0, dy / newN)
val newXAvg = xAvg.left + dxN * n2
val newYAvg = yAvg.left + dyN * n2
val newCk = ck.left + ck.right + dx * dyN * n1 * n2
Seq(newN, newXAvg, newYAvg, newCk)
}
protected def updateExpressionsDef: Seq[Expression] = {
val newN = n + 1.0
val dx = x - xAvg
val dy = y - yAvg
val dyN = dy / newN
val newXAvg = xAvg + dx / newN
val newYAvg = yAvg + dyN
val newCk = ck + dx * (y - newYAvg)
val isNull = x.isNull || y.isNull
Seq(
If(isNull, n, newN),
If(isNull, xAvg, newXAvg),
If(isNull, yAvg, newYAvg),
If(isNull, ck, newCk)
)
}
}
@ExpressionDescription(
usage = "_FUNC_(expr1, expr2) - Returns the population covariance of a set of number pairs.",
examples = """
Examples:
> SELECT _FUNC_(c1, c2) FROM VALUES (1,1), (2,2), (3,3) AS tab(c1, c2);
0.6666666666666666
""",
group = "agg_funcs",
since = "2.0.0")
case class CovPopulation(
override val left: Expression,
override val right: Expression,
nullOnDivideByZero: Boolean = !SQLConf.get.legacyStatisticalAggregate)
extends Covariance(left, right, nullOnDivideByZero) {
def this(left: Expression, right: Expression) =
this(left, right, !SQLConf.get.legacyStatisticalAggregate)
override val evaluateExpression: Expression = {
If(n === 0.0, Literal.create(null, DoubleType), ck / n)
}
override def prettyName: String = "covar_pop"
}
@ExpressionDescription(
usage = "_FUNC_(expr1, expr2) - Returns the sample covariance of a set of number pairs.",
examples = """
Examples:
> SELECT _FUNC_(c1, c2) FROM VALUES (1,1), (2,2), (3,3) AS tab(c1, c2);
1.0
""",
group = "agg_funcs",
since = "2.0.0")
case class CovSample(
override val left: Expression,
override val right: Expression,
nullOnDivideByZero: Boolean = !SQLConf.get.legacyStatisticalAggregate)
extends Covariance(left, right, nullOnDivideByZero) {
def this(left: Expression, right: Expression) =
this(left, right, !SQLConf.get.legacyStatisticalAggregate)
override val evaluateExpression: Expression = {
If(n === 0.0, Literal.create(null, DoubleType),
If(n === 1.0, divideByZeroEvalResult, ck / (n - 1.0)))
}
override def prettyName: String = "covar_samp"
}