Trait Operator 

pub trait Operator:
    'static
    + Send
    + Sync
    + Debug
    + DynOperatorHash
    + DynOperatorEq {
    // Required methods
    fn id(&self) -> ArcRef<str>;
    fn as_any(&self) -> &(dyn Any + 'static);
    fn dtype(&self) -> &DType;
    fn len(&self) -> usize;
    fn children(&self) -> &[Arc<dyn Operator>];
    fn with_children(
        self: Arc<Self>,
        _children: Vec<Arc<dyn Operator>>,
    ) -> Result<Arc<dyn Operator>, VortexError>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn nchildren(&self) -> usize { ... }
    fn fmt_as(
        &self,
        _df: DisplayFormat,
        f: &mut Formatter<'_>,
    ) -> Result<(), Error> { ... }
    fn reduce_children(&self) -> Result<Option<Arc<dyn Operator>>, VortexError> { ... }
    fn reduce_parent(
        &self,
        _parent: Arc<dyn Operator>,
        _child_idx: usize,
    ) -> Result<Option<Arc<dyn Operator>>, VortexError> { ... }
    fn is_selection_target(&self, _child_idx: usize) -> Option<bool> { ... }
    fn as_batch(&self) -> Option<&(dyn BatchOperator + 'static)> { ... }
    fn as_pipelined(&self) -> Option<&(dyn PipelinedOperator + 'static)> { ... }
}

An operator represents a node in a logical query plan.

Required Methods

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

The unique identifier for this operator instance.

fn as_any(&self) -> &(dyn Any + 'static)

For downcasting.

fn dtype(&self) -> &DType

Returns the DType of the array produced by this operator.

fn len(&self) -> usize

Returns the number of rows produced by this operator.

fn children(&self) -> &[Arc<dyn Operator>]

The children of this operator.

fn with_children( self: Arc<Self>, _children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

Create a new instance of this operator with the given children.

Panics

Panics if the number or dtypes of children are incorrect.

Provided Methods

fn is_empty(&self) -> bool

Returns whether this operator produces zero rows.

fn nchildren(&self) -> usize

The number of children of this operator.

fn fmt_as(&self, _df: DisplayFormat, f: &mut Formatter<'_>) -> Result<(), Error>

Override the default formatting of this operator.

fn reduce_children(&self) -> Result<Option<Arc<dyn Operator>>, VortexError>

Attempt to optimize this node by analyzing its children.

For example, if all the children are constant, this function should perform constant folding and return a constant operator.

This function should typically be implemented only for self-contained optimizations based on child properties

fn reduce_parent( &self, _parent: Arc<dyn Operator>, _child_idx: usize, ) -> Result<Option<Arc<dyn Operator>>, VortexError>

Attempt to push down a parent operator through this node.

The child_idx parameter indicates which child of the parent this operator occupies. For example, if the parent is a binary operator, and this operator is the left child, then child_idx will be 0. If this operator is the right child, then child_idx will be 1.

The returned operator will replace the parent in the tree.

This function should typically be implemented for cross-operator optimizations where the child needs to adapt to the parent’s requirements

fn is_selection_target(&self, _child_idx: usize) -> Option<bool>

Return true if the given child is considered to be a selection target.

The definition of this is such that pushing a selection operator down to all selection targets will result in the same output as a selection on this operator.

For example, select(Op, mask) == Op(select(child, mask), ...) for all children that are selection targets.

If any child index returns None, then selection pushdown is not possible. If all children return Some(false), then selection pushdown is not possible.

fn as_batch(&self) -> Option<&(dyn BatchOperator + 'static)>

Returns this operator as a BatchOperator if it supports batch execution.

fn as_pipelined(&self) -> Option<&(dyn PipelinedOperator + 'static)>

Returns this operator as a PipelinedOperator if it supports pipelined execution.

Note that operators that implement PipelinedOperator do not need to implement BatchOperator, although they may choose to do so.

Implementations

impl dyn Operator + '_

pub fn display_tree(&self) -> impl Display

impl dyn Operator + '_

pub fn optimize( self: Arc<dyn Operator + '_>, ) -> Result<Arc<dyn Operator>, VortexError>

Optimize the operator tree rooted at this operator by applying local optimizations such as reducing redundant operators.

Trait Implementations

impl OperatorEq for dyn Operator + '_

fn operator_eq(&self, other: &dyn Operator) -> bool

impl OperatorHash for dyn Operator + '_

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

where H: Hasher,

Implementations on Foreign Types

impl Operator for BetweenOperator

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

fn as_any(&self) -> &(dyn Any + 'static)

fn dtype(&self) -> &DType

fn len(&self) -> usize

fn children(&self) -> &[Arc<dyn Operator>]

fn with_children( self: Arc<BetweenOperator>, children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

fn is_selection_target(&self, _child_idx: usize) -> Option<bool>

impl Operator for BitPackedArray

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

fn as_any(&self) -> &(dyn Any + 'static)

fn dtype(&self) -> &DType

fn len(&self) -> usize

fn children(&self) -> &[Arc<dyn Operator>]

fn with_children( self: Arc<BitPackedArray>, _children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

impl Operator for FSSTArray

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

fn as_any(&self) -> &(dyn Any + 'static)

fn dtype(&self) -> &DType

fn len(&self) -> usize

fn children(&self) -> &[Arc<dyn Operator>]

fn with_children( self: Arc<FSSTArray>, _children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

fn reduce_parent( &self, parent: Arc<dyn Operator>, _child_idx: usize, ) -> Result<Option<Arc<dyn Operator>>, VortexError>

fn as_batch(&self) -> Option<&(dyn BatchOperator + 'static)>

impl Operator for SequenceArray

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

fn as_any(&self) -> &(dyn Any + 'static)

fn dtype(&self) -> &DType

fn len(&self) -> usize

fn children(&self) -> &[Arc<dyn Operator>]

fn with_children( self: Arc<SequenceArray>, _children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

fn reduce_parent( &self, parent: Arc<dyn Operator>, _child_idx: usize, ) -> Result<Option<Arc<dyn Operator>>, VortexError>

fn as_pipelined(&self) -> Option<&(dyn PipelinedOperator + 'static)>

Implementors

impl Operator for ConstantArray

impl Operator for PrimitiveArray

impl Operator for CompareOperator

impl Operator for FilterOperator

impl Operator for GetItemOperator

impl Operator for MetricsOperator

impl Operator for SliceOperator