Struct mz_expr::SafeMfpPlan

source ·

pub struct SafeMfpPlan { /* private fields */ }

Expand description

A wrapper type which indicates it is safe to simply evaluate all expressions.

Implementations§

source §

impl SafeMfpPlan

source

pub fn permute(&mut self, map: BTreeMap<usize, usize>, new_arity: usize)

source

pub fn evaluate_into<'a, 'row>( &'a self, datums: &mut Vec<Datum<'a>>, arena: &'a RowArena, row_buf: &'row mut Row ) -> Result<Option<Row>, EvalError>

Evaluates the linear operator on a supplied list of datums.

The arguments are the initial datums associated with the row, and an appropriately lifetimed arena for temporary allocations needed by scalar evaluation.

An Ok result will either be None if any predicate did not evaluate to Datum::True, or the values of the columns listed by self.projection if all predicates passed. If an error occurs in the evaluation it is returned as an Err variant. As the evaluation exits early with failed predicates, it may miss some errors that would occur later in evaluation.

The row is not cleared first, but emptied if the function returns `Ok(Some(row)).

source

pub fn evaluate_iter<'b, 'a: 'b>( &'a self, datums: &'b mut Vec<Datum<'a>>, arena: &'a RowArena ) -> Result<Option<impl Iterator<Item = Datum<'a>> + 'b>, EvalError>

A version of evaluate which produces an iterator over Datum as output.

This version can be useful when one wants to capture the resulting datums without packing and then unpacking a row.

source

pub fn evaluate_inner<'b, 'a: 'b>( &'a self, datums: &'b mut Vec<Datum<'a>>, arena: &'a RowArena ) -> Result<bool, EvalError>

Populates datums with self.expressions and tests self.predicates.

This does not apply self.projection, which is up to the calling method.

source

pub fn could_error(&self) -> bool

Returns true if evaluation could introduce an error on non-error inputs.

source

pub fn is_identity(&self) -> bool

Returns true when Self is the identity.

Methods from Deref<Target = MapFilterProject>§

source

pub fn is_identity(&self) -> bool

True if the operator describes the identity transformation.

source

pub fn as_map_filter_project( &self ) -> (Vec<MirScalarExpr>, Vec<MirScalarExpr>, Vec<usize>)

As the arguments to Map, Filter, and Project operators.

In principle, this operator can be implemented as a sequence of more elemental operators, likely less efficiently.

source

pub fn literal_constraint(&self, expr: &MirScalarExpr) -> Option<Datum<'_>>

Determines if a scalar expression must be equal to a literal datum.

source

pub fn literal_constraints(&self, exprs: &[MirScalarExpr]) -> Option<Row>

Determines if a sequence of scalar expressions must be equal to a literal row.

This method returns None on an empty exprs, which might be surprising, but seems to line up with its callers’ expectations of that being a non-constraint. The caller knows if exprs is empty, and can modify their behavior appropriately. if they would rather have a literal empty row.

source

pub fn demand(&self) -> BTreeSet<usize>

Lists input columns whose values are used in outputs.

It is entirely appropriate to determine the demand of an instance and then both apply a projection to the subject of the instance and self.permute this instance.

source

pub fn size(&self) -> usize

Total expression sizes across all expressions.

Trait Implementations§

source §

impl Arbitrary for SafeMfpPlan

§

type Parameters = <MapFilterProject as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

§

type Strategy = Map<<MapFilterProject as Arbitrary>::Strategy, fn(_: MapFilterProject) -> SafeMfpPlan>

The type of Strategy used to generate values of type Self.

source §

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more

source §