Skip to main content

ArrayView2

Struct ArrayView2 

Source
pub struct ArrayView2<'a, T> { /* private fields */ }
Expand description

Immutable 2D array view.

Implementations§

Source§

impl<'a, T> ArrayView2<'a, T>

Source

pub fn new( data: &'a [T], shape: [usize; 2], strides: [isize; 2], offset: isize, ) -> Result<Self>

Create a checked immutable view.

Source

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

Shape as [rows, cols].

Source

pub fn rows(&self) -> usize

Number of rows.

Source

pub fn cols(&self) -> usize

Number of columns.

Source

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

Strides in elements.

Source

pub fn row_stride(&self) -> isize

Distance in elements between consecutive rows.

Source

pub fn col_stride(&self) -> isize

Distance in elements between consecutive columns.

Source

pub fn leading_dimension(&self) -> isize

Leading dimension for the current row-major-style view.

Source

pub fn len(&self) -> usize

Number of elements in the logical view.

Source

pub fn is_empty(&self) -> bool

Whether the logical view has no elements.

Source

pub fn is_contiguous(&self) -> bool

Whether the view is compact row-major contiguous.

Source

pub fn as_slice(&self) -> Option<&'a [T]>

Borrow the backing slice if this view covers it contiguously.

Source

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

Get a copied reference at (row, col).

Source

pub fn transpose(self) -> Self

Return a transpose view without copying.

Source

pub fn row(&self, row: usize) -> Result<Self>

Return a row view as a one-row matrix.

Source

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

Borrow a row as a contiguous slice when the row layout permits it.

Source

pub fn col(&self, col: usize) -> Result<Self>

Return a column view as an rows x 1 matrix.

Source

pub fn rows_range(&self, start: usize, end: usize) -> Result<Self>

Slice a half-open row range.

Source

pub fn cols_range(&self, start: usize, end: usize) -> Result<Self>

Slice a half-open column range.

Source§

impl<T: Clone> ArrayView2<'_, T>

Source

pub fn to_row_major(&self) -> Array2<T>

Copy this view into compact row-major storage.

Source

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

Copy this view into a column-major vector.

Trait Implementations§

Source§

impl<'a, T: Clone> Clone for ArrayView2<'a, T>

Source§

fn clone(&self) -> ArrayView2<'a, T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Debug> Debug for ArrayView2<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Index<(usize, usize)> for ArrayView2<'_, T>

Source§

type Output = T

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl<T: Float> LinearOperator<T> for ArrayView2<'_, T>

Source§

fn rows(&self) -> usize

Number of rows.
Source§

fn cols(&self) -> usize

Number of columns.
Source§

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

Compute y = A x.
Source§

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

Compute y = A^T x.
Source§

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

Compute Y = A X.
Source§

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

Compute Y = A^T X.
Source§

impl<'a, T: Copy> Copy for ArrayView2<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for ArrayView2<'a, T>

§

impl<'a, T> RefUnwindSafe for ArrayView2<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for ArrayView2<'a, T>
where T: Sync,

§

impl<'a, T> Sync for ArrayView2<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for ArrayView2<'a, T>

§

impl<'a, T> UnsafeUnpin for ArrayView2<'a, T>

§

impl<'a, T> UnwindSafe for ArrayView2<'a, T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.