Struct StatsSet

pub struct StatsSet { /* private fields */ }

Implementations

impl StatsSet

pub fn new_unchecked(values: Vec<(Stat, Precision<ScalarValue>)>) -> Self

Create new StatSet without validating uniqueness of all the entries

Safety

This method will not panic or trigger UB, but may lead to duplicate stats being stored.

pub fn of(stat: Stat, value: Precision<ScalarValue>) -> Self

Create StatsSet from single stat and value

pub fn as_mut_typed_ref<'a, 'b>( &'a mut self, dtype: &'b DType, ) -> MutTypedStatsSetRef<'a, 'b>

Wrap stats set with a dtype for mutable typed scalar access

pub fn as_typed_ref<'a, 'b>( &'a self, dtype: &'b DType, ) -> TypedStatsSetRef<'a, 'b>

Wrap stats set with a dtype for typed scalar access

impl StatsSet

pub fn set(&mut self, stat: Stat, value: Precision<ScalarValue>)

Set the stat stat to value.

pub fn clear(&mut self, stat: Stat)

Clear the stat stat from the set.

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

Only keep given stats

pub fn keep_inexact_stats(self, inexact_keep: &[Stat]) -> Self

Keep given stats as inexact values

pub fn iter(&self) -> impl Iterator<Item = &(Stat, Precision<ScalarValue>)>

Iterate over the statistic names and values in-place.

See Iterator.

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

Get value for a given stat

pub fn len(&self) -> usize

Length of the stats set

pub fn is_empty(&self) -> bool

Check whether the statset is empty

pub fn get_as<T: for<'a> TryFrom<&'a Scalar, Error = VortexError>>( &self, stat: Stat, dtype: &DType, ) -> Option<Precision<T>>

Get scalar value of a given dtype

impl StatsSet

Merge helpers

pub fn merge_ordered(self, other: &Self, dtype: &DType) -> Self

Merge stats set other into self, with the semantic assumption that other contains stats from a disjoint array that is appended to the array represented by self.

pub fn merge_unordered(self, other: &Self, dtype: &DType) -> Self

Merge stats set other into self, from a disjoint array, with no ordering assumptions. Stats that are not commutative (e.g., is_sorted) are dropped from the result.

pub fn combine_sets(&mut self, other: &Self, dtype: &DType) -> VortexResult<()>

Given two sets of stats (of differing precision) for the same array, combine them

Trait Implementations

impl Clone for StatsSet

fn clone(&self) -> StatsSet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StatsSet

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

Formats the value using the given formatter.

impl Default for StatsSet

fn default() -> StatsSet

Returns the “default value” for a type.

impl Extend<(Stat, Precision<ScalarValue>)> for StatsSet

fn extend<T: IntoIterator<Item = (Stat, Precision<ScalarValue>)>>( &mut self, iter: T, )

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<ArrayStats> for StatsSet

fn from(value: ArrayStats) -> Self

Converts to this type from the input type.

impl From<StatsSet> for ArrayStats

fn from(value: StatsSet) -> Self

Converts to this type from the input type.

impl FromIterator<(Stat, Precision<ScalarValue>)> for StatsSet

fn from_iter<T: IntoIterator<Item = (Stat, Precision<ScalarValue>)>>( iter: T, ) -> Self

Creates a value from an iterator.

impl IntoIterator for StatsSet

type Item = (Stat, Precision<ScalarValue>)

The type of the elements being iterated over.

type IntoIter = StatsSetIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ReadFlatBuffer for StatsSet

type Source<'a> = ArrayStats<'a>

The FlatBuffer type that this type can be read from.

type Error = VortexError

The error type returned when reading fails.

fn read_flatbuffer<'buf>( fb: &<Self::Source<'buf> as Follow<'buf>>::Inner, ) -> Result<Self, Self::Error>

Reads this type from a FlatBuffer source.

fn read_flatbuffer_bytes<'buf>(bytes: &'buf [u8]) -> Result<Self, Self::Error>

where Self::Source<'buf>: 'buf,

Reads this type from bytes representing a FlatBuffer source.

impl WriteFlatBuffer for StatsSet

fn write_flatbuffer<'fb>( &self, fbb: &mut FlatBufferBuilder<'fb>, ) -> WIPOffset<Self::Target<'fb>>

All statistics written must be exact

type Target<'t> = ArrayStats<'t>

The FlatBuffer type that this type can be written to.