Struct TensorRef 

pub struct TensorRef<'a, C: Memorable, const D: usize> { /* private fields */ }

An immutable view into tensor data.

This struct provides read-only access to tensor data without owning the underlying memory. It holds a reference to the data along with dimension and stride information.

Implementations

impl<'a, C: Memorable, const D: usize> TensorRef<'a, C, D>

pub unsafe fn from_raw_parts( data: *const C, dims: [usize; D], strides: [usize; D], ) -> Self

Creates a TensorRef from pointers to tensor data, dimensions, and strides.

Safety

The caller must ensure:

• The pointers are valid and non-null.
• For each unit, the entire memory region addressed by the tensor is within a single allocation.
• The memory is accessible by the pointer.
• No mutable aliasing occurs. No mutable references to the tensor data exist when the MatVecRef is alive.

pub fn dims(&self) -> &[usize; D]

Returns a reference to the dimensions of the tensor.

pub fn strides(&self) -> &[usize; D]

Returns a reference to the strides of the tensor.

pub fn rank(&self) -> usize

Returns the rank (number of dimensions) of the tensor.

pub fn num_elements(&self) -> usize

Returns the total number of elements in the tensor.

pub fn as_ptr(&self) -> *const C

Returns a raw pointer to the tensor’s data.

pub fn get(&self, indices: &[usize; D]) -> &C

Returns a reference to an element at the given indices.

Panics

Panics if the indices are out of bounds.

pub unsafe fn get_unchecked(&self, indices: &[usize; D]) -> &C

Returns an immutable reference to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

pub unsafe fn ptr_at(&self, indices: &[usize; D]) -> *const C

Returns a raw pointer to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

pub fn to_owned(self) -> Tensor<C, D>

Creates an owned Tensor by copying the data from this TensorRef.

impl<'a, C: Memorable> TensorRef<'a, C, 4>

pub fn subtensor_ref(&self, m: usize) -> TensorRef<'a, C, 3>

Returns an immutable view of a 3D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> TensorRef<'a, C, 3>

Returns an immutable view of a 3D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorRef<'a, C, 3>

pub fn subtensor_ref(&self, m: usize) -> MatRef<'a, C>

Returns an immutable matrix view of a 2D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> MatRef<'a, C>

Returns an immutable matrix view of a 2D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorRef<'a, C, 2>

pub fn subtensor_ref(&self, m: usize) -> RowRef<'a, C>

Returns an immutable row view of a 1D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> RowRef<'a, C>

Returns an immutable row view of a 1D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorRef<'a, C, 1>

pub fn subtensor_ref(&self, m: usize) -> &C

Returns an immutable reference to an element at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> &C

Returns an immutable reference to an element at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

Trait Implementations

impl<'a, C: Clone + Memorable, const D: usize> Clone for TensorRef<'a, C, D>

fn clone(&self) -> TensorRef<'a, C, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, C: Display + Debug + Memorable, const D: usize> Debug for TensorRef<'a, C, D>

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

Formats the value using the given formatter.

impl<'a, C: Memorable, const D: usize> Index<[usize; D]> for TensorRef<'a, C, D>

type Output = C

The returned type after indexing.

fn index(&self, indices: [usize; D]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, C: Copy + Memorable, const D: usize> Copy for TensorRef<'a, C, D>