Struct MlxArrayVector 

pub struct MlxArrayVector(/* private fields */);

Temporary MLX vector that retains array handles for one aggregate operation.

Implementations

impl MlxArrayVector

pub fn empty(operation: &'static str) -> Result<Self, MlxCError>

pub fn new(arrays: &[&MlxArray]) -> Result<Self, MlxCError>

pub const fn raw(&self) -> mlx_vector_array

pub fn raw_mut(&mut self) -> *mut mlx_vector_array

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Reports whether the vector holds no arrays.

pub fn array_at( &self, output_index: usize, operation: &'static str, ) -> Result<MlxArray, MlxCError>

pub fn set(&mut self, source: &Self) -> Result<(), MlxCError>

Copies the source vector handle into this handle.

pub fn from_array(array: &MlxArray) -> Result<Self, MlxCError>

Creates an owned vector holding one copied array handle.

pub fn set_arrays(&mut self, arrays: &[MlxArray]) -> Result<(), MlxCError>

Replaces the vector contents with copies of the provided arrays.

pub fn set_one(&mut self, array: &MlxArray) -> Result<(), MlxCError>

Replaces the vector contents with one copied array handle.

pub fn append_array(&mut self, array: &MlxArray) -> Result<(), MlxCError>

Appends one copied array handle.

pub fn append_arrays(&mut self, arrays: &[MlxArray]) -> Result<(), MlxCError>

Appends copies of the provided array handles.

Trait Implementations

impl Debug for MlxArrayVector

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

Formats the value using the given formatter.

impl Drop for MlxArrayVector

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.