Struct MatrixRefTensor

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

A wrapper around a Tensor<_, 2> type that implements MatrixRef and can thus be used in a MatrixView

use easy_ml::tensors::Tensor;
use easy_ml::matrices::views::MatrixView;
use easy_ml::interop::MatrixRefTensor;
let tensor = Tensor::from([("row", 2), ("column", 4)], vec![
    1, 3, 5, 7,
    2, 4, 6, 8
]);
let matrix_view = MatrixView::from(MatrixRefTensor::from(&tensor));
assert_eq!(
    matrix_view.row_iter(1).eq(tensor.select([("row", 1)]).iter()),
    true
);

Implementations

impl<T, S> MatrixRefTensor<T, S>

where S: TensorRef<T, 2>,

pub fn from(source: S) -> MatrixRefTensor<T, S>

Creates a MatrixRefTensor wrapping a TensorRef type and stripping the dimension names.

The first dimension in the TensorRef type becomes the rows, and the second dimension the columns. If your tensor is the other way around, reorder it first.

Trait Implementations

impl<T, S> MatrixMut<T> for MatrixRefTensor<T, S>

where S: TensorMut<T, 2>,

fn try_get_reference_mut(&mut self, row: Row, column: Column) -> 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, row: Row, column: Column, ) -> &mut T

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

impl<T, S> MatrixRef<T> for MatrixRefTensor<T, S>

where S: TensorRef<T, 2>,

fn try_get_reference(&self, row: Row, column: Column) -> Option<&T>

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

fn view_rows(&self) -> Row

The number of rows that this reference can view. This may be less than the actual number of rows of data stored in the matrix implementation, and could be 0.

fn view_columns(&self) -> Column

The number of columns that this reference can view. This may be less than the actual number of columns of data stored in the matrix implementation, and could be 0.

unsafe fn get_reference_unchecked(&self, row: Row, column: Column) -> &T

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

fn data_layout(&self) -> MDataLayout

A hint for the data layout this MatrixView uses to store its data.

impl<T, S> NoInteriorMutability for MatrixRefTensor<T, S>

where S: TensorRef<T, 2>,