Struct BooleanGroupsAccumulator

pub struct BooleanGroupsAccumulator<F>
where
    F: Fn(bool, bool) -> bool + Send + Sync,
{ /* private fields */ }

An accumulator that implements a single operation over a BooleanArray where the accumulated state is also boolean (such as BitAndAssign)

F: The function to apply to two elements. The first argument is the existing value and should be updated with the second value (e.g. BitAndAssign style).

Implementations

impl<F> BooleanGroupsAccumulator<F>

where F: Fn(bool, bool) -> bool + Send + Sync,

pub fn new(bool_fn: F, identity: bool) -> Self

Trait Implementations

impl<F> Debug for BooleanGroupsAccumulator<F>

where F: Fn(bool, bool) -> bool + Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<F> GroupsAccumulator for BooleanGroupsAccumulator<F>

where F: Fn(bool, bool) -> bool + Send + Sync,

fn update_batch( &mut self, values: &[ArrayRef], group_indices: &[usize], opt_filter: Option<&BooleanArray>, total_num_groups: usize, ) -> Result<()>

Updates the accumulator’s state from its arguments, encoded as a vector of ArrayRefs.

fn evaluate(&mut self, emit_to: EmitTo) -> Result<ArrayRef>

Returns the final aggregate value for each group as a single RecordBatch, resetting the internal state.

fn state(&mut self, emit_to: EmitTo) -> Result<Vec<ArrayRef>>

Returns the intermediate aggregate state for this accumulator, used for multi-phase grouping, resetting its internal state.

fn merge_batch( &mut self, values: &[ArrayRef], group_indices: &[usize], opt_filter: Option<&BooleanArray>, total_num_groups: usize, ) -> Result<()>

Merges intermediate state (the output from Self::state) into this accumulator’s current state.

fn size(&self) -> usize

Amount of memory used to store the state of this accumulator, in bytes.

fn convert_to_state( &self, values: &[ArrayRef], opt_filter: Option<&BooleanArray>, ) -> Result<Vec<ArrayRef>>

Converts an input batch directly to the intermediate aggregate state.

fn supports_convert_to_state(&self) -> bool

Returns true if Self::convert_to_state is implemented to support intermediate aggregate state conversion.