Struct TensorBuilder

Source
pub struct TensorBuilder<const DIM: usize> { /* private fields */ }
Expand description

Helper struct for creating gpu storage buffers (scalars, vectors, matrices, tensors).

When building a scalar, vector, or matrix tensor, it might be more convenient to call GpuScalar::init, GpuVector::init, GpuMatrix::init (or their encase variants: GpuScalar::encase, GpuVector::encase, GpuMatrix::encase; or their uninitialized variants GpuScalar::uninit, GpuVector::uninit, GpuMatrix::uninit).

Implementations§

Source§

impl TensorBuilder<0>

Source

pub fn scalar(usage: BufferUsages) -> Self

Starts building a storage buffer containing a single scalar value.

Source§

impl TensorBuilder<1>

Source

pub fn vector(dim: u32, usage: BufferUsages) -> Self

Starts building a storage buffer containing a vector.

Source§

impl TensorBuilder<2>

Source

pub fn matrix(nrows: u32, ncols: u32, usage: BufferUsages) -> Self

Starts building a storage buffer containing a single matrix with nrows rows and ncols columns.

Source§

impl<const DIM: usize> TensorBuilder<DIM>

Source

pub fn tensor(shape: [u32; DIM], usage: BufferUsages) -> Self

Starts building a storage buffer containing a tensor with the specified shape.

Source

pub fn label(self, label: String) -> Self

Sets the debug label of this tensor.

Source

pub fn build<T: Pod>(self, device: &Device) -> GpuTensor<T, DIM>

Builds the gpu tensor.

Source

pub fn build_bytes<T>(self, device: &Device, data: &[u8]) -> GpuTensor<T, DIM>

Builds this tensor with raw bytes given for its initial value.

Source

pub fn build_encase<T>( self, device: &Device, data: impl AsRef<[T]>, ) -> GpuTensor<T, DIM>

Builds this tensor with raw bytes given for its initial value.

Source

pub fn build_init<T: Pod>( self, device: &Device, data: &[T], ) -> GpuTensor<T, DIM>

Builds this tensor with an array of values given for its initial value.

Auto Trait Implementations§

§

impl<const DIM: usize> Freeze for TensorBuilder<DIM>

§

impl<const DIM: usize> RefUnwindSafe for TensorBuilder<DIM>

§

impl<const DIM: usize> Send for TensorBuilder<DIM>

§

impl<const DIM: usize> Sync for TensorBuilder<DIM>

§

impl<const DIM: usize> Unpin for TensorBuilder<DIM>

§

impl<const DIM: usize> UnwindSafe for TensorBuilder<DIM>

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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

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

Source§

impl<T> WasmNotSendSync for T

Source§

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