Struct ConstantArray 

pub struct ConstantArray { /* private fields */ }

Implementations

impl ConstantArray

pub fn new<S>(scalar: S, len: usize) -> ConstantArray

where S: Into<Scalar>,

pub fn scalar(&self) -> &Scalar

Returns the Scalar value of this constant array.

Methods from Deref<Target = dyn Array>

pub fn display_values(&self) -> impl Display

Display logical values of the array

For example, an i16 typed array containing the first five non-negative integers is displayed as: [0i16, 1i16, 2i16, 3i16, 4i16].

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array.display_values()),
    "[0i16, 1i16, 2i16, 3i16, 4i16]",
)

See also: Array::display_as, DisplayArrayAs, and DisplayOptions.

pub fn display_as(&self, options: DisplayOptions) -> impl Display

Display the array as specified by the options.

See DisplayOptions for examples.

pub fn display_tree(&self) -> impl Display

Display the tree of encodings of this array as an indented lists.

While some metadata (such as length, bytes and validity-rate) are included, the logical values of the array are not displayed. To view the logical values see Array::display_as and DisplayOptions.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
  metadata: EmptyMetadata
  buffer (align=2): 10 B (100.00%)
";
assert_eq!(format!("{}", array.display_tree()), expected);

pub fn display_table(&self) -> impl Display

Display the array as a formatted table.

For struct arrays, displays a column for each field in the struct. For regular arrays, displays a single column with values.

Examples

let s = StructArray::from_fields(&[
    ("x", buffer![1, 2].into_array()),
    ("y", buffer![3, 4].into_array()),
]).unwrap().into_array();
let expected = "
┌──────┬──────┐
│  x   │  y   │
├──────┼──────┤
│ 1i32 │ 3i32 │
├──────┼──────┤
│ 2i32 │ 4i32 │
└──────┴──────┘".trim();
assert_eq!(format!("{}", s.display_table()), expected);

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

where V: VTable,

Returns the array downcast to the given A.

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

where V: VTable,

Returns the array downcast to the given A.

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

where V: VTable,

Is self an array with encoding from vtable V.

pub fn is_constant(&self) -> bool

pub fn is_constant_opts(&self, cost: Cost) -> bool

pub fn as_constant(&self) -> Option<Scalar>

pub fn nbytes(&self) -> u64

Total size of the array in bytes, including all children and buffers.

pub fn try_to_mask_fill_null_false(&self) -> Result<Mask, VortexError>

Converts from a possible nullable boolean array. Null values are treated as false.

pub fn to_array_iterator(&self) -> impl ArrayIterator + 'static

Create an ArrayIterator over the array.

pub fn serialize( &self, ctx: &VTableContext<ArcRef<dyn Encoding>>, options: &SerializeOptions, ) -> Result<Vec<Buffer<u8>>, VortexError>

Serialize the array into a sequence of byte buffers that should be written contiguously. This function returns a vec to avoid copying data buffers.

Optionally, padding can be included to guarantee buffer alignment and ensure zero-copy reads within the context of an external file or stream. In this case, the alignment of the first byte buffer should be respected when writing the buffers to the stream or file.

The format of this blob is a sequence of data buffers, possible with prefixed padding, followed by a flatbuffer containing an fba::Array message, and ending with a little-endian u32 describing the length of the flatbuffer message.

pub fn to_array_stream(&self) -> impl ArrayStream + 'static

Create an ArrayStream over the array.

pub fn as_null_typed(&self) -> NullTyped<'_>

Downcasts the array for null-specific behavior.

pub fn as_bool_typed(&self) -> BoolTyped<'_>

Downcasts the array for bool-specific behavior.

pub fn as_primitive_typed(&self) -> PrimitiveTyped<'_>

Downcasts the array for primitive-specific behavior.

pub fn as_decimal_typed(&self) -> DecimalTyped<'_>

Downcasts the array for decimal-specific behavior.

pub fn as_utf8_typed(&self) -> Utf8Typed<'_>

Downcasts the array for utf8-specific behavior.

pub fn as_binary_typed(&self) -> BinaryTyped<'_>

Downcasts the array for binary-specific behavior.

pub fn as_struct_typed(&self) -> StructTyped<'_>

Downcasts the array for struct-specific behavior.

pub fn as_list_typed(&self) -> ListTyped<'_>

Downcasts the array for list-specific behavior.

pub fn as_extension_typed(&self) -> ExtensionTyped<'_>

Downcasts the array for extension-specific behavior.

Trait Implementations

impl AsRef<dyn Array> for ConstantArray

fn as_ref(&self) -> &(dyn Array + 'static)

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

impl Clone for ConstantArray

fn clone(&self) -> ConstantArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConstantArray

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

Formats the value using the given formatter.

impl Deref for ConstantArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &<ConstantArray as Deref>::Target

Dereferences the value.

impl From<ConstantArray> for Arc<dyn Array>

fn from(value: ConstantArray) -> Arc<dyn Array>

Converts to this type from the input type.

impl IntoArray for ConstantArray

fn into_array(self) -> Arc<dyn Array>

impl Operator for ConstantArray

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<ConstantArray>, _children: Vec<Arc<dyn Operator>>, ) -> Result<Arc<dyn Operator>, VortexError>

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

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.

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.

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

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

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.

impl OperatorEq for ConstantArray

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

impl OperatorHash for ConstantArray

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

where H: Hasher,

impl PipelinedOperator for ConstantArray

fn bind(&self, _ctx: &dyn BindContext) -> Result<Box<dyn Kernel>, VortexError>

Bind the operator into a Kernel for pipelined execution.

fn vector_children(&self) -> Vec<usize>

Returns the child indices of this operator that are passed to the kernel as input vectors.

fn batch_children(&self) -> Vec<usize>

Returns the child indices of this operator that are passed to the kernel as batch inputs.