Struct tract_data::prelude::Tensor

pub struct Tensor { /* private fields */ }

Tensor is a concrete tensor in tract.

Implementations

impl Tensor

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

Create an uninitialized tensor (dt as type paramater).

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

Create an uninitialized tensor (dt as regular parameter).

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

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

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

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

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

pub fn clear<T: Datum + Zero + Clone>(&mut self) -> Result<()>

pub fn zero<T: Datum + Zero>(shape: &[usize]) -> Result<Tensor>

pub fn zero_scalar<T: Datum + Zero>() -> Result<Tensor>

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

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

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

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

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

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

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: Datum + Copy>( shape: &[usize], data: &[T], align: usize ) -> Result<Tensor>

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: Datum>( shape: &[usize], content: &[u8] ) -> Result<Tensor>

Create a tensor from raw data.

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

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

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

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

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

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 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 fn set_shape(&mut self, shape: &[usize]) -> Result<()>

Force the tensor shape.

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

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

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

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

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

Reshape the tensor to shape.

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

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

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

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

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

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

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>

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: &Self, approx: impl Into<Approximation> + Debug ) -> Result<()>

Compare two tensors, allowing for rounding errors.

pub fn into_array<D: Datum>(self) -> Result<ArrayD<D>>

Transform the tensor into a ndarray::Array.

pub unsafe fn into_array_unchecked<D: Datum>(self) -> ArrayD<D>

Transform the tensor into a ndarray::Array.

pub fn to_array_view<D: Datum>(&self) -> Result<ArrayViewD<'_, D>>

Transform the data as a ndarray::Array.

pub fn to_array_view_mut<D: Datum>(&mut self) -> Result<ArrayViewMutD<'_, D>>

Transform the data as a mutable ndarray::Array.

pub unsafe fn to_array_view_unchecked<D: Datum>(&self) -> ArrayViewD<'_, D>

Transform the data as a ndarray::Array.

pub unsafe fn to_array_view_mut_unchecked<D: Datum>( &mut self ) -> ArrayViewMutD<'_, D>

Transform the data as a mutable ndarray::Array.

pub fn as_ptr<D: Datum>(&self) -> Result<*const D>

Access the data as a pointer.

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

Access the data as a pointer.

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

Access the data as a pointer.

pub fn as_ptr_mut<D: Datum>(&mut self) -> Result<*mut D>

Access the data as a mutable pointer.

pub fn as_slice<D: Datum>(&self) -> Result<&[D]>

Access the data as a slice.

pub fn as_slice_mut<D: Datum>(&mut self) -> Result<&mut [D]>

Access the data as a mutable slice.

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

Access the data as a slice.

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

Access the data as a mutable slice.

pub fn to_scalar<D: Datum>(&self) -> Result<&D>

Access the data as a scalar.

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

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

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

Access the data as a scalar.

pub fn to_scalar_mut<D: Datum>(&mut self) -> Result<&mut D>

Mutable access the data as a scalar.

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

Mutable access the data as a scalar.

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

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

pub fn is_uniform(&self) -> bool

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

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

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

Optionnaly convert data to a tensor for a new DatumType.

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

Optionnaly convert data to a tensor for a new DatumType.

pub fn cast_to_scalar<D: Datum + Copy>(&self) -> Result<D>

Access the data as a scalar, after a cast.

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

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>

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

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

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

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<'_>>

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

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

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

Trait Implementations

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

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: Dimension, T: Datum> From<ArrayBase<OwnedRepr<T>, D>> for Tensor

fn from(it: Array<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<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<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: Hasher>(&self, state: &mut H)

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 IntoTensor for Tensor

fn into_tensor(self) -> Tensor

Convert Self to a Tensor.

impl PartialEq<Tensor> for Tensor

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

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

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

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

impl Eq for Tensor

impl Send for Tensor

impl StructuralEq for Tensor

impl Sync for Tensor