Struct Mask 

pub struct Mask;

An expression that masks an input based on a boolean mask.

Where the mask is true, the input value is retained; where the mask is false, the output is null. In other words, this performs an intersection of the input’s validity with the mask.

Trait Implementations

impl VTable for Mask

type Options = EmptyOptions

Options for this expression.

fn id(&self) -> ArcRef<str>

Returns the ID of the expr vtable.

fn arity(&self, _options: &<Mask as VTable>::Options) -> Arity

Returns the arity of this expression.

fn child_name( &self, _options: &<Mask as VTable>::Options, child_idx: usize, ) -> ArcRef<str>

Returns the name of the nth child of the expr.

fn fmt_sql( &self, _options: &<Mask as VTable>::Options, expr: &Expression, f: &mut Formatter<'_>, ) -> Result<(), Error>

Format this expression in nice human-readable SQL-style format

fn return_dtype( &self, _options: &<Mask as VTable>::Options, arg_dtypes: &[DType], ) -> Result<DType, VortexError>

Compute the return DType of the expression if evaluated over the given input types.

fn evaluate( &self, _options: &<Mask as VTable>::Options, expr: &Expression, scope: &Arc<dyn Array>, ) -> Result<Arc<dyn Array>, VortexError>

Evaluate the expression in the given scope.

fn execute( &self, _options: &<Mask as VTable>::Options, args: ExecutionArgs, ) -> Result<Datum, VortexError>

Execute the expression on the given vector with the given dtype.

fn serialize( &self, options: &Self::Options, ) -> Result<Option<Vec<u8>>, VortexError>

Serialize the options for this expression.

fn deserialize(&self, _metadata: &[u8]) -> Result<Self::Options, VortexError>

Deserialize the options of this expression.

fn reduce( &self, options: &Self::Options, node: &dyn ReduceNode, ctx: &dyn ReduceCtx, ) -> Result<Option<Arc<dyn ReduceNode>>, VortexError>

Implement an abstract reduction rule over a tree of scalar functions.

fn simplify( &self, options: &Self::Options, expr: &Expression, ctx: &dyn SimplifyCtx, ) -> Result<Option<Expression>, VortexError>

Simplify the expression if possible.

fn simplify_untyped( &self, options: &Self::Options, expr: &Expression, ) -> Result<Option<Expression>, VortexError>

Simplify the expression if possible, without type information.

fn stat_falsification( &self, options: &Self::Options, expr: &Expression, catalog: &dyn StatsCatalog, ) -> Option<Expression>

See Expression::stat_falsification.

fn stat_expression( &self, options: &Self::Options, expr: &Expression, stat: Stat, catalog: &dyn StatsCatalog, ) -> Option<Expression>

See Expression::stat_expression.

fn is_null_sensitive(&self, options: &Self::Options) -> bool

Returns whether this expression itself is null-sensitive. Conservatively default to true.

fn is_fallible(&self, options: &Self::Options) -> bool

Returns whether this expression itself is fallible. Conservatively default to true.