Skip to main content

FlexTensor

Struct FlexTensor 

Source
pub struct FlexTensor { /* private fields */ }
Expand description

CPU tensor primitive for the Flex backend.

Uses type-erased byte storage with runtime dtype and Arc-based sharing. Clone is O(1) (refcount increment). Copy-on-write for mutations.

Implementations§

Source§

impl FlexTensor

Source

pub fn new(data: Bytes, layout: Layout, dtype: DType) -> Self

Create a new tensor from bytes, layout, and dtype.

Source

pub fn from_data(data: TensorData) -> Self

Create a tensor from TensorData.

Source

pub fn into_data(self) -> TensorData

Convert tensor to TensorData.

If non-contiguous or shared, this will copy data.

Source

pub fn is_unique(&self) -> bool

Check if this tensor has exclusive ownership of its data.

When true, in-place mutations are safe without copying.

Source

pub fn layout(&self) -> &Layout

Get the layout.

Source

pub fn with_layout(self, layout: Layout) -> Self

Create a new tensor with a different layout but sharing the same data.

This is a zero-copy operation used for operations like flip, transpose, etc.

Source

pub fn dtype(&self) -> DType

Get the dtype.

Source

pub fn is_contiguous(&self) -> bool

Check if tensor is contiguous.

Source

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

Get the raw bytes (read-only).

Source

pub fn data_arc(&self) -> Arc<Bytes>

Get a clone of the Arc for sharing data with a new layout.

Use this for zero-copy view operations (reshape, transpose, slice).

Source

pub fn from_arc(data: Arc<Bytes>, layout: Layout, dtype: DType) -> Self

Create a tensor from shared data, layout, and dtype.

Use this for zero-copy view operations.

Source

pub fn storage<E: Element + Pod>(&self) -> &[E]

Zero-copy typed view of the full storage buffer.

Use with StridedIter for non-contiguous access, or with layout().contiguous_offsets() for the contiguous fast path.

§Panics

Panics if E::dtype() doesn’t match the tensor’s dtype. Note: Bool tensors are stored as u8, so both Bool(Native) and Bool(U8) dtypes accept u8 access.

Source

pub fn storage_mut<E: Element + Pod>(&mut self) -> &mut [E]

Mutable typed view with copy-on-write semantics.

If the tensor is shared (refcount > 1), this will copy the data first. For in-place operations, prefer try_storage_mut() which returns None if shared, allowing you to choose an alternative strategy.

§Panics

Panics if E::dtype() doesn’t match the tensor’s dtype. Note: Bool tensors are stored as u8, so both Bool(Native) and Bool(U8) dtypes accept u8 access.

Source

pub fn try_storage_mut<E: Element + Pod>(&mut self) -> Option<&mut [E]>

Try to get mutable storage without copying.

Returns Some if tensor is uniquely owned, None if shared. Use this when you want to avoid the implicit copy in storage_mut(). Note: Bool tensors are stored as u8, so both Bool(Native) and Bool(U8) dtypes accept u8 access.

Source

pub fn as_slice<E: Element + Pod>(&self) -> Option<&[E]>

Get typed slice view (zero-cost if contiguous and offset is 0).

Returns None if dtype doesn’t match E or tensor is non-contiguous.

Source

pub fn empty(shape: Shape, dtype: DType) -> Self

Create an empty tensor with given shape and dtype.

Source

pub fn zeros(shape: Shape, dtype: DType) -> Self

Create a tensor filled with zeros.

Source

pub fn filled_typed<E: Pod + Send + Sync>( shape: Shape, dtype: DType, value: E, ) -> Self

Create a tensor filled with n copies of a typed value.

Source

pub fn to_contiguous(&self) -> Self

Copy to contiguous layout if needed.

Source

pub fn reshape(&self, new_shape: Shape) -> Self

Reshape tensor. Zero-copy if contiguous.

Source

pub fn transpose(&self, dim1: usize, dim2: usize) -> Self

Transpose two dimensions. Zero-copy (metadata only).

Source

pub fn narrow(&self, dim: usize, start: usize, len: usize) -> Self

Narrow/slice along a dimension. Zero-copy (metadata only).

Source

pub fn permute(&self, axes: &[usize]) -> Self

Permute dimensions according to axes. Zero-copy (metadata only).

Trait Implementations§

Source§

impl Clone for FlexTensor

Source§

fn clone(&self) -> FlexTensor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlexTensor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl TensorMetadata for FlexTensor

Source§

fn dtype(&self) -> DType

The dtype of the tensor.
Source§

fn shape(&self) -> Shape

The shape of the tensor.
Source§

fn rank(&self) -> usize

The number of dimensions of the tensor.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.