Skip to main content

Type

Enum Type 

Source
pub enum Type {
    Scalar(StorageType),
    Opaque(OpaqueType),
    Vector(Intern<Type>, VectorSize),
    Semantic(SemanticType),
    Atomic(Intern<Type>),
    Pointer(Intern<Type>, AddressSpace),
    Array(Intern<Type>, usize),
    DynamicArray(Intern<Type>),
    Matrix(MatrixType),
    Aggregate(AggregateKind),
}

Variants§

§

Scalar(StorageType)

Scalar type containing a single storage element

§

Opaque(OpaqueType)

Opaque types that can be stored but not interacted with normally. i.e. barrier, arrival tokens and tensor map descriptor.

§

Vector(Intern<Type>, VectorSize)

Vector wrapping n storage elements

§

Semantic(SemanticType)

No defined physical representation, purely semantic. i.e. barrier, pipeline

§

Atomic(Intern<Type>)

Atomically accessed version of Type

§

Pointer(Intern<Type>, AddressSpace)

Pointer of Type into a PointerClass

§

Array(Intern<Type>, usize)

Statically sized array of Types

§

DynamicArray(Intern<Type>)

Dynamically sized array of Types

§

Matrix(MatrixType)

Cooperative Matrix

§

Aggregate(AggregateKind)

Implementations§

Source§

impl Type

Source

pub fn intern(self) -> Intern<Type>

Source

pub fn elem_type(&self) -> ElemType

Fetch the elem of the item.

Source

pub fn new(storage: StorageType) -> Self

Create a new item

Source

pub fn scalar(elem: ElemType) -> Self

Source

pub fn semantic(ty: SemanticType) -> Self

Source

pub fn atomic(ty: impl Into<Type>) -> Self

Source

pub fn with_vector_size(self, vector_size: VectorSize) -> Self

Source

pub fn pointer(ty: impl Into<Type>, class: AddressSpace) -> Self

Source

pub fn array(ty: impl Into<Type>, size: usize) -> Self

Source

pub fn vector_size(&self) -> VectorSize

Source

pub fn array_size(&self) -> usize

Source

pub fn align(&self) -> usize

Source

pub fn size(&self) -> usize

Source

pub fn size_bits(&self) -> usize

Source

pub fn packing_factor(&self) -> usize

Source

pub fn is_atomic(&self) -> bool

Source

pub fn is_ptr(&self) -> bool

Source

pub fn is_int(&self) -> bool

Source

pub fn is_signed_int(&self) -> bool

Source

pub fn is_unsigned_int(&self) -> bool

Source

pub fn is_float(&self) -> bool

Source

pub fn is_bool(&self) -> bool

Source

pub fn storage_type(&self) -> StorageType

Source

pub fn as_scalar(&self) -> Self

Source

pub fn scalar_value_type(&self) -> Self

Utility mainly for use in cubecl-cpu

Source

pub fn is_semantic(&self) -> bool

Source

pub fn constant(&self, value: ConstantValue) -> Value

Source

pub fn unwrap_ptr(&self) -> Type

Source

pub fn address_space(&self) -> Option<AddressSpace>

Source

pub fn value_type(&self) -> Type

Source

pub fn is_array_like(&self) -> bool

Source

pub fn is_destructurable(&self) -> bool

Whether a type is destructurable. This implies that

  • it does not have dynamic field offsets (i.e. Array)
  • it can exist in registers (i.e. no Barrier or Atomic)
Source

pub fn is_value(&self) -> bool

Trait Implementations§

Source§

impl Clone for Type

Source§

fn clone(&self) -> Type

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 Copy for Type

Source§

impl Debug for Type

Source§

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

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

impl<'de> Deserialize<'de> for Type

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Type

Source§

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

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

impl Eq for Type

Source§

impl From<OpaqueType> for Type

Source§

fn from(val: OpaqueType) -> Self

Converts to this type from the input type.
Source§

impl From<SemanticType> for Type

Source§

fn from(val: SemanticType) -> Self

Converts to this type from the input type.
Source§

impl<T: Into<StorageType>> From<T> for Type

Source§

fn from(val: T) -> Self

Converts to this type from the input type.
Source§

impl Hash for Type

Intern hashes the pointer, not the values, leading to unstable hashes across runs. Fix this by manually hashing the value.

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Type

Source§

fn cmp(&self, other: &Type) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Type

Source§

fn eq(&self, other: &Type) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for Type

Source§

fn partial_cmp(&self, other: &Type) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Type

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Type

Source§

impl TypeHash for Type

Source§

fn write_hash(hasher: &mut impl Hasher)

Write the structure of the type to the hasher
Source§

fn type_hash() -> u64

Generate a stable hash of the type structure. Read more

Auto Trait Implementations§

§

impl Freeze for Type

§

impl RefUnwindSafe for Type

§

impl Send for Type

§

impl Sync for Type

§

impl Unpin for Type

§

impl UnsafeUnpin for Type

§

impl UnwindSafe for Type

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.