Sum implements AggregatingFunction, FrameAccumulating, WindowFunction
FinalYes
Interfaces
- AggregatingFunction
- FrameAccumulating
- Opts a WindowFunction into incremental frame evaluation. Carrying it asserts the result depends only on the frame contents - never on the current row or its index - which is what lets WindowProcessor reuse a value across rows that share frame bounds.
- WindowFunction
Methods
- __construct() : mixed
- accumulator() : FrameAccumulator
- aggregate() : void
- apply() : mixed
- over() : static
- references() : null|array<int, Reference>
- result() : Entry<string|int, mixed>
- toString() : string
- window() : Window
Methods
__construct()
public
__construct(Reference $ref[, ScalarFunction|bool $exact = false ]) : mixed
Parameters
- $ref : Reference
- $exact : ScalarFunction|bool = false
accumulator()
public
accumulator(FlowContext $context) : FrameAccumulator
Parameters
- $context : FlowContext
Return values
FrameAccumulatoraggregate()
public
aggregate(Row $row, FlowContext $context) : void
Parameters
- $row : Row
- $context : FlowContext
apply()
public
apply(WindowContext $window) : mixed
Parameters
- $window : WindowContext
over()
public
over(Window $window) : static
Parameters
- $window : Window
Return values
staticreferences()
public
references() : null|array<int, Reference>
Return values
null|array<int, Reference> —null when $exact is a ScalarFunction - its entries cannot be statically enumerated, so spill column pruning must be disabled
result()
public
result(EntryFactory $entryFactory) : Entry<string|int, mixed>
Parameters
- $entryFactory : EntryFactory
Return values
Entry<string|int, mixed>toString()
public
toString() : string
Return values
stringwindow()
public
window() : Window