Struct TensorDataView 

pub struct TensorDataView<'a, E: Element> { /* private fields */ }

Typed Index view over a TensorData.

Creating a view materializes lazy storage into host-accessible memory when necessary. It does not perform dtype conversion.

Example

use burn_std::*;

let data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
let view: TensorDataView<f64> = data.view();

assert_eq!(view.shape(), &data.shape);
assert_eq!(&view.dtype(), &data.dtype);

assert_eq!(view[&[0, 0]], 1.0);
assert_eq!(view[&[0, 1]], 2.0);
assert_eq!(view[&[1, 0]], 3.0);
assert_eq!(view[&[1, 1]], 4.0);

Implementations

impl<'a, E: Element> TensorDataView<'a, E>

pub fn try_view( data: &'a TensorData, ) -> Result<TensorDataView<'a, E>, DataError>

Creates a typed indexed view over data.

Example

use burn_std::*;

let data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
let view: TensorDataView<f64> = data.try_view().unwrap();

assert_eq!(view.shape(), &data.shape);
assert_eq!(&view.dtype(), &data.dtype);

assert_eq!(view[&[0, 0]], 1.0);
assert_eq!(view[&[0, 1]], 2.0);
assert_eq!(view[&[1, 0]], 3.0);
assert_eq!(view[&[1, 1]], 4.0);

Errors

Returns an error if storage access fails or the dtype, byte representation, or element count is incompatible with E.

pub fn shape(&self) -> &Shape

Returns the shape of the view.

pub fn dtype(&self) -> DType

Returns the dtype of the view.

pub fn ravel_index<I: AsIndex>(&self, index: &[I]) -> usize

Ravels the index via ravel_index and the view’s shape.

Trait Implementations

impl<'a, E: Debug + Element> Debug for TensorDataView<'a, E>

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

Formats the value using the given formatter.

impl<'a, I: AsIndex, E: Element> Index<&[I]> for TensorDataView<'a, E>

type Output = E

The returned type after indexing.

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

Performs the indexing (container[index]) operation.