Struct mz_expr::linear::plan::SafeMfpPlan

pub struct SafeMfpPlan {
    pub(crate) mfp: MapFilterProject,
}

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

Fields

mfp: MapFilterProject

Implementations

impl SafeMfpPlan

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

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

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.

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.

pub fn could_error(&self) -> bool

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

pub fn is_identity(&self) -> bool

Returns true when Self is the identity.

Methods from Deref<Target = MapFilterProject>

pub fn is_identity(&self) -> bool

True if the operator describes the identity transformation.

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.

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

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

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.

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.

pub fn size(&self) -> usize

Total expression sizes across all expressions.

Trait Implementations

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.

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.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for SafeMfpPlan

fn clone(&self) -> SafeMfpPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SafeMfpPlan

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

Formats the value using the given formatter.

impl Deref for SafeMfpPlan

type Target = MapFilterProject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SafeMfpPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for SafeMfpPlan

fn cmp(&self, other: &SafeMfpPlan) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SafeMfpPlan

fn eq(&self, other: &SafeMfpPlan) -> 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 PartialOrd for SafeMfpPlan

fn partial_cmp(&self, other: &SafeMfpPlan) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RustType<ProtoSafeMfpPlan> for SafeMfpPlan

fn into_proto(&self) -> ProtoSafeMfpPlan

Convert a Self into a Proto value.

fn from_proto(proto: ProtoSafeMfpPlan) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for SafeMfpPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SafeMfpPlan

impl StructuralPartialEq for SafeMfpPlan