Struct vortex_array::stats::StatsSet

pub struct StatsSet { /* private fields */ }

Implementations

impl StatsSet

pub fn new_unchecked(values: Vec<(Stat, Scalar)>) -> 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 nulls(len: usize, dtype: &DType) -> Self

Specialized constructor for the case where the StatsSet represents an array consisting entirely of null values.

pub fn constant(scalar: &Scalar, length: usize) -> Self

pub fn bools_with_true_and_null_count( true_count: usize, null_count: usize, len: usize, ) -> Self

pub fn of<S: Into<Scalar>>(stat: Stat, value: S) -> Self

impl StatsSet

pub fn len(&self) -> usize

Count of stored stats with known values.

pub fn is_empty(&self) -> bool

Predicate equivalent to a len of zero.

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

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

pub fn set<S: Into<Scalar>>(&mut self, stat: Stat, value: S)

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])

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

Iterate over the statistic names and values in-place.

See Iterator.

impl StatsSet

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

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

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

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

Trait Implementations

impl Clone for StatsSet

fn clone(&self) -> StatsSet

Returns a copy 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, Scalar)> for StatsSet

fn extend<T: IntoIterator<Item = (Stat, Scalar)>>(&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 IntoIterator for StatsSet

type Item = (Stat, Scalar)

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 PartialEq for StatsSet

fn eq(&self, other: &StatsSet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StatsSet