Type Definition ndarray::ArrayViewMut

pub type ArrayViewMut<'a, A, D> = ArrayBase<ViewRepr<&'a mut A>, D>;

A read-write array view.

An array view represents an array or a part of it, created from an iterator, subview or slice of an array.

The ArrayViewMut<'a, A, D> is parameterized by 'a for the scope of the borrow, A for the element type and D for the dimensionality.

Array views have all the methods of an array (see ArrayBase).

See also ArrayView.

Implementations

impl<'a, A, D> ArrayViewMut<'a, A, D>where
    D: Dimension,

Methods for read-write array views.

pub fn from_shape<Sh>(shape: Sh, xs: &'a mut [A]) -> Result<Self, ShapeError>where
    Sh: Into<StrideShape<D>>,

Create a read-write array view borrowing its data from a slice.

Checks whether dim and strides are compatible with the slice’s length, returning an Err if not compatible.

use ndarray::ArrayViewMut;
use ndarray::arr3;
use ndarray::ShapeBuilder;

let mut s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
let mut a = ArrayViewMut::from_shape((2, 3, 2).strides((1, 4, 2)),
                                     &mut s).unwrap();

a[[0, 0, 0]] = 1;
assert!(
    a == arr3(&[[[1, 2],
                 [4, 6],
                 [8, 10]],
                [[1, 3],
                 [5, 7],
                 [9, 11]]])
);
assert!(a.strides() == &[1, 4, 2]);

pub unsafe fn from_shape_ptr<Sh>(shape: Sh, ptr: *mut A) -> Selfwhere
    Sh: Into<StrideShape<D>>,

Create an ArrayViewMut<A, D> from shape information and a raw pointer to the elements.

Unsafe because caller is responsible for ensuring all of the following:

• The elements seen by moving ptr according to the shape and strides must live at least as long as 'a and must not be aliased for the duration of 'a.

• ptr must be non-null and aligned, and it must be safe to .offset() ptr by zero.

• It must be safe to .offset() the pointer repeatedly along all axes and calculate the counts for the .offset() calls without overflow, even if the array is empty or the elements are zero-sized.

  In other words,

  • All possible pointers generated by moving along all axes must be in bounds or one byte past the end of a single allocation with element type A. The only exceptions are if the array is empty or the element type is zero-sized. In these cases, ptr may be dangling, but it must still be safe to .offset() the pointer along the axes.

  • The offset in units of bytes between the least address and greatest address by moving along all axes must not exceed isize::MAX. This constraint prevents the computed offset, in bytes, from overflowing isize regardless of the starting point due to past offsets.

  • The offset in units of A between the least address and greatest address by moving along all axes must not exceed isize::MAX. This constraint prevents overflow when calculating the count parameter to .offset() regardless of the starting point due to past offsets.

• The product of non-zero axis lengths must not exceed isize::MAX.

pub fn reborrow<'b>(self) -> ArrayViewMut<'b, A, D>where
    'a: 'b,

Convert the view into an ArrayViewMut<'b, A, D> where 'b is a lifetime outlived by 'a'.

pub fn split_at(self, axis: Axis, index: Ix) -> (Self, Self)

Split the array view along axis and return one mutable view strictly before the split and one mutable view after the split.

Panics if axis or index is out of bounds.

pub fn into_slice(self) -> Option<&'a mut [A]>

Return the array’s data as a slice, if it is contiguous and in standard order. Return None otherwise.

Trait Implementations

impl<'a, A, S, D> From<&'a mut ArrayBase<S, D>> for ArrayViewMut<'a, A, D>where
    S: DataMut<Elem = A>,
    D: Dimension,

Implementation of ArrayViewMut::from(&mut A) where A is an array.

Create a read-write array view of the array.

fn from(array: &'a mut ArrayBase<S, D>) -> Self

Converts to this type from the input type.

impl<'a, A, Slice> From<&'a mut Slice> for ArrayViewMut<'a, A, Ix1>where
    Slice: AsMut<[A]> + ?Sized,

Implementation of ArrayViewMut::from(&mut S) where S is a slice or slicable.

Create a one-dimensional read-write array view of the data in slice.

Panics if the slice length is greater than isize::MAX.

fn from(slice: &'a mut Slice) -> Self

Converts to this type from the input type.

impl<'a, I, A, D> IndexLonger<I> for ArrayViewMut<'a, A, D>where
    I: NdIndex<D>,
    D: Dimension,

fn index(self, index: I) -> &'a mut A

Convert a mutable array view to a mutable reference of a element.

This method is like IndexMut::index_mut but with a longer lifetime (matching the array view); which we can only do for the array view and not in the Index trait.

See also the get_mut method which works for all arrays and array views.

Panics if index is out of bounds.

fn get(self, index: I) -> Option<&'a mut A>

Convert a mutable array view to a mutable reference of a element, with checked access.

See also the get_mut method which works for all arrays and array views.

unsafe fn uget(self, index: I) -> &'a mut A

Convert a mutable array view to a mutable reference of a element without boundary check.

See also the uget_mut method which works for all arrays and array views.

Note: only unchecked for non-debug builds of ndarray.

type Output = &'a mut A

The type of the reference to the element that is produced, including its lifetime.

impl<'a, A, D> IntoIterator for ArrayViewMut<'a, A, D>where
    D: Dimension,

type Item = &'a mut A

The type of the elements being iterated over.

type IntoIter = IterMut<'a, A, D>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, A, D: Dimension> NdProducer for ArrayViewMut<'a, A, D>

type Item = &'a mut A

The element produced per iteration.

type Dim = D

Dimension type

fn __private__(&self) -> PrivateMarker

This trait is private to implement; this method exists to make it impossible to implement outside the crate.