Struct Array 

pub struct Array { /* private fields */ }

A lazily evaluated n-dimensional array.

Cloning is cheap: clones share the computation and its result. Operations record a graph node and return immediately; values are computed on Array::eval, crate::eval, or when read back.

Implementations

impl Array

pub fn from_slice<T: Element>(data: &[T], shape: &[usize]) -> Result<Self>

An array holding data with the given shape.

Fails with Error::SizeMismatch if data.len() is not the shape’s element count.

pub fn full<T: Element>(shape: &[usize], value: T) -> Result<Self>

An array of the given shape with every element set to value.

pub fn scalar<T: Element>(value: T) -> Self

A zero-dimensional array holding value.

pub fn from_primitive( primitive: Primitive, inputs: Vec<Array>, ) -> Result<Vec<Array>>

Records primitive applied to inputs, with the same validation as the operations, and returns one array per output. Inputs that already failed short-circuit with their error.

pub fn placeholder(dtype: DType, shape: &[usize]) -> Result<Array>

A placeholder with this dtype and shape, standing for an input while a function is traced (as in MLX): operations can be recorded on it, but evaluating anything that depends on it fails. Placeholders are tracers.

pub fn inputs(&self) -> Vec<Array>

The arrays this one is computed from, until it has been evaluated. Empty for host data and evaluated arrays.

pub fn siblings(&self) -> Vec<Array>

Every output of the operation that produces this array, in order (this array is the one at Array::output_index).

pub fn output_index(&self) -> usize

Which output of its operation this array is.

pub fn id(&self) -> usize

Identifies the operation that produces this array (shared by its siblings) for as long as the array is alive.

pub fn is_tracer(&self) -> bool

Whether the array depends on a transform’s tracer or a placeholder, that is, it is being traced by grad, vjp, jvp, vmap or compile.

pub fn shape(&self) -> &[usize]

Dimension sizes.

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn size(&self) -> usize

Number of elements.

pub fn dtype(&self) -> DType

Element type.

pub fn itemsize(&self) -> usize

Size of one element in bytes.

pub fn nbytes(&self) -> usize

Size of all elements in bytes.

pub fn strides(&self) -> &[isize]

Per-dimension steps, in elements.

pub fn flags(&self) -> Flags

Memory-layout flags.

pub fn stream(&self) -> Stream

The stream the producing operation was recorded on.

pub fn device(&self) -> Device

The device the producing operation runs on.

pub fn is_evaluated(&self) -> bool

Whether the array has been evaluated (successfully or not).

pub fn primitive(&self) -> Option<Primitive>

The operation that produces this array, until it has been evaluated. None for host data and evaluated arrays.

pub fn eval(&self) -> Result<()>

Evaluates this array, if it has not been evaluated yet.

pub fn to_vec<T: Element>(&self) -> Result<Vec<T>>

The elements in row-major order, evaluating first if needed.

pub fn item<T: Element>(&self) -> Result<T>

The single element of a one-element array, evaluating first if needed.

impl Array

pub fn astype(&self, dtype: DType) -> Result<Array>

Converts the elements to dtype; see astype.

pub fn reshape(&self, shape: &[isize]) -> Result<Array>

The same elements in another shape; see reshape.

pub fn t(&self) -> Result<Array>

The array with all axes reversed (the matrix transpose for 2-D arrays).

Trait Implementations

impl Add for Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<&Array> for &Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for bool

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for i32

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for f64

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for f16

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for bf16

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<&Array> for Complex64

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: &Array) -> Array

Performs the + operation.

impl Add<Array> for &Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for bool

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for i32

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for f64

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for f16

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for bf16

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl Add<Array> for Complex64

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Array

Performs the + operation.

impl<S: ScalarOperand> Add<S> for &Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: S) -> Array

Performs the + operation.

impl<S: ScalarOperand> Add<S> for Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: S) -> Array

Performs the + operation.

impl Clone for Array

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 Array

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

Formats the value using the given formatter.

impl Div for Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<&Array> for &Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for bool

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for i32

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for f64

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for f16

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for bf16

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<&Array> for Complex64

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: &Array) -> Array

Performs the / operation.

impl Div<Array> for &Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for bool

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for i32

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for f64

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for f16

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for bf16

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl Div<Array> for Complex64

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Array) -> Array

Performs the / operation.

impl<S: ScalarOperand> Div<S> for &Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Array

Performs the / operation.

impl<S: ScalarOperand> Div<S> for Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Array

Performs the / operation.

impl From<&Array> for ScalarOrArray

fn from(a: &Array) -> Self

Converts to this type from the input type.

impl From<Array> for ScalarOrArray

fn from(a: Array) -> Self

Converts to this type from the input type.

impl Mul for Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<&Array> for &Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for bool

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for i32

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for f64

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for f16

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for bf16

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<&Array> for Complex64

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: &Array) -> Array

Performs the * operation.

impl Mul<Array> for &Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for bool

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for i32

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for f64

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for f16

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for bf16

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl Mul<Array> for Complex64

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Array) -> Array

Performs the * operation.

impl<S: ScalarOperand> Mul<S> for &Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: S) -> Array

Performs the * operation.

impl<S: ScalarOperand> Mul<S> for Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: S) -> Array

Performs the * operation.

impl Neg for &Array

type Output = Array

The resulting type after applying the - operator.

fn neg(self) -> Array

Performs the unary - operation.

impl Neg for Array

type Output = Array

The resulting type after applying the - operator.

fn neg(self) -> Array

Performs the unary - operation.

impl Sub for Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<&Array> for &Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for bool

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for i32

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for f64

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for f16

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for bf16

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<&Array> for Complex64

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: &Array) -> Array

Performs the - operation.

impl Sub<Array> for &Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for bool

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for i32

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for f64

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for f16

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for bf16

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl Sub<Array> for Complex64

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Array) -> Array

Performs the - operation.

impl<S: ScalarOperand> Sub<S> for &Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: S) -> Array

Performs the - operation.

impl<S: ScalarOperand> Sub<S> for Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: S) -> Array

Performs the - operation.