Skip to main content

Matrix

cubecl_core::frontend::cmma

Struct Matrix 

Source 
pub struct Matrix<C: CubeType, S: MatrixScope = Plane> { /* private fields */ }
Expand description

A matrix represent a 2D grid of numbers.

They can either be in a row major or a column major format.

Implementations§

Source§

impl<C: CubePrimitive, S: MatrixScope> Matrix<C, S>

Source

pub unsafe fn uninitialized( ident: MatrixIdent, m: usize, n: usize, k: usize, layout: MatrixLayout, ) -> Self

Create a new uninitialized matrix that is going to be used in the matrix-multiply and accumulate function.

§Safety

Must be initialized with load or fill before use. Using it without initialization is undefined behaviour on CUDA, and completely invalid on Vulkan.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn from_value( ident: MatrixIdent, m: usize, n: usize, k: usize, layout: MatrixLayout, value: C, ) -> Self
where C: Scalar,

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is filled with value.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn from_slice( ident: MatrixIdent, m: usize, n: usize, k: usize, layout: MatrixLayout, value: &[C], stride: u32, ) -> Self

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is loaded from value with stride.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn from_tensor( ident: MatrixIdent, m: usize, n: usize, k: usize, value: &TensorView<C>, ) -> Self

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is loaded from value with stride.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn __expand_uninitialized( scope: &Scope, ident: MatrixIdent, m: usize, n: usize, k: usize, layout: <MatrixLayout as CubeType>::ExpandType, ) -> <Self as CubeType>::ExpandType

Create a new uninitialized matrix that is going to be used in the matrix-multiply and accumulate function.

§Safety

Must be initialized with load or fill before use. Using it without initialization is undefined behaviour on CUDA, and completely invalid on Vulkan.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn __expand_from_value( scope: &Scope, ident: MatrixIdent, m: usize, n: usize, k: usize, layout: <MatrixLayout as CubeType>::ExpandType, value: <C as CubeType>::ExpandType, ) -> <Self as CubeType>::ExpandType
where C: Scalar,

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is filled with value.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn __expand_from_slice( scope: &Scope, ident: MatrixIdent, m: usize, n: usize, k: usize, layout: <MatrixLayout as CubeType>::ExpandType, value: &<[C] as CubeType>::ExpandType, stride: <u32 as CubeType>::ExpandType, ) -> <Self as CubeType>::ExpandType

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is loaded from value with stride.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Source

pub fn __expand_from_tensor( scope: &Scope, ident: MatrixIdent, m: usize, n: usize, k: usize, value: &<TensorView<C> as CubeType>::ExpandType, ) -> <Self as CubeType>::ExpandType

Create a new matrix that is going to be used in the matrix-multiply and accumulate function and is loaded from value with stride.

You have to declare the shape used for the execution. The shape of the current matrix is determined using the MatrixIdent.

Not all shapes are supported, and the permitted shapes depend on the element type.

Refer to nvidia documentation.

Trait Implementations§

Source§

impl<C: Clone + CubeType, S: Clone + MatrixScope> Clone for Matrix<C, S>

Source§

fn clone(&self) -> Matrix<C, S>

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<C: Copy + CubeType, S: Copy + MatrixScope> Copy for Matrix<C, S>

Source§

impl<C: CubeType, S: MatrixScope> CubeType for Matrix<C, S>

Source§

type ExpandType = MatrixExpand<C, S>

Auto Trait Implementations§

§

impl<C, S> Freeze for Matrix<C, S>

§

impl<C, S> RefUnwindSafe for Matrix<C, S>
where C: RefUnwindSafe, S: RefUnwindSafe,

§

impl<C, S> Send for Matrix<C, S>
where C: Send, S: Send,

§

impl<C, S> Sync for Matrix<C, S>
where C: Sync, S: Sync,

§

impl<C, S> Unpin for Matrix<C, S>
where C: Unpin, S: Unpin,

§

impl<C, S> UnsafeUnpin for Matrix<C, S>

§

impl<C, S> UnwindSafe for Matrix<C, S>
where C: UnwindSafe, S: UnwindSafe,

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

Source§

fn __expand_clone_method(&self, _: &Scope) -> T

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

Source§

fn comptime(self) -> Self

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> 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 = 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> TuneInputs for T
where T: Clone + Send + Sync + 'static,

Source§

type At<'a> = T

The concrete input type at lifetime 'a.