Skip to main content

HostBuffer

Enum HostBuffer 

Source
pub enum HostBuffer {
Show 16 variants U8(Vec<u8>), I8(Vec<i8>), U32(Vec<u32>), I16(Vec<i16>), I32(Vec<i32>), I64(Vec<i64>), BF16(Vec<bf16>), F16(Vec<f16>), F32(Vec<f32>), F64(Vec<f64>), F8E4M3(Vec<F8E4M3>), F6E2M3(Vec<u8>), F6E3M2(Vec<u8>), F4(Vec<u8>), F8E8M0(Vec<u8>), Bool(Vec<u8>),
}
Expand description

Host-addressable tensor storage holding a typed vector of elements.

This is the universal interchange format for moving tensor data between backends: every BackendStorage can produce one via to_host_buffer(), and every BackendDevice can ingest one via storage_from_host_buffer().

Previously named CpuStorage — that name remains as a type alias.

Variants§

§

U8(Vec<u8>)

§

I8(Vec<i8>)

§

U32(Vec<u32>)

§

I16(Vec<i16>)

§

I32(Vec<i32>)

§

I64(Vec<i64>)

§

BF16(Vec<bf16>)

§

F16(Vec<f16>)

§

F32(Vec<f32>)

§

F64(Vec<f64>)

§

F8E4M3(Vec<F8E4M3>)

§

F6E2M3(Vec<u8>)

§

F6E3M2(Vec<u8>)

§

F4(Vec<u8>)

§

F8E8M0(Vec<u8>)

§

Bool(Vec<u8>)

Boolean mask storage (GAP-168(c)). One byte per element (0/1), byte-identical to U8 — but a DISTINCT variant so a Bool buffer can never be silently consumed as U8. The comparison kernels write 0/1 bytes here; where_cond/masked_fill read it as a byte mask.

Implementations§

Source§

impl HostBuffer

Source

pub fn dtype(&self) -> DType

Returns the DType of the elements stored.

Source

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

Returns a typed slice of the stored data.

Source

pub fn concat(storages: &[HostBuffer]) -> Result<HostBuffer, Error>

Concatenates multiple storages of the same dtype into one.

Source

pub fn as_ref(&self) -> HostBufferRef<'_>

Borrow this buffer as a HostBufferRef (zero-copy).

The ref form is the common shape for HostStorage::as_host_buffer_ref; owned-buffer implementors delegate through here.

Trait Implementations§

Source§

impl Clone for HostBuffer

Source§

fn clone(&self) -> HostBuffer

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 HostBuffer

Source§

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

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

impl From<CpuStorage> for HostBuffer

Source§

fn from(s: CpuStorage) -> HostBuffer

Converts to this type from the input type.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more