Struct datafusion_physical_expr::expressions::AvgAccumulator

pub struct AvgAccumulator { /* private fields */ }

An accumulator to compute the average

Implementations

impl AvgAccumulator

pub fn try_new(datatype: &DataType) -> Result<Self>

Creates a new AvgAccumulator

Trait Implementations

impl Accumulator for AvgAccumulator

fn state(&self) -> Result<Vec<AggregateState>>

Returns the state of the accumulator at the end of the accumulation. in the case of an average on which we track sum and n, this function should return a vector of two values, sum and n.

fn update_batch(&mut self, values: &[ArrayRef]) -> Result<()>

Updates the accumulator’s state from a vector of arrays.

fn merge_batch(&mut self, states: &[ArrayRef]) -> Result<()>

updates the accumulator’s state from a vector of states.

fn evaluate(&self) -> Result<ScalarValue>

returns its value based on its current state.

fn retract_batch(
    &mut self,
    _values: &[Arc<dyn Array + 'static>]
) -> Result<(), DataFusionError>

Retracts an update (caused by the given inputs) to accumulator’s state. Inverse operation of the update_batch operation. This method must be for accumulators that should support bounded OVER aggregates.

impl Debug for AvgAccumulator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.