Struct NdRecordBatch 

pub struct NdRecordBatch { /* private fields */ }

A record batch whose columns are NdArrowArrays over a shared target grid.

Each column can use a subset of the target dimensions: a scalar attribute, a 1-D coordinate, a full-rank data variable. Columns stay un-broadcast. The schema is the logical schema: one field per column, typed by its values. Global attributes describe the whole batch, like xarray Dataset.attrs.

Implementations

impl NdRecordBatch

pub fn try_new( schema: SchemaRef, columns: Vec<NdArrowArray>, target: Dimensions, ) -> Result<Self>

Create a batch. The schema must match the column types, and every column must broadcast onto target.

pub fn with_attributes(self, attributes: Attributes) -> Self

Replace the global attributes.

pub fn attributes(&self) -> &Attributes

The global attributes of the batch.

pub fn attributes_mut(&mut self) -> &mut Attributes

The global attributes, for changes in place.

pub fn try_new_inferred( schema: SchemaRef, columns: Vec<NdArrowArray>, ) -> Result<Self>

A batch with the target grid inferred by infer_target.

pub fn schema(&self) -> &SchemaRef

The logical schema: one field per column, typed by its values.

pub fn columns(&self) -> &[NdArrowArray]

All columns, in schema order.

pub fn column(&self, index: usize) -> &NdArrowArray

The column at index. Panics when index is out of bounds.

pub fn column_by_name(&self, name: &str) -> Option<&NdArrowArray>

The column named name, if present.

pub fn num_columns(&self) -> usize

The number of columns.

pub fn target(&self) -> &Dimensions

The shared target grid.

pub fn num_rows(&self) -> usize

Rows after a broadcast onto the full target grid.

pub fn to_record_batch(&self) -> Result<RecordBatch>

Encode as a single-row RecordBatch of nd columns.

pub fn try_from_record_batch(batch: &RecordBatch) -> Result<Vec<Self>>

Decode every row of an nd-encoded RecordBatch: one nd batch per row.

pub fn try_from_record_batch_row( batch: &RecordBatch, row: usize, ) -> Result<Self>

Decode row row of an nd-encoded RecordBatch.

impl NdRecordBatch

pub fn materialize(&self) -> Result<RecordBatch>

Broadcast every column onto the target grid and return a flat RecordBatch with one row per grid cell, in C order.

pub fn coordinate(&self, dim: &str) -> Option<&NdArrowArray>

The coordinate of dim: a column named dim with dimensions (dim).

pub fn isel(&self, selections: &[(&str, Selector)]) -> Result<Self>

Select by position on target dimensions, like xarray Dataset.isel. The batch kernels keep the global attributes.

Each column gets the selections of its own dimensions. A column with size 1 on a selected dimension keeps broadcasting, and an index selection removes that axis.

pub fn sel_range( &self, dim: &str, start: Option<&ArrayRef>, end: Option<&ArrayRef>, ) -> Result<Self>

Select the positions whose coordinate lies in [start, end], like xarray sel with a label slice. An open end is None.

The coordinate must be sorted, ascending or descending, without nulls.

pub fn sel_nearest(&self, dim: &str, value: &ArrayRef) -> Result<Self>

Select the position whose coordinate is nearest to value, like xarray sel(method="nearest"). The dimension is removed. Ties pick the first.

pub fn interp(&self, dim: &str, new_coords: &NdArrowArray) -> Result<Self>

Interpolate every column along dim onto new_coords, see interp.

Columns that span dim must be numeric and become floating point. The coordinate becomes new_coords. Other columns stay unchanged.

pub fn resample( &self, dim: &str, freq: Frequency, op: Reduction, ) -> Result<Self>

Resample every column along dim with the time coordinate of dim, see resample.

Columns that span dim are reduced with op. The coordinate becomes the bin starts. Other columns stay unchanged.

Trait Implementations

impl Clone for NdRecordBatch

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 NdRecordBatch

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

Formats the value using the given formatter.