Struct tract_core::internal::Tensor

source ·

pub struct Tensor { /* private fields */ }

Expand description

Tensor is a concrete tensor in tract.

Implementations§

source §

impl Tensor

source

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

Create an uninitialized tensor (dt as type paramater).

source

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

Create an uninitialized tensor (dt as regular parameter).

source

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).

source

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).

source

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

source

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

source

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

source

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

source

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.

source

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.

source

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.

source

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

source

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

source

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

source

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

source

pub fn rank(&self) -> usize

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

source

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

Get the shape of the tensor.

source

pub fn len(&self) -> usize

Get the number of valeus in the tensor.

source

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

Get the shape of the tensor.

source

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

Force the tensor shape, no consistency check.

source

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

Force the tensor shape.

source

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

source

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

source

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

source

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

source

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

Reshape the tensor to shape.

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn datum_type(&self) -> DatumType

Get the datum type of the tensor.

source

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

Set the datum type of the tensor.

source

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.

source

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

Compare two tensors, allowing for rounding errors.

source

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

Transform the tensor into a ndarray::Array.

source

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

Transform the tensor into a ndarray::Array.

source

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

Transform the data as a ndarray::Array.

source

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.

source

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

Transform the data as a ndarray::Array.

source

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.

source

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

Access the data as a pointer.

source

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

Access the data as a pointer.

source

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

Access the data as a pointer.

source

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

Access the data as a mutable pointer.

source

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

Access the data as a slice.

source

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

Access the data as a mutable slice.

source

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

Access the data as a slice.

source

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

Access the data as a mutable slice.

source

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

Access the data as a scalar.

source

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

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

source

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

Access the data as a scalar.

source

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

Mutable access the data as a scalar.

source

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

Mutable access the data as a scalar.

source

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

source

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

source

pub fn is_uniform(&self) -> bool

source

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

source

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

source

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

Optionnaly convert data to a tensor for a new DatumType.

source

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

Optionnaly convert data to a tensor for a new DatumType.

source

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

Access the data as a scalar, after a cast.

source

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

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

source

pub fn deep_clone(&self) -> Tensor

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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.

source

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.

source

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

Trait Implementations§

source §

impl Borrow<Tensor> for TValue

source §

fn borrow(&self) -> &Tensor

Immutably borrows from an owned value. Read more

source §

impl Clone for Tensor

source §

fn clone(&self) -> Tensor

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

source §

impl Debug for Tensor

source §

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

Formats the value using the given formatter. Read more

source §

impl Default for Tensor

source §

fn default() -> Tensor

Returns the “default value” for a type. Read more

source §

impl Drop for Tensor

source §

fn drop(&mut self)

Executes the destructor for this type. Read more

source §