Struct RefTensor 

pub struct RefTensor<'a, T> { /* private fields */ }

A tensor-like structure that owns no data and holds only slices.

The shape is &'a [usize], meaning the shape can never be changed once instantiated.

The data is &'a mut [data], allowing for the data to be changed at runtime.

Implementations

impl<'a, T> RefTensor<'a, T>

pub fn with_data(shape: &'a [usize], data: &'a mut [T]) -> Self

Constructs a new RefTensor borrowing mutable data slice with given static shape.

Unlike owned Tensor types, RefTensor has no default constructor. If it did, the constructor would refuse to compile because slices have no statically known size.

Panics

This constructor panics when the product of each dimension is not equal to the length of all the data.

Example

use tensor_optim::RefTensor;

const SHAPE: &[usize] = &[2, 3];

let mut data = [0f64; 6];
let mut tensor = RefTensor::with_data(SHAPE, &mut data);

tensor[&[1, 2]] = 42.0;
println!("First element: {}", tensor[&[0, 0]]);

Trait Implementations

impl<T> AddAssign<&RefTensor<'_, T>> for RefTensor<'_, T>

where T: Copy + Add<Output = T>,

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl<T> AddAssign<T> for RefTensor<'_, T>

where T: Copy + Add<Output = T>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<'a, T: Debug> Debug for RefTensor<'a, T>

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

Formats the value using the given formatter.

impl<T> DivAssign<&RefTensor<'_, T>> for RefTensor<'_, T>

where T: Copy + Div<Output = T>,

fn div_assign(&mut self, rhs: &Self)

Performs the /= operation.

impl<T> DivAssign<T> for RefTensor<'_, T>

where T: Copy + Div<Output = T>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> Index<&[usize]> for RefTensor<'_, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<&[usize]> for RefTensor<'_, T>

fn index_mut(&mut self, idx: &[usize]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> MulAssign<&RefTensor<'_, T>> for RefTensor<'_, T>

where T: Copy + Mul<Output = T>,

fn mul_assign(&mut self, rhs: &Self)

Performs the *= operation.

impl<T> MulAssign<T> for RefTensor<'_, T>

where T: Copy + Mul<Output = T>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<'a, T: Ord> Ord for RefTensor<'a, T>

fn cmp(&self, other: &RefTensor<'a, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, T: PartialEq> PartialEq for RefTensor<'a, T>

fn eq(&self, other: &RefTensor<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: PartialOrd> PartialOrd for RefTensor<'a, T>

fn partial_cmp(&self, other: &RefTensor<'a, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> SubAssign<&RefTensor<'_, T>> for RefTensor<'_, T>

where T: Copy + Sub<Output = T>,

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl<T> SubAssign<T> for RefTensor<'_, T>

where T: Copy + Sub<Output = T>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> TensorOps<T> for RefTensor<'_, T>

fn data(&self) -> &[T]

Provides the data of the current tensor in a slice of a generic T.

fn data_mut(&mut self) -> &mut [T]

Provides the data of the current tensor in a slice of a generic T.

fn shape(&self) -> &[usize]

Provides the shape of the current tensor as a slice.

fn index_offset(&self, idx: &[usize]) -> Option<usize>

Finds the index in data given a slice with one entry/dimension.

impl<'a, T: Eq> Eq for RefTensor<'a, T>

impl<'a, T> StructuralPartialEq for RefTensor<'a, T>