Struct hotg_rune_core::Tensor

source · [−]

pub struct Tensor<T> { /* private fields */ }

Expand description

A multidimensional array with copy-on-write semantics.

Implementations

impl<T> Tensor<T>

pub fn new_row_major(elements: Arc<[T]>, dimensions: Vec<usize>) -> Self

pub fn new_vector(iter: impl IntoIterator<Item = T>) -> Self

pub fn single(value: T) -> Self

pub fn zeroed(dimensions: Vec<usize>) -> Self where
T: Default,

pub fn filled_with<F>(dimensions: Vec<usize>, f: F) -> Self where
F: FnMut() -> T,

pub fn shape(&self) -> Shape<'_> where
T: AsElementType,

pub fn dimensions(&self) -> &[usize ]

Get the Tensor’s dimensions.

pub fn rank(&self) -> usize

The number of dimensions this Tensor has.

pub fn elements(&self) -> &[T]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get an immutable reference to the underlying elements in this Tensor.

pub fn get_elements_mut(&mut self) -> Option<&mut [T]>

Get a mutable reference to the underlying elements in this Tensor.

pub fn slice<const RANK: usize>(
&self,
leading_indices: &[usize ]
) -> Option<TensorView<'_, T, RANK>>

Try to get a contiguous sub-slice of this tensor.

Note

Due to the way tensors are laid out in memory, you can only slice off the leading dimensions.

In order to be well-formed, this requires that RANK + leading_indices.len() equals Tensor::rank(), and that each of the indices are within bounds.

Examples

Say you have a [3, 4, 2] tensor, passing in [0, 1] would give you a 1D TensorView that views the 3 elements at [0, 1, ..].

let input = [
    [[0, 1], [2, 3], [4, 5], [6, 7]],
    [[8, 9], [10, 11], [12, 13], [14, 15]],
    [[16, 17], [18, 19], [20, 21], [22, 23]],
];
let tensor: Tensor<i32> = input.into();

let got = tensor.slice::<1>(&[0, 1]).unwrap();

assert_eq!(got.dimensions(), [2]);
assert_eq!(got.elements(), &input[0][1]);

pub fn slice_mut<const RANK: usize>(
    &mut self,
    leading_indices: &[usize ]
) -> Option<TensorViewMut<'_, T, RANK>> where
    T: Clone,

A mutable version of Tensor::slice().

pub fn view<const RANK: usize>(&self) -> Option<TensorView<'_, T, RANK>>

Try to reinterpret this tensor as a RANK-D tensor.

pub fn view_mut<'a, 'this: 'a, const RANK: usize>(
&'this mut self
) -> Option<TensorViewMut<'a, T, RANK>> where
T: Clone,

The mutable version of Tensor::view().

pub fn as_ptr_and_byte_length(&self) -> (*const u8, usize )

pub fn map<F, Out>(&self, map: F) -> Tensor<Out> where
F: FnMut(&[usize ], &T) -> Out,

Create a new Tensor by applying a function to every element in the current tensor.

This is often an expensive operation.

pub fn get(&self, indices: &[usize ]) -> Option<&T>

Get a reference to the element with this particular index.

pub fn get_mut(&mut self, indices: &[usize ]) -> Option<&mut T> where
T: Clone,

Get a mutable reference to the element with this particular index.

impl<T: Clone> Tensor<T>

pub fn make_elements_mut(&mut self) -> &mut [T]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Trait Implementations

impl<T: Clone> Clone for Tensor<T>

fn clone(&self) -> Tensor<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Tensor<T>

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

Formats the value using the given formatter. Read more

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Tensor<T>

fn deserialize<D>(de: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<'a, T: Clone> From<&'a [T]> for Tensor<T>

fn from(array: &'a [T]) -> Self

Performs the conversion.

impl<Element: Clone, const A: usize, const B: usize, const C: usize, const D: usize, const E: usize, const F: usize, const G: usize, const H: usize> From<[[[[[[[[Element; H]; G]; F]; E]; D]; C]; B]; A]> for Tensor<Element>

fn from(array: [[[[[[[[Element; H]; G]; F]; E]; D]; C]; B]; A]) -> Self

Performs the conversion.

impl<Element: Clone, const A: usize, const B: usize, const C: usize, const D: usize, const E: usize, const F: usize, const G: usize> From<[[[[[[[Element; G]; F]; E]; D]; C]; B]; A]> for Tensor<Element>

fn from(array: [[[[[[[Element; G]; F]; E]; D]; C]; B]; A]) -> Self

Performs the conversion.

impl<Element: Clone, const A: usize, const B: usize, const C: usize, const D: usize, const E: usize, const F: usize> From<[[[[[[Element; F]; E]; D]; C]; B]; A]> for Tensor<Element>

fn from(array: [[[[[[Element; F]; E]; D]; C]; B]; A]) -> Self

Performs the conversion.

impl<Element: Clone, const A: usize, const B: usize, const C: usize, const D: usize, const E: usize> From<[[[[[Element; E]; D]; C]; B]; A]> for Tensor<Element>

fn from(array: [[[[[Element; E]; D]; C]; B]; A]) -> Self

Performs the conversion.

impl<Element: Clone, const A: usize, const B: usize, const C: usize, const D: usize> From<[[[[Element; D]; C]; B]; A]> for Tensor<Element>

fn from(array: [[[[Element; D]; C]; B]; A]) -> Self

Performs the conversion.

impl<T: Clone, const WIDTH: usize, const HEIGHT: usize, const DEPTH: usize> From<[[[T; WIDTH]; HEIGHT]; DEPTH]> for Tensor<T>

fn from(array: [[[T; WIDTH]; HEIGHT]; DEPTH]) -> Self

Performs the conversion.

impl<T: Clone, const WIDTH: usize, const HEIGHT: usize> From<[[T; WIDTH]; HEIGHT]> for Tensor<T>

fn from(array: [[T; WIDTH]; HEIGHT]) -> Self

Performs the conversion.

impl<T, const N: usize> From<[T; N]> for Tensor<T>

fn from(array: [T; N]) -> Self

Performs the conversion.

impl<T> FromIterator<T> for Tensor<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl<T, Ix> Index<Ix> for Tensor<T> where
Ix: AsRef<[usize ]>,

type Output = T

The returned type after indexing.

fn index(&self, index: Ix) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

impl<T, Ix> IndexMut<Ix> for Tensor<T> where
Ix: AsRef<[usize ]>,
T: Clone,

fn index_mut(&mut self, index: Ix) -> &mut Self::Output

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

impl<T: PartialEq, const N: usize> PartialEq<[T; N]> for Tensor<T>

fn eq(&self, other: &[T; N]) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<T: PartialEq> PartialEq<[T]> for Tensor<T>

fn eq(&self, other: &[T]) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<T: PartialEq> PartialEq<Tensor<T>> for Tensor<T>

fn eq(&self, other: &Tensor<T>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &Tensor<T>) -> bool

This method tests for !=.

impl<T: PartialEq> PartialEq<Tensor<T>> for [T]

fn eq(&self, other: &Tensor<T>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<T: Serialize> Serialize for Tensor<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<'a, T> TensorList<'a> for &'a Tensor<T> where
T: AsElementType,

type ConstElementPtrBuffer = [*const u8 ; 1]

type ShapeBuffer = [Shape<'a>; 1]

fn shape_list(&self) -> Self::ShapeBuffer

Get an array containing the Shape for each Tensor in this tuple.

fn element_ptr(&self) -> Self::ConstElementPtrBuffer

Get an array containing pointers to the elements of each Tensor in this tuple. Read more

impl<T> TensorListMut for Tensor<T> where
T: AsElementType + Default + Clone,

type MutElementPtrBuffer = [*mut u8 ; 1]

fn new_tensors(shape: &[Shape<'_>]) -> Self

Create a new set of empty tensors with the specified shape. Read more

fn element_ptr_mut(&mut self) -> Self::MutElementPtrBuffer

Get a set of mutable pointers into each tensor’s backing buffer.

impl<T> StructuralPartialEq for Tensor<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Tensor<T> where
T: RefUnwindSafe,

impl<T> Send for Tensor<T> where
T: Send + Sync,

impl<T> Sync for Tensor<T> where
T: Send + Sync,

impl<T> Unpin for Tensor<T>

impl<T> UnwindSafe for Tensor<T> where
T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,