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, return_data_type: &DataType) -> Result<Self>

Creates a new AvgAccumulator

Trait Implementations

impl Accumulator for AvgAccumulator

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

Returns the partial intermediate state of the accumulator. This partial state is serialied as Arrays and then combined with other partial states from different instances of this accumulator (that ran on different partitions, for example).

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

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

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

Retracts an update (caused by the given inputs) to accumulator’s state.

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

Updates the accumulator’s state from an Array containing one or more intermediate values.

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

Returns the final aggregate value based on its current state.

fn size(&self) -> usize

Allocated size required for this accumulator, in bytes, including Self. Allocated means that for internal containers such as Vec, the capacity should be used not the len

impl Debug for AvgAccumulator

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

Formats the value using the given formatter.