abstract class UDAF3[S, O, A0, A1, A2] extends UDAF
The Scala UDAF (user-defined aggregate function) abstract class that has 3 arguments.
- S
The type of the aggregation state.
- O
The type of the output value.
- Since
1.19.0
- Alphabetic
- By Inheritance
- UDAF3
- UDAF
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new UDAF3()(implicit a0Tag: scala.reflect.api.JavaUniverse.TypeTag[A0], a1Tag: scala.reflect.api.JavaUniverse.TypeTag[A1], a2Tag: scala.reflect.api.JavaUniverse.TypeTag[A2])
Abstract Value Members
-
abstract
def
accumulate(state: S, arg0: A0, arg1: A1, arg2: A2): S
Updates the aggregation state with a new input row.
Updates the aggregation state with a new input row.
- state
The current aggregation state.
- arg0
The input value for argument 1.
- arg1
The input value for argument 2.
- arg2
The input value for argument 3.
- returns
The updated aggregation state.
- Since
1.19.0
-
abstract
def
initialize(): S
- returns
The initial state of the aggregation.
- Since
1.19.0
-
abstract
def
merge(state1: S, state2: S): S
Merges two aggregation states into one.
Merges two aggregation states into one.
- state1
The first aggregation state.
- state2
The second aggregation state.
- returns
The merged aggregation state.
- Since
1.19.0
-
abstract
def
outputType(): DataType
A DataType that describes the type of the value returned by the terminate() method.
A DataType that describes the type of the value returned by the terminate() method.
For example, if a UDAF returns an integer value, outputType() should return IntegerType: {{ override def outputType(): DataType = IntegerType }}
- returns
A DataType describing the output type.
- Definition Classes
- UDAF
- Since
1.19.0
-
abstract
def
terminate(state: S): O
Produces the final output value from the aggregation state.
Produces the final output value from the aggregation state.
- state
The final aggregation state.
- returns
The output value.
- Since
1.19.0
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
inputSchema(): StructType
A StructType that describes the input schema of the aggregate function.
A StructType that describes the input schema of the aggregate function. By default, returns an empty StructType.
- returns
A StructType describing the input schema.
- Definition Classes
- UDAF
- Since
1.19.0
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated