Struct Pack

pub struct Pack { /* 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, Pack, Scope, VortexExpr};
use vortex_scalar::Scalar;
use vortex_dtype::Nullability;

let example = Pack::try_new_expr(
    ["x".into(), "x copy".into(), "second x copy".into()].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 Pack

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

pub fn names(&self) -> &FieldNames

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

Trait Implementations

impl AnalysisExpr for Pack

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>

If an expression is returned, its value is an upper bound on the value of expr.

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

If an expression is returned, its value is an upper bound on the value of expr. see AnalysisExpr::max

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

impl Clone for Pack

fn clone(&self) -> Pack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pack

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

Formats the value using the given formatter.

impl Display for Pack

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

Formats the value using the given formatter.

impl Hash for Pack

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 Pack

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

fn as_any(&self) -> &dyn Any

Convert expression reference to reference of Any type

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

Compute result of expression on given batch producing a new batch

fn children(&self) -> Vec<&ExprRef>

fn replacing_children(self: Arc<Self>, children: Vec<ExprRef>) -> ExprRef

fn return_dtype(&self, scope: &ScopeDType) -> VortexResult<DType>

Compute the type of the array returned by VortexExpr::evaluate.

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

Compute result of expression on given batch producing a new batch

impl Eq for Pack

impl StructuralPartialEq for Pack