Enum tensorflow_proto::xla::PrimitiveType

#[repr(i32)]pub enum PrimitiveType {
    Invalid,
    Pred,
    S8,
    S16,
    S32,
    S64,
    U8,
    U16,
    U32,
    U64,
    F16,
    F32,
    Bf16,
    F64,
    C64,
    C128,
    Tuple,
    OpaqueType,
    Token,
}

Primitive types are the individual values that can be held in rectangular multidimensional arrays. A description of the rectangular multidimensional array dimensions / primitive type is given by Shape, below.

Variants

Invalid

Invalid primitive type to serve as default.

Pred

Predicates are two-state booleans.

S8

Signed integral values of fixed width.

S16

S32

S64

U8

Unsigned integral values of fixed width.

U16

U32

U64

F16

Floating-point values of fixed width.

Note: if f16s are not natively supported on the device, they will be converted to f16 from f32 at arbirary points in the computation.

F32

Bf16

Truncated 16 bit floating-point format. This is similar to IEEE's 16 bit floating-point format, but uses 1 bit for the sign, 8 bits for the exponent and 7 bits for the mantissa.

F64

C64

Complex values of fixed width.

Paired F32 (real, imag), as in std::complex.

C128

Paired F64 (real, imag), as in std::complex.

Tuple

A tuple is a polymorphic sequence; e.g. a shape that holds different sub-shapes. They are used for things like returning multiple values from a computation; e.g. a computation that returns weights and biases may have a signature that results in a tuple like (f32[784x2000], f32[2000])

If a shape proto has the tuple element type, it may not have any entries in the dimensions field.

OpaqueType

An opaque type used for passing context-specific data to a custom operation. Shapes of this primitive type will have empty dimensions and tuple_shapes fields.

(OPAQUE would be a better name for this identifier, but that conflicts with a macro defined in windows.h.)

Token

A token type threaded between side-effecting operations. Shapes of this primitive type will have empty dimensions and tuple_shapes fields.

Implementations

impl PrimitiveType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of PrimitiveType.

pub fn from_i32(value: i32) -> Option<PrimitiveType>

Converts an i32 to a PrimitiveType, or None if value is not a valid variant.

Trait Implementations

impl Clone for PrimitiveType

fn clone(&self) -> PrimitiveType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PrimitiveType

impl Debug for PrimitiveType

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

Formats the value using the given formatter.

impl Default for PrimitiveType

fn default() -> PrimitiveType

Returns the "default value" for a type.

impl Eq for PrimitiveType

impl From<PrimitiveType> for i32

fn from(value: PrimitiveType) -> i32

Performs the conversion.

impl Hash for PrimitiveType

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for PrimitiveType

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<PrimitiveType> for PrimitiveType

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<PrimitiveType> for PrimitiveType

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

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for PrimitiveType

impl StructuralPartialEq for PrimitiveType