Struct TensorReverse

pub struct TensorReverse<T, S, const D: usize> { /* private fields */ }

A view over a tensor where some or all of the dimensions are iterated in reverse order.

use easy_ml::tensors::Tensor;
use easy_ml::tensors::views::{TensorView, TensorReverse};
let ab = Tensor::from([("a", 2), ("b", 3)], (0..6).collect());
let reversed = ab.reverse(&["a"]);
let also_reversed = TensorView::from(TensorReverse::from(&ab, &["a"]));
assert_eq!(reversed, also_reversed);
assert_eq!(
    reversed,
    Tensor::from(
        [("a", 2), ("b", 3)],
        vec![
            3, 4, 5,
            0, 1, 2,
        ]
    )
);

Implementations

impl<T, S, const D: usize> TensorReverse<T, S, D>

where S: TensorRef<T, D>,

pub fn from(source: S, dimensions: &[Dimension]) -> TensorReverse<T, S, D>

Creates a TensorReverse from a source and a list of dimension names to reverse the order of iteration for. The list cannot be more than the number of dimensions in the source but it does not need to contain every dimension in the source. Any dimensions in the source but not in the list of dimension names to reverse will continue to iterate in their normal order.

Panics

• If a dimension name is not in the source’s shape or is repeated.

pub fn source(self) -> S

Consumes the TensorReverse, yielding the source it was created from.

pub fn source_ref(&self) -> &S

Gives a reference to the TensorReverse’s source (in which the iteration order may be different).

pub fn source_ref_mut(&mut self) -> &mut S

Gives a mutable reference to the TensorReverse’s source (in which the iteration order may be different).

Trait Implementations

impl<T: Clone, S: Clone, const D: usize> Clone for TensorReverse<T, S, D>

fn clone(&self) -> TensorReverse<T, S, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, S: Debug, const D: usize> Debug for TensorReverse<T, S, D>

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

Formats the value using the given formatter.

impl<T, S, const D: usize> TensorMut<T, D> for TensorReverse<T, S, D>

where S: TensorMut<T, D>,

A TensorReverse implements TensorMut, with the dimension names the TensorReverse was created with iterating in reverse order compared to the dimension names in the original source.

fn get_reference_mut(&mut self, indexes: [usize; D]) -> Option<&mut T>

Gets a mutable reference to the value at the index, if the index is in range. Otherwise returns None.

unsafe fn get_reference_unchecked_mut(&mut self, indexes: [usize; D]) -> &mut T

Gets a mutable reference to the value at the index without doing any bounds checking. For a safe alternative see get_reference_mut.

impl<T, S, const D: usize> TensorRef<T, D> for TensorReverse<T, S, D>

where S: TensorRef<T, D>,

A TensorReverse implements TensorRef, with the dimension names the TensorReverse was created with iterating in reverse order compared to the dimension names in the original source.

fn get_reference(&self, indexes: [usize; D]) -> Option<&T>

Gets a reference to the value at the index if the index is in range. Otherwise returns None.

fn view_shape(&self) -> [(Dimension, usize); D]

The shape this tensor has. See dimensions for an overview. The product of the lengths in the pairs define how many elements are in the tensor (or the portion of it that is visible).

unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T

Gets a reference to the value at the index without doing any bounds checking. For a safe alternative see get_reference.

fn data_layout(&self) -> DataLayout<D>

The way the data in this tensor is laid out in memory. In particular, Linear has several requirements on what is returned that must be upheld by implementations of this trait.