Enum HashKeys

pub enum HashKeys {
    RowEncoded(RowEncodedKeys),
    Binview(BinviewKeys),
    Single(SingleKeys),
}

Represents a DataFrame plus a hash per row, intended for keys in grouping or joining. The hashes may or may not actually be physically pre-computed, this depends per type.

Variants

RowEncoded(RowEncodedKeys)

Binview(BinviewKeys)

Single(SingleKeys)

Implementations

impl HashKeys

pub fn from_df( df: &DataFrame, random_state: PlRandomState, null_is_valid: bool, force_row_encoding: bool, ) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn validity(&self) -> Option<&Bitmap>

pub fn null_is_valid(&self) -> bool

pub fn for_each_hash<F: FnMut(IdxSize, Option<u64>)>(&self, f: F)

Calls f with the index of and hash of each element in this HashKeys.

If the element is null and null_is_valid is false the respective hash will be None.

pub unsafe fn for_each_hash_subset<F: FnMut(IdxSize, Option<u64>)>( &self, subset: &[IdxSize], f: F, )

Calls f with the index of and hash of each element in the given subset of indices of the HashKeys.

If the element is null and null_is_valid is false the respective hash will be None.

Safety

The indices in the subset must be in-bounds.

pub fn gen_partitions( &self, partitioner: &HashPartitioner, partitions: &mut Vec<IdxSize>, partition_nulls: bool, )

After this call partitions will be extended with the partition for each hash. Nulls are assigned IdxSize::MAX or a specific partition depending on whether partition_nulls is true.

pub fn gen_idxs_per_partition( &self, partitioner: &HashPartitioner, partition_idxs: &mut [Vec<IdxSize>], sketches: &mut [CardinalitySketch], partition_nulls: bool, )

After this call partition_idxs[p] will be extended with the indices of hashes that belong to partition p, and the cardinality sketches are updated accordingly.

pub fn sketch_cardinality(&self, sketch: &mut CardinalitySketch)

pub unsafe fn gather_unchecked(&self, idxs: &[IdxSize]) -> Self

Safety

The indices must be in-bounds.

Trait Implementations

impl Clone for HashKeys

fn clone(&self) -> HashKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashKeys

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

Formats the value using the given formatter.