Struct NdArrowArray 

pub struct NdArrowArray { /* private fields */ }

A flat Arrow array plus named C-order dimensions and attributes.

Invariant: dims.num_elements() == values.len(). Validity travels in the null buffer of the values. There is no separate mask or fill value, so readers map fill values to nulls when they build the values.

Implementations

impl NdArrowArray

pub fn try_new(values: ArrayRef, dims: Dimensions) -> Result<Self>

Create an array. The length of values must equal the number of elements of dims.

pub fn try_new_scalar(value: ArrayRef) -> Result<Self>

A rank-0 array. value must have length 1.

pub fn new_null_scalar(data_type: &DataType) -> Self

A rank-0 array holding one null of data_type.

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

Replace the attributes.

pub fn values(&self) -> &ArrayRef

The flat values in C order.

pub fn dims(&self) -> &Dimensions

The named dimensions.

pub fn attributes(&self) -> &Attributes

The attributes.

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

The attributes, for changes in place.

pub fn data_type(&self) -> &DataType

The Arrow type of the values.

pub fn shape(&self) -> Vec<usize>

The size of each axis.

pub fn rank(&self) -> usize

The number of axes.

pub fn len(&self) -> usize

Number of logical elements, equal to the length of the values.

pub fn is_empty(&self) -> bool

True when the array has no elements.

pub fn is_scalar(&self) -> bool

True for rank 0.

pub fn reshape(self, dims: Dimensions) -> Result<Self>

Replace the dimensions without a copy of the values. The new dimensions must hold the same number of elements.

pub fn into_parts(self) -> (ArrayRef, Dimensions, Attributes)

Split into values, dimensions and attributes.

impl NdArrowArray

pub fn broadcast_to(&self, target: &Dimensions) -> Result<Self>

See compute::broadcast_to.

pub fn transpose(&self, order: &[&str]) -> Result<Self>

See compute::transpose.

pub fn squeeze(&self, dims: Option<&[&str]>) -> Result<Self>

See compute::squeeze.

pub fn expand_dims(&self, name: &str, axis: usize) -> Result<Self>

See compute::expand_dims.

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

See compute::isel.

pub fn cast(&self, to: &DataType) -> Result<Self>

See compute::cast.

pub fn fill_null(&self, value: &ArrayRef) -> Result<Self>

See compute::fill_null.

pub fn sum(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::sum.

pub fn mean(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::mean.

pub fn min(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::min.

pub fn max(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::max.

pub fn count(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::count.

pub fn std(&self, axes: Option<&[&str]>, ddof: usize) -> Result<Self>

See compute::std.

pub fn var(&self, axes: Option<&[&str]>, ddof: usize) -> Result<Self>

See compute::var.

pub fn median(&self, axes: Option<&[&str]>) -> Result<Self>

See compute::median.

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

See compute::resample().

impl NdArrowArray

pub fn to_ndarray<T: ArrowPrimitiveType>(&self) -> Result<ArrayD<T::Native>>

Copy the values into an ndarray array of the same shape. The values must be of type T and without nulls.

pub fn from_ndarray<T: ArrowPrimitiveType>( array: &ArrayD<T::Native>, names: &[&str], ) -> Result<Self>

Build an nd array from an ndarray array in any memory layout, with one dimension name per axis.

Trait Implementations

impl Add<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the + operator.

fn add(self, rhs: &NdArrowArray) -> Self::Output

Performs the + operation.

impl BitAnd<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the & operator.

fn bitand(self, rhs: &NdArrowArray) -> Self::Output

Performs the & operation.

impl BitOr<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the | operator.

fn bitor(self, rhs: &NdArrowArray) -> Self::Output

Performs the | operation.

impl BitXor<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &NdArrowArray) -> Self::Output

Performs the ^ operation.

impl Clone for NdArrowArray

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 NdArrowArray

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

Formats the value using the given formatter.

impl Display for NdArrowArray

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

Formats the value using the given formatter.

impl Div<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the / operator.

fn div(self, rhs: &NdArrowArray) -> Self::Output

Performs the / operation.

impl Mul<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the * operator.

fn mul(self, rhs: &NdArrowArray) -> Self::Output

Performs the * operation.

impl Neg for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation using logical or bitwise negation.

impl PartialEq for NdArrowArray

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Rem<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the % operator.

fn rem(self, rhs: &NdArrowArray) -> Self::Output

Performs the % operation.

impl Sub<&NdArrowArray> for &NdArrowArray

type Output = Result<NdArrowArray, NdError>

The resulting type after applying the - operator.

fn sub(self, rhs: &NdArrowArray) -> Self::Output

Performs the - operation.