Enum Scalar 

pub enum Scalar {
    Int(i64),
    UInt(u64),
    Float(f64),
    Bool(bool),
}

A typed scalar value stored alongside tensors in a burnpack container.

Scalars are kept in the CBOR metadata section (not the tensor data section), so they carry no alignment cost. The field is optional in the format: files written before scalar support simply omit it, and readers default it to empty.

Convert to/from the primitive numeric and boolean types with From / TryFrom (e.g. Scalar::from(3usize), u32::try_from(scalar)).

Variants

Int(i64)

A signed integer.

UInt(u64)

An unsigned integer.

Float(f64)

A floating-point number.

Bool(bool)

A boolean.

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Scalar

impl Debug for Scalar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scalar

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<bool> for Scalar

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Scalar

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Scalar

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i8> for Scalar

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<i16> for Scalar

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Scalar

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Scalar

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<isize> for Scalar

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u8> for Scalar

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<u16> for Scalar

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Scalar

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<usize> for Scalar

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Scalar

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Scalar

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scalar

impl TryFrom<Scalar> for i8

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for i16

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for i32

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for i64

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for isize

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for u8

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for u16

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for u32

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for u64

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for usize

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for f64

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for f32

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for bool

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.