Struct rten_tensor::WeaklyCheckedView

pub struct WeaklyCheckedView<T, S: AsRef<[T]>, L: MutLayout> { /* private fields */ }

A view of a tensor which does “weak” checking when indexing via view[<index>]. This means that it does not bounds-check individual dimensions, but does bounds-check the computed offset.

This offers a middle-ground between regular indexing, which bounds-checks each index element, and unchecked indexing, which does no bounds-checking at all and is thus unsafe.

Trait Implementations

impl<T, S: AsRef<[T]>, L: MutLayout, I: AsIndex<L>> Index<I> for WeaklyCheckedView<T, S, L>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, S: AsRef<[T]> + AsMut<[T]>, L: MutLayout, I: AsIndex<L>> IndexMut<I> for WeaklyCheckedView<T, S, L>

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

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

impl<T, S: AsRef<[T]>, L: MutLayout> Layout for WeaklyCheckedView<T, S, L>

type Index<'a> = <L as Layout>::Index<'a>

Type used to represent indices.

type Indices = <L as Layout>::Indices

Iterator over indices in this tensor.

fn ndim(&self) -> usize

Return the number of dimensions.

fn try_offset(&self, index: Self::Index<'_>) -> Option<usize>

Map an index to a storage offset, or return None if the index is out of bounds along any dimension.

fn len(&self) -> usize

Returns the number of elements in the array.

fn shape(&self) -> Self::Index<'_>

Returns an array of the sizes of each dimension.

fn strides(&self) -> Self::Index<'_>

Returns an array of the strides of each dimension.

fn indices(&self) -> Self::Indices

Return an iterator over all valid indices in this tensor.

fn offset(&self, index: Self::Index<'_>) -> usize

Map an index to a storage offset.

fn offset_unchecked(&self, index: Self::Index<'_>) -> usize

Map an index to a storage offset, without checking if it is valid for the tensor’s shape.

fn is_contiguous(&self) -> bool

Return true if this layout describes a contiguous tensor, where the logical order of elements matches the order in which they are stored.

fn is_broadcast(&self) -> bool

Return true if iterating over elements in this layout will visit elements multiple times.

fn is_empty(&self) -> bool

Returns true if the array has no elements.

fn size(&self, dim: usize) -> usize

Returns the size of the dimension dim.

fn stride(&self, dim: usize) -> usize

Returns the offset between adjacent indices along dimension dim.

fn can_broadcast_to(&self, target_shape: &[usize]) -> bool

Return true if this layout’s shape can be broadcast to the given shape.

fn can_broadcast_with(&self, shape: &[usize]) -> bool

Return true if the tensor/view can be broadcast with another tensor or view with a given shape as part of a binary operation.

fn min_data_len(&self) -> usize

Return the minimum length required for the element data buffer used with this layout.