Struct TValue 

pub struct TValue(/* private fields */);

Implementations

impl TValue

pub fn is_exclusive(&self) -> bool

pub fn from_const(t: Arc<Tensor>) -> Self

pub fn as_arc_tensor(&self) -> Option<&Arc<Tensor>>

Methods from Deref<Target = Tensor>

pub fn storage_as<T>(&self) -> Option<&T>

where T: TensorStorage,

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

where T: TensorStorage,

pub fn as_plain(&self) -> Option<PlainView<'_>>

Returns an immutable PlainView if this tensor has plain storage.

pub fn try_as_plain(&self) -> Result<PlainView<'_>, Error>

Returns an immutable PlainView, or an error if storage is not plain.

pub fn is_plain(&self) -> bool

Returns true if this tensor uses plain (contiguous) storage.

pub fn is_exotic(&self) -> bool

Returns true if this tensor uses exotic (non-plain) storage.

pub fn exotic_fact(&self) -> Result<Option<Box<dyn ExoticFact>>, Error>

Build the ExoticFact matching this tensor’s storage, or None for plain tensors.

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 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 datum_type(&self) -> DatumType

Get 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 ulp_comparison_dt(&self) -> DatumType

The float type ULP distances against this tensor are measured in.

Float tensors are compared in their own type, so an f16 comparison stays an f16 comparison. Anything else falls back to f32, matching what close_enough does for its tolerance check.

pub fn max_ulp_distance( &self, other: &Tensor, ) -> Result<(u64, Option<usize>), Error>

Largest integer ULP distance between self and other, and the flat index where it occurs.

Comparison happens in Self::ulp_comparison_dt. See crate::ulp for the exact convention around signed zeros, infinities and NaN.

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

where D: Datum,

Returns a plain array view of the tensor.

Errors if the storage is not plain or the datum type does not match D.

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 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_slice_unchecked<D>(&self) -> &[D]

where D: Datum,

Access the data as a slice.

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 as_bytes(&self) -> &[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 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>

Trait Implementations

impl Borrow<Tensor> for TValue

fn borrow(&self) -> &Tensor

Immutably borrows from an owned value.

impl Clone for TValue

fn clone(&self) -> TValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TValue

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

Formats the value using the given formatter.

impl Deref for TValue

type Target = Tensor

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for TValue

impl From<Tensor> for TValue

fn from(t: Tensor) -> Self

Converts to this type from the input type.

impl IntoArcTensor for TValue

fn into_arc_tensor(self) -> Arc<Tensor>

Convert Self to a Arc.

impl IntoTensor for TValue

fn into_tensor(self) -> Tensor

Convert Self to a Tensor.

impl PartialEq for TValue

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

Equality operator ==.

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

Inequality operator !=.