Skip to main content

TensorValue

Struct TensorValue 

pub struct TensorValue { /* private fields */ }
Expand description

Owned tensor value with one move-only physical owner and metadata-only layout.

TensorValue is intentionally not cloneable. View transformations consume the value and move its existing owner; TensorValue::duplicate is the explicit boundary for creating another physical allocation.

Implementations§

§

impl TensorValue

pub fn duplicate(&self) -> Result<TensorValue, Error>

Explicitly duplicate the physical owner represented by this value.

§Errors

Returns [crate::Error::RuntimeState] or [crate::Error::Unsupported] when the backend/storage owner cannot be duplicated.

pub fn from_tensor(tensor: Tensor) -> TensorValue

pub fn from_parts( tensor: Tensor, shape: Vec<usize>, strides: Vec<isize>, offset: isize, ) -> Result<TensorValue, Error>

§Errors

Returns [ValidationError::InvalidArgument] or [ValidationError::IntegerOverflow] when the supplied layout is invalid for the tensor’s physical buffer.

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

Consume an unshared compact value and return its physical owner.

§Errors

Returns [crate::Error::Unsupported] for a metadata-only view or [crate::Error::RuntimeState] when another value retains the shared owner.

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

pub fn is_view(&self) -> bool

pub fn dtype(&self) -> DType

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

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

pub fn offset(&self) -> isize

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

pub fn tensor_read(&self) -> TensorRead<'_>

pub fn transpose_view( self, axes: impl AsRef<[usize]>, ) -> Result<TensorValue, Error>

§Errors

Returns [crate::Error::Validation] with [tenferro_tensor_core::ValidationError::InvalidPermutationLength], [tenferro_tensor_core::ValidationError::AxisOutOfBounds], or [tenferro_tensor_core::ValidationError::DuplicateAxis] when axes is not a valid permutation of the value rank.

pub fn try_reshape_view( self, shape: impl IntoShapeVec, ) -> Result<TensorValue, TensorValueViewError>

§Errors

Returns [crate::Error::Validation] with [tenferro_tensor_core::ValidationError::NonContiguousViewAsSlice] when the source is not compact column-major, [tenferro_tensor_core::ValidationError::ShapeMismatch] (whose [tenferro_tensor_core::ShapeMismatch::ReshapeElementCount] source records the counts) when element counts differ, [tenferro_tensor_core::ValidationError::IntegerOverflow] for shape arithmetic overflow, or [tenferro_tensor_core::ValidationError::ViewOutOfBounds] when the reshaped view exceeds the backing buffer.

pub fn reshape_view( self, shape: impl IntoShapeVec, ) -> Result<TensorValue, Error>

§Errors

Returns [crate::Error::Validation] with [tenferro_tensor_core::ValidationError::NonContiguousViewAsSlice] when the source is not compact, [tenferro_tensor_core::ValidationError::ShapeMismatch] when element counts differ, or [tenferro_tensor_core::ValidationError::IntegerOverflow] / [tenferro_tensor_core::ValidationError::ViewOutOfBounds] for invalid target-shape arithmetic or bounds.

pub fn slice_view(self, config: &SliceConfig) -> Result<TensorValue, Error>

§Errors

Returns [crate::Error::Validation] with [tenferro_tensor_core::ValidationError::RankMismatch] when a slice vector does not match the value rank, [tenferro_tensor_core::ValidationError::InvalidArgument] when a bound or stride cannot be represented or is invalid, [tenferro_tensor_core::ValidationError::InvalidSliceStep] or [tenferro_tensor_core::ValidationError::InvalidSliceBounds] for slice parameters, [tenferro_tensor_core::ValidationError::IntegerOverflow] for slice arithmetic overflow, or [tenferro_tensor_core::ValidationError::ViewOutOfBounds] when the result exceeds the backing buffer.

pub fn broadcast_in_dim_view( self, shape: impl IntoShapeVec, dims: impl AsRef<[usize]>, ) -> Result<TensorValue, Error>

§Errors

Returns [crate::Error::Validation] with [tenferro_tensor_core::ValidationError::RankMismatch], [tenferro_tensor_core::ValidationError::AxisOutOfBounds], or [tenferro_tensor_core::ValidationError::DuplicateAxis] for invalid dimension mappings, [tenferro_tensor_core::ValidationError::ShapeDataLengthMismatch] for incompatible extents, [tenferro_tensor_core::ValidationError::ViewOutOfBounds] when the result exceeds the backing buffer, or [tenferro_tensor_core::ValidationError::IntegerOverflow] for layout arithmetic overflow.

Trait Implementations§

§

impl Debug for TensorValue

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> MaybeSend for T
where T: Send,

§

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

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.