Struct Array

pub struct Array<T> { /* private fields */ }

An N-dimensional strided array.

Implementations

impl<T> Array<T>

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable reference to the underlying data as a flat slice in row-major order.

pub fn as_slice(&self) -> &[T]

Returns the underlying data as a flat slice in row-major order.

pub fn dimensions(&self) -> usize

Returns the number of dimensions of the array.

pub fn elements(&self) -> usize

Returns the number of elements in the array.

pub fn from_element<S>(element: T, shape: S) -> Self

where T: Clone, S: Into<Shape>,

Creates a new array by repeating a single element to a shape.

pub fn from_iter<I, S>(iter: I, shape: S) -> Result<Self, ShapeError>

where I: IntoIterator<Item = T>, S: Into<Shape>,

Creates a new array from an iterator an its shape.

Errors

If the number of items in the iterator does not match the provided shape.

pub fn get<I>(&self, index: I) -> Option<&T>

where I: AsRef<[usize]>,

Returns the element at the provided index if in bounds, and None otherwise,

pub fn get_axis(&self, axis: Axis, index: usize) -> Option<View<'_, T>>

Returns a view of the array along the provided axis at the provided index if in bounds, and None otherwise.

See Array::index_axis for a panicking version.

pub fn get_mut<I>(&mut self, index: I) -> Option<&mut T>

where I: AsRef<[usize]>,

Returns a mutable reference to the element at the provided index if in bounds, and None otherwise,

pub fn index_axis(&self, axis: Axis, index: usize) -> View<'_, T>

Returns a view of the array along the provided axis at the provided index if in bounds.

Panics

If the axis or the index is not in bounds, see Array::get_axis for a fallible version.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the underlying data in row-major order.

pub fn iter_axis(&self, axis: Axis) -> AxisIter<'_, T>

Returns an iterator over views of the array along the provided axis.

pub fn iter_indices(&self) -> IndicesIter<'_>

Returns an iterator over indices of the array in row-major order.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns an iterator over mutable references to the underlying data in row-major order.

pub fn new<D, S>(data: D, shape: S) -> Result<Self, ShapeError>

where D: Into<Vec<T>>, S: Into<Shape>,

Creates a new array from data in row-major order and a shape.

Errors

If the number of items in the data does not match the provided shape.

pub fn new_unchecked<D, S>(data: D, shape: S) -> Self

where D: Into<Vec<T>>, S: Into<Shape>,

Creates a new array from data in row-major order and a shape.

Prefer using Array::new to ensure the data fits the provided shape. It is a logic error where this is not true, though it can not trigger unsafe behaviour.

pub fn shape(&self) -> &Shape

Returns the shape of the array.

impl Array<f64>

pub fn from_zeros<S>(shape: S) -> Self

where S: Into<Shape>,

Creates a new array filled with zeros to a shape.

pub fn read_npy<R>(reader: R) -> Result<Self>

where R: BufRead,

Reads an array from the npy format.

See the format docs for details.

pub fn sum(&self, axis: Axis) -> Self

Returns the sum of the elements in the array.

pub fn write_npy<W>(&self, writer: W) -> Result<()>

where W: Write,

Writes the in the npy format.

See the format docs for details.

Trait Implementations

impl<T: Clone> Clone for Array<T>

fn clone(&self) -> Array<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Array<T>

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

Formats the value using the given formatter.

impl From<Array<f64>> for Scs

fn from(array: Array<f64>) -> Self

Converts to this type from the input type.

impl<T, I> Index<I> for Array<T>

where I: AsRef<[usize]>,

type Output = T

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, I> IndexMut<I> for Array<T>

where I: AsRef<[usize]>,

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq> PartialEq for Array<T>

fn eq(&self, other: &Array<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for Array<T>