Struct easy_ml::interop::TensorRefMatrix

pub struct TensorRefMatrix<T, S, N> { /* private fields */ }

A wrapper around a Matrix type that implements TensorRef and can thus be used in a TensorView

use easy_ml::matrices::Matrix;
use easy_ml::tensors::views::TensorView;
use easy_ml::interop::TensorRefMatrix;
let matrix = Matrix::from(vec![
    vec![ 1, 3, 5, 7 ],
    vec![ 2, 4, 6, 8 ]
]);
// We can always unwrap here because we know a 2x4 matrix is a valid input
let tensor_view = TensorView::from(TensorRefMatrix::from(&matrix).unwrap());
assert_eq!(
    matrix.row_iter(1).eq(tensor_view.select([("row", 1)]).iter()),
    true
);

Implementations

impl<T, S> TensorRefMatrix<T, S, RowAndColumn>

where S: MatrixRef<T> + NoInteriorMutability,

pub fn from( source: S ) -> Result<TensorRefMatrix<T, S, RowAndColumn>, InvalidShapeError<2>>

Creates a TensorRefMatrix wrapping a MatrixRef type and defaulting the dimension names to “row” and “column” respectively.

Result::Err is returned if the matrix dimension lengths are not at least 1x1.

impl<T, S, N> TensorRefMatrix<T, S, N>

where S: MatrixRef<T> + NoInteriorMutability, N: DimensionNames,

pub fn with_names( source: S, names: N ) -> Result<TensorRefMatrix<T, S, N>, InvalidShapeError<2>>

Creates a TensorRefMatrix wrapping a MatrixRef type and provided dimension names.

Result::Err is returned if the provided dimension names are not unique, or the matrix dimension lengths are not at least 1x1.

use easy_ml::matrices::Matrix;
use easy_ml::tensors::views::TensorRef;
use easy_ml::interop::TensorRefMatrix;
assert_eq!(
    // We can always unwrap here because we know the input is 1x1 and "x" and "y" are unique
    // dimension names
    TensorRefMatrix::with_names(Matrix::from_scalar(1.0), ["x", "y"]).unwrap().view_shape(),
    [("x", 1), ("y", 1)]
);

Trait Implementations

impl<T: Clone, S: Clone, N: Clone> Clone for TensorRefMatrix<T, S, N>

fn clone(&self) -> TensorRefMatrix<T, S, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, S: Debug, N: Debug> Debug for TensorRefMatrix<T, S, N>

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

Formats the value using the given formatter.

impl<T, S, N> TensorMut<T, 2> for TensorRefMatrix<T, S, N>

where S: MatrixMut<T> + NoInteriorMutability, N: DimensionNames,

fn get_reference_mut(&mut self, indexes: [usize; 2]) -> 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; 2]) -> &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, N> TensorRef<T, 2> for TensorRefMatrix<T, S, N>

where S: MatrixRef<T> + NoInteriorMutability, N: DimensionNames,

fn get_reference(&self, indexes: [usize; 2]) -> 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); 2]

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; 2]) -> &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) -> TDataLayout<2>

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.