Struct ScalarFn 

pub struct ScalarFn { /* private fields */ }

An instance of an expression bound to some invocation options.

Implementations

impl ScalarFn

pub fn new<V: VTable>(vtable: V, options: V::Options) -> Self

Create a new bound expression from a vtable.

pub fn new_static<V: VTable>(vtable: &'static V, options: V::Options) -> Self

Create a new expression from a static vtable.

pub fn vtable(&self) -> &ExprVTable

The vtable for this expression.

pub fn id(&self) -> ExprId

Returns the ID of this expression.

pub fn options(&self) -> ExpressionOptions<'_>

The type-erased options for this expression.

pub fn is<V: VTable>(&self) -> bool

Returns whether the scalar function is of the given vtable type.

pub fn as_opt<V: VTable>(&self) -> Option<&V::Options>

Returns the typed options for this expression if it matches the given vtable type.

pub fn signature(&self) -> ExpressionSignature<'_>

Signature information for this expression.

pub fn return_dtype(&self, arg_types: &[DType]) -> VortexResult<DType>

Compute the return DType of this expression given the input argument types.

pub fn evaluate( &self, expr: &Expression, scope: &ArrayRef, ) -> VortexResult<ArrayRef>

Evaluate the expression, returning an ArrayRef.

NOTE: this function will soon be deprecated as all expressions will evaluate trivially into an ExprArray.

pub fn execute(&self, ctx: ExecutionArgs) -> VortexResult<Datum>

Execute the expression given the input arguments.

pub fn reduce( &self, node: &dyn ReduceNode, ctx: &dyn ReduceCtx, ) -> VortexResult<Option<ReduceNodeRef>>

Perform abstract reduction on this scalar function node.

Trait Implementations

impl Clone for ScalarFn

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 ScalarFn

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

Formats the value using the given formatter.

impl Display for ScalarFn

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

Formats the value using the given formatter.

impl Hash for ScalarFn

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 ScalarFn

fn eq(&self, other: &Self) -> 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 Eq for ScalarFn