Struct PackExpr

pub struct PackExpr { /* private fields */ }

Pack zero or more expressions into a structure with named fields.

Examples

use vortex_array::{IntoArray, ToCanonical};
use vortex_buffer::buffer;
use vortex_expr::{root, PackExpr, Scope, VortexExpr};
use vortex_scalar::Scalar;
use vortex_dtype::Nullability;

let example = PackExpr::try_new(
    ["x", "x copy", "second x copy"].into(),
    vec![root(), root(), root()],
    Nullability::NonNullable,
).unwrap();
let packed = example.evaluate(&Scope::new(buffer![100, 110, 200].into_array())).unwrap();
let x_copy = packed
    .to_struct()
    .unwrap()
    .field_by_name("x copy")
    .unwrap()
    .clone();
assert_eq!(x_copy.scalar_at(0).unwrap(), Scalar::from(100));
assert_eq!(x_copy.scalar_at(1).unwrap(), Scalar::from(110));
assert_eq!(x_copy.scalar_at(2).unwrap(), Scalar::from(200));

Implementations

impl PackExpr

pub fn try_new( names: FieldNames, values: Vec<ExprRef>, nullability: Nullability, ) -> VortexResult<Self>

pub fn try_new_expr( names: FieldNames, values: Vec<ExprRef>, nullability: Nullability, ) -> VortexResult<ExprRef>

pub fn names(&self) -> &FieldNames

pub fn field(&self, field_name: &FieldName) -> VortexResult<ExprRef>

pub fn nullability(&self) -> Nullability

Methods from Deref<Target = dyn VortexExpr>

pub fn id(&self) -> ExprId

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

pub fn as_<V: VTable>(&self) -> &V::Expr

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

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

Compute result of expression on given batch producing a new batch

Trait Implementations

impl AnalysisExpr for PackExpr

fn stat_falsification(&self, _catalog: &mut dyn StatsCatalog) -> Option<ExprRef>

An expression over zone-statistics which implies all records in the zone evaluate to false.

fn max(&self, _catalog: &mut dyn StatsCatalog) -> Option<ExprRef>

An expression for the upper non-null bound of this expression, if available.

fn min(&self, _catalog: &mut dyn StatsCatalog) -> Option<ExprRef>

An expression for the lower non-null bound of this expression, if available.

fn nan_count(&self, _catalog: &mut dyn StatsCatalog) -> Option<ExprRef>

An expression for the NaN count for a column, if available.

fn field_path(&self) -> Option<FieldPath>

impl AsRef<dyn VortexExpr> for PackExpr

fn as_ref(&self) -> &dyn VortexExpr

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PackExpr

fn clone(&self) -> PackExpr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackExpr

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

Formats the value using the given formatter.

impl Deref for PackExpr

type Target = dyn VortexExpr

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for PackExpr

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

Formats the value using the given formatter.

impl From<PackExpr> for ExprRef

fn from(value: PackExpr) -> ExprRef

Converts to this type from the input type.

impl Hash for PackExpr

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 IntoExpr for PackExpr

fn into_expr(self) -> ExprRef

Convert this type into an expression reference.

impl PartialEq for PackExpr

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

impl StructuralPartialEq for PackExpr