Struct Tensor

pub struct Tensor { /* private fields */ }

Tensor is a concrete tensor in tract.

Implementations

impl Tensor

pub unsafe fn uninitialized<T>(shape: &[usize]) -> Result<Tensor, Error>

where T: Datum,

Create an uninitialized tensor (dt as type paramater).

pub unsafe fn uninitialized_dt( dt: DatumType, shape: &[usize], ) -> Result<Tensor, Error>

Create an uninitialized tensor (dt as regular parameter).

pub unsafe fn uninitialized_aligned<T>( shape: &[usize], alignment: usize, ) -> Result<Tensor, Error>

where T: Datum,

Create an uninitialized tensor with a given alignment (in bytes).

pub unsafe fn uninitialized_aligned_dt( dt: DatumType, shape: &[usize], alignment: usize, ) -> Result<Tensor, Error>

Create an uninitialized tensor with a given alignment (in bytes).

pub fn stack_tensors( axis: usize, tensors: &[impl Borrow<Tensor>], ) -> Result<Tensor, Error>

pub fn clear<T>(&mut self) -> Result<(), Error>

where T: Datum + Zero + Clone,

pub fn zero<T>(shape: &[usize]) -> Result<Tensor, Error>

where T: Datum + Zero,

pub fn zero_scalar<T>() -> Result<Tensor, Error>

where T: Datum + Zero,

pub fn zero_scalar_dt(dt: DatumType) -> Result<Tensor, Error>

pub fn zero_dt(dt: DatumType, shape: &[usize]) -> Result<Tensor, Error>

pub fn fill_t<T>(&mut self, value: T) -> Result<(), Error>

where T: Datum + Clone,

pub fn zero_aligned_dt( dt: DatumType, shape: &[usize], alignment: usize, ) -> Result<Tensor, Error>

pub fn zero_aligned<T>( shape: &[usize], alignment: usize, ) -> Result<Tensor, Error>

where T: Datum + Zero,

pub fn from_shape<T>(shape: &[usize], data: &[T]) -> Result<Tensor, Error>

where T: Datum + Copy,

Create a tensor with a given shape and a slice of elements. The data is copied and aligned to size of T.

pub fn from_shape_align<T>( shape: &[usize], data: &[T], align: usize, ) -> Result<Tensor, Error>

where T: Datum + Copy,

Create a tensor with a given shape and a slice of elements. The data is copied and aligned to given alignment.

pub unsafe fn from_raw<T>( shape: &[usize], content: &[u8], ) -> Result<Tensor, Error>

where T: Datum,

Create a tensor from raw data.

It copies the data, aligning it to the size of T.

pub unsafe fn from_raw_aligned<T>( shape: &[usize], content: &[u8], align: usize, ) -> Result<Tensor, Error>

where T: Datum,

pub unsafe fn from_raw_dt( dt: DatumType, shape: &[usize], content: &[u8], ) -> Result<Tensor, Error>

pub unsafe fn from_raw_dt_align( dt: DatumType, shape: &[usize], content: &[u8], align: usize, ) -> Result<Tensor, Error>

pub unsafe fn from_slice_align<T>( content: &[T], align: usize, ) -> Result<Tensor, Error>

where T: Datum,

pub fn rank(&self) -> usize

Get the number of dimensions (or axes) of the tensor.

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

Get the shape of the tensor.

pub fn len(&self) -> usize

Get the number of values in the tensor.

pub fn volume(&self) -> usize

Get the number of valeus in the tensor.

pub fn strides(&self) -> &[isize]

Get the shape of the tensor.

pub unsafe fn set_shape_unchecked(&mut self, shape: &[usize])

Force the tensor shape, no consistency check.

pub unsafe fn set_geometry_unchecked( &mut self, shape: &[usize], strides: &[isize], )

Force the tensor shape and strides, no consistency check.

pub fn set_shape(&mut self, shape: &[usize]) -> Result<(), Error>

Force the tensor shape.

pub fn permute_axes(self, axes: &[usize]) -> Result<Tensor, Error>

pub fn move_axis(self, from: usize, to: usize) -> Result<Tensor, Error>

pub fn collapse_axis_with_next(self, axis: usize) -> Tensor

pub fn split_axis(self, axis: usize, outer_dim: usize) -> Result<Tensor, Error>

pub fn into_shape(self, shape: &[usize]) -> Result<Tensor, Error>

Reshape the tensor to shape.

pub fn insert_axis(&mut self, axis: usize) -> Result<(), Error>

pub fn remove_axis(&mut self, axis: usize) -> Result<(), Error>

pub fn broadcast_into_rank(self, rank: usize) -> Result<Tensor, Error>

pub fn broadcast_to_rank(&mut self, rank: usize) -> Result<(), Error>

pub fn broadcast_scalar_to_shape( &self, shape: &[usize], ) -> Result<Tensor, Error>

pub fn broadcast_to_shape(&self, shape: &[usize]) -> Result<Tensor, Error>

pub fn broadcast_vector_to_shape( &self, shape: &[usize], axis: usize, ) -> Result<Tensor, Error>

pub fn assign_slice( &mut self, range: impl RangeBounds<usize>, src: &Tensor, src_range: impl RangeBounds<usize>, axis: usize, ) -> Result<(), Error>

pub unsafe fn assign_slice_unchecked( &mut self, range: impl RangeBounds<usize>, src: &Tensor, src_range: impl RangeBounds<usize>, axis: usize, )

pub fn datum_type(&self) -> DatumType

Get the datum type of the tensor.

pub unsafe fn set_datum_type(&mut self, dt: DatumType)

Set the datum type of the tensor.

pub fn dump(&self, force_full: bool) -> Result<String, Error>

Dump the tensor in a human readable form.

force_full will force the tensor to be dump in full even if it is big.

pub fn close_enough( &self, other: &Tensor, approx: impl Into<Approximation> + Debug, ) -> Result<(), Error>

Compare two tensors, allowing for rounding errors.

pub fn into_array<D>( self, ) -> Result<ArrayBase<OwnedRepr<D>, Dim<IxDynImpl>>, Error>

where D: Datum,

Transform the tensor into a ndarray::Array.

pub unsafe fn into_array_unchecked<D>( self, ) -> ArrayBase<OwnedRepr<D>, Dim<IxDynImpl>>

where D: Datum,

Transform the tensor into a ndarray::Array.

pub fn to_array_view<D>( &self, ) -> Result<ArrayBase<ViewRepr<&D>, Dim<IxDynImpl>>, Error>

where D: Datum,

Transform the data as a ndarray::Array.

pub fn to_array_view_mut<D>( &mut self, ) -> Result<ArrayBase<ViewRepr<&mut D>, Dim<IxDynImpl>>, Error>

where D: Datum,

Transform the data as a mutable ndarray::Array.

pub unsafe fn to_array_view_unchecked<D>( &self, ) -> ArrayBase<ViewRepr<&D>, Dim<IxDynImpl>>

where D: Datum,

Transform the data as a ndarray::Array.

pub unsafe fn to_array_view_mut_unchecked<D>( &mut self, ) -> ArrayBase<ViewRepr<&mut D>, Dim<IxDynImpl>>

where D: Datum,

Transform the data as a mutable ndarray::Array.

pub fn as_ptr<D>(&self) -> Result<*const D, Error>

where D: Datum,

Access the data as a pointer.

pub unsafe fn as_ptr_unchecked<D>(&self) -> *const D

where D: Datum,

Access the data as a pointer.

pub unsafe fn as_ptr_mut_unchecked<D>(&mut self) -> *mut D

where D: Datum,

Access the data as a pointer.

pub fn as_ptr_mut<D>(&mut self) -> Result<*mut D, Error>

where D: Datum,

Access the data as a mutable pointer.

pub fn as_slice<D>(&self) -> Result<&[D], Error>

where D: Datum,

Access the data as a slice.

pub fn as_slice_mut<D>(&mut self) -> Result<&mut [D], Error>

where D: Datum,

Access the data as a mutable slice.

pub unsafe fn as_slice_unchecked<D>(&self) -> &[D]

where D: Datum,

Access the data as a slice.

pub unsafe fn as_slice_mut_unchecked<D>(&mut self) -> &mut [D]

where D: Datum,

Access the data as a mutable slice.

pub fn to_scalar<D>(&self) -> Result<&D, Error>

where D: Datum,

Access the data as a scalar.

pub fn to_scalar_tensor(&self) -> Result<Tensor, Error>

Make the tensor a scalar tensor (assumes it contains a single value).

pub unsafe fn to_scalar_unchecked<D>(&self) -> &D

where D: Datum,

Access the data as a scalar.

pub fn to_scalar_mut<D>(&mut self) -> Result<&mut D, Error>

where D: Datum,

Mutable access the data as a scalar.

pub unsafe fn to_scalar_mut_unchecked<D>(&mut self) -> &mut D

where D: Datum,

Mutable access the data as a scalar.

pub fn as_bytes(&self) -> &[u8]

pub fn as_bytes_mut(&mut self) -> &mut [u8]

pub fn is_uniform(&self) -> bool

pub fn as_uniform(&self) -> Option<Tensor>

pub fn is_all_zero(&self) -> Result<bool, Error>

pub fn is_zero(&self) -> Result<bool, Error>

pub fn cast_to<D>(&self) -> Result<Cow<'_, Tensor>, Error>

where D: Datum,

Optionnaly convert data to a tensor for a new DatumType.

pub fn cast_to_dt(&self, dst_dt: DatumType) -> Result<Cow<'_, Tensor>, Error>

Optionnaly convert data to a tensor for a new DatumType.

pub fn cast_to_scalar<D>(&self) -> Result<D, Error>

where D: Datum + Copy,

Access the data as a scalar, after a cast.

pub fn nth(&self, nth: usize) -> Result<Tensor, Error>

Access the nth element of the tensor, returned as a 0-rank Tensor

pub fn deep_clone(&self) -> Tensor

pub fn slice( &self, axis: usize, start: usize, end: usize, ) -> Result<Tensor, Error>

pub fn view(&self) -> TensorView<'_>

pub fn view_at_prefix(&self, prefix: &[usize]) -> Result<TensorView<'_>, Error>

pub fn view_offsetting(&self, coords: &[usize]) -> Result<TensorView<'_>, Error>

pub unsafe fn view_offsetting_unchecked( &self, coords: &[usize], ) -> TensorView<'_>

pub fn view_mut(&mut self) -> TensorView<'_>

pub fn view_at_prefix_mut( &mut self, prefix: &[usize], ) -> Result<TensorView<'_>, Error>

pub fn view_offsetting_mut( &mut self, coords: &[usize], ) -> Result<TensorView<'_>, Error>

pub fn offset_u8_as_i8(self: &Arc<Tensor>) -> Arc<Tensor>

Offsets the tensor as an i8 type if it’s an u8 type, otherwise passes it unchanged.

pub fn offset_i8_as_u8(self: &Arc<Tensor>) -> Arc<Tensor>

Offsets the tensor as an u8 type if it’s an i8 type, otherwise passes it unchanged.

pub fn to_aligned_default(&self) -> Result<Tensor, Error>

pub fn natural_strides(shape: &[usize]) -> SmallVec<[isize; 4]>

pub fn into_blob(self) -> Result<Blob, Error>

Trait Implementations

impl Borrow<Tensor> for TValue

fn borrow(&self) -> &Tensor

Immutably borrows from an owned value.

impl Clone for Tensor

fn clone(&self) -> Tensor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tensor

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

Formats the value using the given formatter.

impl Default for Tensor

fn default() -> Tensor

Returns the “default value” for a type.

impl Drop for Tensor

fn drop(&mut self)

Executes the destructor for this type.

impl<D, T> From<ArrayBase<OwnedRepr<T>, D>> for Tensor

where D: Dimension, T: Datum,

fn from(it: ArrayBase<OwnedRepr<T>, D>) -> Tensor

Converts to this type from the input type.

impl From<Blob> for Tensor

fn from(it: Blob) -> Tensor

Converts to this type from the input type.

impl From<Opaque> for Tensor

fn from(it: Opaque) -> Tensor

Converts to this type from the input type.

impl From<String> for Tensor

fn from(it: String) -> Tensor

Converts to this type from the input type.

impl From<TDim> for Tensor

fn from(it: TDim) -> Tensor

Converts to this type from the input type.

impl From<Tensor> for TValue

fn from(t: Tensor) -> TValue

Converts to this type from the input type.

impl From<Tensor> for TypedFact

fn from(t: Tensor) -> TypedFact

Converts to this type from the input type.

impl From<bool> for Tensor

fn from(it: bool) -> Tensor

Converts to this type from the input type.

impl From<f16> for Tensor

fn from(it: f16) -> Tensor

Converts to this type from the input type.

impl From<f32> for Tensor

fn from(it: f32) -> Tensor

Converts to this type from the input type.

impl From<f64> for Tensor

fn from(it: f64) -> Tensor

Converts to this type from the input type.

impl From<i16> for Tensor

fn from(it: i16) -> Tensor

Converts to this type from the input type.

impl From<i32> for Tensor

fn from(it: i32) -> Tensor

Converts to this type from the input type.

impl From<i64> for Tensor

fn from(it: i64) -> Tensor

Converts to this type from the input type.

impl From<i8> for Tensor

fn from(it: i8) -> Tensor

Converts to this type from the input type.

impl From<u16> for Tensor

fn from(it: u16) -> Tensor

Converts to this type from the input type.

impl From<u32> for Tensor

fn from(it: u32) -> Tensor

Converts to this type from the input type.

impl From<u64> for Tensor

fn from(it: u64) -> Tensor

Converts to this type from the input type.

impl From<u8> for Tensor

fn from(it: u8) -> Tensor

Converts to this type from the input type.

impl Hash for Tensor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoArcTensor for Tensor

fn into_arc_tensor(self) -> Arc<Tensor>

Convert Self to a Arc.

impl IntoTValue for Tensor

fn into_tvalue(self) -> TValue

impl IntoTensor for Tensor

fn into_tensor(self) -> Tensor

Convert Self to a Tensor.

impl PartialEq for Tensor

fn eq(&self, other: &Tensor) -> 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 Resource for Tensor

fn get(&self, _key: &str) -> Result<Value, Error>

Get value for a given key.

impl Eq for Tensor

impl Send for Tensor

impl Sync for Tensor