Struct PreparedSetData 

pub struct PreparedSetData(/* private fields */);

The options of a PreparedSet: the list that every row holds, and its set.

The set is shared by every clone, so every batch a PreparedSet is applied to, and every slice or filter of the array it gives, looks up needles in the one set. The haystack needs an ExecutionCtx to materialize the elements, so it is built on the first lookup.

Implementations

impl PreparedSetData

pub fn try_new(list: Scalar) -> VortexResult<Self>

Prepares the non-null list scalar list as a set.

Errors

Fails when list is not a list, or is null.

pub fn is_empty(&self) -> bool

Whether the list holds no element at all, null elements included.

pub fn list(&self) -> &Scalar

The list that every row holds.

pub fn elements(&self, ctx: &mut ExecutionCtx) -> VortexResult<&ArrayRef>

The elements of the list, one row each, null elements included.

Errors

Fails when the elements cannot be executed into the haystack.

pub fn contains( &self, needles: &ArrayRef, options: &ListContainsOptions, ctx: &mut ExecutionCtx, ) -> VortexResult<ArrayRef>

Whether each of needles is an element of the list, under options.

The needles must have the dtype of the list’s elements, ignoring nullability. The result has one row per needle, and the nullability that ListContainsOptions::result_nullability declares. A null needle gives null. The exception is an empty list off SQL null semantics, which gives false for every needle. Under SQL null semantics, a list that holds a null element gives null for a needle that matches no element.

A constant needle is looked up once, and gives a constant result.

Errors

Fails when the needles do not have the dtype of the list’s elements.

pub fn contains_scalar( &self, needle: &Scalar, options: &ListContainsOptions, ctx: &mut ExecutionCtx, ) -> VortexResult<Scalar>

Whether the constant needle is an element of the list, under options.

The answer is the one Self::contains gives for each row of a needle with this value, for example for the fill value of a sparse needle. The haystack looks up one row.

Errors

Fails when the needle does not have the dtype of the list’s elements.

pub fn result_from_bits( &self, bits: BitBuffer, needle_validity: Validity, needle_dtype: &DType, options: &ListContainsOptions, ) -> VortexResult<ArrayRef>

Makes the result of Self::contains from one membership bit per needle.

A kernel that finds the matches of its needles without this haystack, for example from bounds of its own, uses this to apply the null semantics of Self::contains. A set bit in bits tells that the needle equals an element. needle_validity is the validity of the needles, and needle_dtype is their dtype. The bit of a null needle has no effect.

Errors

Fails when needle_dtype is not the dtype of the list’s elements, or when needle_validity does not have one row per bit.

Trait Implementations

impl Clone for PreparedSetData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreparedSetData

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

Formats the value using the given formatter.

impl Display for PreparedSetData

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

Formats the value using the given formatter.

impl Eq for PreparedSetData

impl Hash for PreparedSetData

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PreparedSetData

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

Equality operator ==.

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

Inequality operator !=.