Struct Array2 

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

Owned 2D row-major array.

Implementations

impl<T> Array2<T>

pub fn from_vec(shape: [usize; 2], data: Vec<T>) -> Result<Self>

Build an array from row-major data.

pub fn from_fn(shape: [usize; 2], f: impl FnMut(usize, usize) -> T) -> Self

Build an array from a function over (row, col).

pub fn try_from_fn( shape: [usize; 2], f: impl FnMut(usize, usize) -> T, ) -> Result<Self>

Fallibly build an array from a function over (row, col).

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

Shape as [rows, cols].

pub fn rows(&self) -> usize

Number of rows.

pub fn cols(&self) -> usize

Number of columns.

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

Row-major strides in elements.

pub fn row_stride(&self) -> isize

Distance in elements between consecutive rows.

pub fn col_stride(&self) -> isize

Distance in elements between consecutive columns.

pub fn leading_dimension(&self) -> isize

Leading dimension for row-major storage.

pub fn len(&self) -> usize

Number of elements.

pub fn is_empty(&self) -> bool

Whether the array has zero elements.

pub fn is_contiguous(&self) -> bool

Owned arrays are compact row-major contiguous.

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

Borrow the row-major backing slice.

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

Borrow the row-major backing slice mutably.

pub fn into_vec(self) -> Vec<T>

Consume into the backing vector.

pub fn view(&self) -> ArrayView2<'_, T>

Immutable strided view.

pub fn view_mut(&mut self) -> ArrayViewMut2<'_, T>

Mutable strided view.

pub fn transpose_view(&self) -> ArrayView2<'_, T>

Transpose view without copying.

pub fn get(&self, row: usize, col: usize) -> Option<&T>

Get an element reference.

pub fn get_mut(&mut self, row: usize, col: usize) -> Option<&mut T>

Get a mutable element reference.

pub fn row(&self, row: usize) -> Result<ArrayView2<'_, T>>

Row as a one-row matrix view.

pub fn row_slice(&self, row: usize) -> Result<&[T]>

Borrow a row as a contiguous slice.

pub fn row_mut(&mut self, row: usize) -> Result<ArrayViewMut2<'_, T>>

Mutable row as a one-row matrix view.

pub fn row_slice_mut(&mut self, row: usize) -> Result<&mut [T]>

Borrow a row as a mutable contiguous slice.

pub fn col(&self, col: usize) -> Result<ArrayView2<'_, T>>

Column as an rows x 1 matrix view.

pub fn col_mut(&mut self, col: usize) -> Result<ArrayViewMut2<'_, T>>

Mutable column as an rows x 1 matrix view.

pub fn rows_range(&self, start: usize, end: usize) -> Result<ArrayView2<'_, T>>

Half-open row slice.

pub fn rows_range_mut( &mut self, start: usize, end: usize, ) -> Result<ArrayViewMut2<'_, T>>

Mutable half-open row slice.

pub fn cols_range(&self, start: usize, end: usize) -> Result<ArrayView2<'_, T>>

Half-open column slice.

pub fn cols_range_mut( &mut self, start: usize, end: usize, ) -> Result<ArrayViewMut2<'_, T>>

Mutable half-open column slice.

pub fn reshape(self, shape: [usize; 2]) -> Result<Self>

Reshape without changing storage order.

impl<T: Clone> Array2<T>

pub fn filled(shape: [usize; 2], value: T) -> Self

Fill a new array with value.

pub fn try_filled(shape: [usize; 2], value: T) -> Result<Self>

Fallibly fill a new array with value.

pub fn clone_contiguous(view: ArrayView2<'_, T>) -> Self

Clone into compact row-major storage.

pub fn to_row_major(&self) -> Self

Copy this array into compact row-major storage.

pub fn to_col_major_vec(&self) -> Vec<T>

Copy this array into a column-major vector.

pub fn copy_from_view(&mut self, other: ArrayView2<'_, T>) -> Result<()>

Copy values from another view with the same shape.

impl<T: Float> Array2<T>

pub fn zeros(shape: [usize; 2]) -> Self

Array filled with zeros.

pub fn try_zeros(shape: [usize; 2]) -> Result<Self>

Fallibly allocate an array filled with zeros.

pub fn ones(shape: [usize; 2]) -> Self

Array filled with ones.

pub fn try_ones(shape: [usize; 2]) -> Result<Self>

Fallibly allocate an array filled with ones.

pub fn zeros_like(&self) -> Self

Allocate another array with the same shape, filled with zeros.

pub fn scale(&mut self, alpha: T)

Scale in place.

pub fn scaled(&self, alpha: T) -> Self

Return self * alpha without modifying self.

pub fn scaled_into(&self, alpha: T, out: ArrayViewMut2<'_, T>) -> Result<()>

Write self * alpha into out without modifying self.

pub fn add(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return self + other without modifying either input.

pub fn add_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write self + other into out without modifying either input.

pub fn sub(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return self - other without modifying either input.

pub fn sub_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write self - other into out without modifying either input.

pub fn mul(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return the elementwise product self * other without modifying either input.

pub fn mul_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write the elementwise product into out without modifying either input.

pub fn hadamard(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return the Hadamard product without modifying either input.

pub fn hadamard_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write the Hadamard product into out without modifying either input.

pub fn div(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return the elementwise quotient self / other without modifying either input.

pub fn div_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write the elementwise quotient into out without modifying either input.

pub fn axpy_result(&self, alpha: T, x: ArrayView2<'_, T>) -> Result<Self>

Return self + alpha * x without modifying either input.

pub fn axpy_into( &self, alpha: T, x: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write self + alpha * x into out without modifying either input.

pub fn matmul(&self, other: ArrayView2<'_, T>) -> Result<Self>

Return a matrix product self @ other without modifying either input.

pub fn matmul_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, ) -> Result<()>

Write matrix product self @ other into out without modifying either input.

pub fn add_assign_view(&mut self, other: ArrayView2<'_, T>) -> Result<()>

In-place addition.

pub fn sub_assign_view(&mut self, other: ArrayView2<'_, T>) -> Result<()>

In-place subtraction.

pub fn mul_assign_view(&mut self, other: ArrayView2<'_, T>) -> Result<()>

Hadamard product in place.

pub fn div_assign_view(&mut self, other: ArrayView2<'_, T>) -> Result<()>

In-place elementwise division.

pub fn axpy(&mut self, alpha: T, x: ArrayView2<'_, T>) -> Result<()>

Compute self += alpha * x.

pub fn map_inplace(&mut self, f: impl FnMut(T) -> T)

Map values in place.

pub fn zip_map_inplace( &mut self, other: ArrayView2<'_, T>, f: impl FnMut(T, T) -> T, ) -> Result<()>

Zip-map another view into this array in place.

pub fn zip_map( &self, other: ArrayView2<'_, T>, f: impl FnMut(T, T) -> T, ) -> Result<Self>

Return an elementwise zip-map without modifying either input.

pub fn zip_map_into( &self, other: ArrayView2<'_, T>, out: ArrayViewMut2<'_, T>, f: impl FnMut(T, T) -> T, ) -> Result<()>

Write an elementwise zip-map into out without modifying either input.

pub fn fill_uniform(&mut self, seed: u64)

Fill with deterministic uniform random values in [0, 1).

pub fn fill_randn(&mut self, seed: u64)

Fill with deterministic standard-normal random values.

pub fn sum(&self) -> T

Sum all elements.

pub fn mean(&self) -> T

Mean of all elements, or zero for an empty array.

pub fn norm_frobenius(&self) -> T

Frobenius norm.

pub fn max_abs(&self) -> T

Maximum absolute element, or zero for an empty array.

pub fn dot(&self, other: ArrayView2<'_, T>) -> Result<T>

Dot product of two arrays treated as flattened row-major buffers.

Trait Implementations

impl<T: Clone> Clone for Array2<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Array2<T>

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

Formats the value using the given formatter.

impl<T> Index<(usize, usize)> for Array2<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for Array2<T>

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

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

impl<T: Float> LinearOperator<T> for Array2<T>

fn rows(&self) -> usize

Number of rows.

fn cols(&self) -> usize

Number of columns.

fn matvec(&self, x: &[T], y: &mut [T]) -> Result<()>

Compute y = A x.

fn t_matvec(&self, x: &[T], y: &mut [T]) -> Result<()>

Compute y = A^T x.

fn matmat(&self, x: ArrayView2<'_, T>, y: ArrayViewMut2<'_, T>) -> Result<()>

Compute Y = A X.

fn t_matmat(&self, x: ArrayView2<'_, T>, y: ArrayViewMut2<'_, T>) -> Result<()>

Compute Y = A^T X.

impl<T: PartialEq> PartialEq for Array2<T>

fn eq(&self, other: &Array2<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 Array2<T>