DType

Enum DType 

Source
pub enum DType {
Show 14 variants Bool, Int8, Int16, Int32, Int64, Uint8, Uint16, Uint32, Uint64, Fp16, Fp32, Fp64, Bf16, Others,
}
Expand description

Enumeration of all supported data types for tensor elements.

This enum represents the various numeric types that can be stored in tensors, including integers, floating-point numbers, and boolean values. Each variant corresponds to a specific Rust primitive type or half-precision type.

§Examples

use slsl::DType;

let dtype = DType::Fp32;
assert_eq!(dtype.size_in_bytes(), 4);
assert!(dtype.is_float());

let int_dtype = DType::Int32;
assert_eq!(int_dtype.size_in_bytes(), 4);
assert!(!int_dtype.is_float());

Variants§

§

Bool

Boolean type (bool)

§

Int8

8-bit signed integer (i8)

§

Int16

16-bit signed integer (i16)

§

Int32

32-bit signed integer (i32)

§

Int64

64-bit signed integer (i64)

§

Uint8

8-bit unsigned integer (u8)

§

Uint16

16-bit unsigned integer (u16)

§

Uint32

32-bit unsigned integer (u32)

§

Uint64

64-bit unsigned integer (u64)

§

Fp16

16-bit floating-point number (half-precision)

§

Fp32

32-bit floating-point number (single-precision)

§

Fp64

64-bit floating-point number (double-precision)

§

Bf16

16-bit brain floating-point number

§

Others

Placeholder variant - should not be used in practice, use _

Implementations§

Source§

impl DType

Source

pub fn size_in_bytes(self) -> usize

Returns the size in bytes of this data type.

This method returns the memory footprint of a single element of this data type, which is useful for memory allocation and layout calculations.

§Returns

The size in bytes as a usize.

§Panics

Panics if called on DType::Others, as this is a placeholder variant and does not correspond to a concrete type.

§Examples
use slsl::DType;

assert_eq!(DType::Bool.size_in_bytes(), 1);
assert_eq!(DType::Int32.size_in_bytes(), 4);
assert_eq!(DType::Fp64.size_in_bytes(), 8);
assert_eq!(DType::Fp16.size_in_bytes(), 2);
Source

pub fn is_float(self) -> bool

Checks if this data type represents a floating-point number.

Returns true for all floating-point variants (including half-precision and brain floating-point types), and false for integer and boolean types.

§Returns

true if the data type is floating-point, false otherwise.

§Examples
use slsl::DType;

// Floating-point types
assert!(DType::Fp16.is_float());
assert!(DType::Fp32.is_float());
assert!(DType::Fp64.is_float());
assert!(DType::Bf16.is_float());

// Non-floating-point types
assert!(!DType::Int32.is_float());
assert!(!DType::Bool.is_float());
assert!(!DType::Uint8.is_float());
Source

pub fn is_integer(self) -> bool

Checks if this data type represents an integer number.

Returns true for all signed and unsigned integer variants, and false for floating-point and boolean types.

§Returns

true if the data type is an integer, false otherwise.

§Examples
use slsl::DType;

// Integer types
assert!(DType::Int8.is_integer());
assert!(DType::Int32.is_integer());
assert!(DType::Uint16.is_integer());
assert!(DType::Uint64.is_integer());

// Non-integer types
assert!(!DType::Fp32.is_integer());
assert!(!DType::Bool.is_integer());
Source

pub fn is_signed_integer(self) -> bool

Checks if this data type represents a signed integer.

Returns true only for signed integer variants.

§Returns

true if the data type is a signed integer, false otherwise.

§Examples
use slsl::DType;

// Signed integer types
assert!(DType::Int8.is_signed_integer());
assert!(DType::Int32.is_signed_integer());
assert!(DType::Int64.is_signed_integer());

// Non-signed integer types
assert!(!DType::Uint32.is_signed_integer());
assert!(!DType::Fp32.is_signed_integer());
assert!(!DType::Bool.is_signed_integer());
Source

pub fn is_unsigned_integer(self) -> bool

Checks if this data type represents an unsigned integer.

Returns true only for unsigned integer variants.

§Returns

true if the data type is an unsigned integer, false otherwise.

§Examples
use slsl::DType;

// Unsigned integer types
assert!(DType::Uint8.is_unsigned_integer());
assert!(DType::Uint32.is_unsigned_integer());
assert!(DType::Uint64.is_unsigned_integer());

// Non-unsigned integer types
assert!(!DType::Int32.is_unsigned_integer());
assert!(!DType::Fp32.is_unsigned_integer());
assert!(!DType::Bool.is_unsigned_integer());

Trait Implementations§

Source§

impl Clone for DType

Source§

fn clone(&self) -> DType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DType

Source§

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

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

impl Ord for DType

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · 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 DType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for DType

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · 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 · 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 · 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 · 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 Copy for DType

Source§

impl Eq for DType

Source§

impl StructuralPartialEq for DType

Auto Trait Implementations§

§

impl Freeze for DType

§

impl RefUnwindSafe for DType

§

impl Send for DType

§

impl Sync for DType

§

impl Unpin for DType

§

impl UnwindSafe for DType

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,