Struct StridedViewMut 

pub struct StridedViewMut<'a, T> { /* private fields */ }

Dynamic-rank mutable strided view.

Always uses Identity element operation for write simplicity. Julia typically applies ops on the read side.

Implementations

impl<'a, T> StridedViewMut<'a, T>

pub fn new( data: &'a mut [T], dims: &[usize], strides: &[isize], offset: isize, ) -> Result<StridedViewMut<'a, T>, StridedError>

Create a mutable view, copying the caller’s metadata inline.

The layout is copied, so it does not need to outlive the view and no heap allocation happens at rank <= INLINE_RANK.

Examples

use strided_view::StridedViewMut;

let mut data = [0.0f64; 4];
let mut view = StridedViewMut::<f64>::new(&mut data, &[2, 2], &[1, 2], 0).unwrap();
view.set(&[1, 1], 5.0);
assert_eq!(data[3], 5.0);

pub unsafe fn new_unchecked( data: &'a mut [T], dims: &[usize], strides: &[isize], offset: isize, ) -> StridedViewMut<'a, T>

Create without bounds checking, copying the caller’s metadata.

Safety

Caller must ensure all index combinations stay within bounds.

Examples

use strided_view::StridedViewMut;

let mut data = [0.0f64; 4];
let view = unsafe { StridedViewMut::<f64>::new_unchecked(&mut data, &[2, 2], &[1, 2], 0) };
assert_eq!(view.ndim(), 2);

pub fn dims(&self) -> &[usize]

Returns the shape (dimension sizes) of this view.

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

Returns the strides (in units of T) for each dimension.

pub fn offset(&self) -> isize

Returns the byte offset into the backing data.

pub fn ndim(&self) -> usize

Returns the number of dimensions (rank).

pub fn len(&self) -> usize

Returns the total number of elements.

pub fn is_empty(&self) -> bool

Returns true if any dimension is zero.

pub fn ptr(&self) -> *const T

Raw const pointer to element at the view’s base offset.

pub fn as_mut_ptr(&self) -> *mut T

Raw mutable pointer to element at the view’s base offset.

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

Returns a reference to the backing data slice.

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

Returns a mutable reference to the backing data slice.

pub fn permute( self, perm: &[usize], ) -> Result<StridedViewMut<'a, T>, StridedError>

Permute dimensions, consuming the mutable view.

Returns a new mutable view with reordered dimensions and strides. Takes self by value to prevent aliasing of mutable views.

pub fn as_view(&self) -> StridedView<'_, T>

Reborrow as an immutable view.

The reborrow copies this view’s metadata into the immutable view’s inline storage, which allocates nothing up to INLINE_RANK and spills above it (the mutable owner always keeps its own copy).

Examples

use strided_view::StridedViewMut;

let mut data = [1.0f64, 2.0, 3.0];
let view = StridedViewMut::<f64>::new(&mut data, &[3], &[1], 0).unwrap();
let read = view.as_view();
assert_eq!(read.get(&[2]), 3.0);

impl<'a, T> StridedViewMut<'a, T>

where T: Copy,

pub fn get(&self, indices: &[usize]) -> T

Get an element.

Panics

Panics if indices.len() is not the view’s rank, an index is out of bounds, or the indexed offset does not fit isize.

pub fn set(&mut self, indices: &[usize], value: T)

Set an element.

Panics

Panics if indices.len() is not the view’s rank, an index is out of bounds, or the indexed offset does not fit isize.

Trait Implementations

impl<T> Debug for StridedViewMut<'_, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Send for StridedViewMut<'_, T>

where T: Send,