Trait Statistics

Source

pub trait Statistics {
    // Required methods
    fn get(&self, stat: Stat) -> Option<ScalarValue>;
    fn to_set(&self) -> StatsSet;
    fn set(&self, stat: Stat, value: ScalarValue);
    fn clear(&self, stat: Stat);
    fn compute(&self, stat: Stat) -> Option<ScalarValue>;
    fn retain_only(&self, stats: &[Stat]);

    // Provided method
    fn compute_all(&self, stats: &[Stat]) -> VortexResult<StatsSet> { ... }
}

Required Methods§

Source

fn get(&self, stat: Stat) -> Option<ScalarValue>

Returns the value of the statistic only if it’s present

Source

fn to_set(&self) -> StatsSet

Get all existing statistics

Source

fn set(&self, stat: Stat, value: ScalarValue)

Set the value of the statistic

Source

fn clear(&self, stat: Stat)

Clear the value of the statistic

Source

fn compute(&self, stat: Stat) -> Option<ScalarValue>

Computes the value of the stat if it’s not present.

Returns the scalar if compute succeeded, or None if the stat is not supported for this array.

Source

fn retain_only(&self, stats: &[Stat])

Provided Methods§

Source

fn compute_all(&self, stats: &[Stat]) -> VortexResult<StatsSet>

Compute all the requested statistics (if not already present) Returns a StatsSet with the requested stats and any additional available stats

Implementations§

Source §

impl dyn Statistics + '_

Source

pub fn get_as<U: for<'a> TryFrom<&'a ScalarValue, Error = VortexError>>( &self, stat: Stat, ) -> Option<U>

Get the provided stat if present in the underlying array, converting the ScalarValue into a typed value. If the stored ScalarValue is of different type then the primitive typed value this function will perform a cast.

§Panics

This function will panic if the conversion fails.

Source

pub fn compute_as<U: for<'a> TryFrom<&'a ScalarValue, Error = VortexError>>( &self, stat: Stat, ) -> Option<U>

Get or calculate the provided stat, converting the ScalarValue into a typed value. If the stored ScalarValue is of different type then the primitive typed value this function will perform a cast.