Enum ContractionScalar 

pub enum ContractionScalar {
    F32(f32),
    F64(f64),
    C32(Complex32),
    C64(Complex64),
}

Scalar coefficient accepted by contraction accumulation backends.

ContractionScalar is intentionally narrower than crate::TensorScalar: dot-general accumulation is only defined for floating and complex tensor dtypes.

Examples

use tenferro_tensor::{ContractionScalar, DType};

let alpha = ContractionScalar::F64(2.0);
assert_eq!(alpha.dtype(), DType::F64);

Variants

F32(f32)

F64(f64)

C32(Complex32)

C64(Complex64)

Implementations

impl ContractionScalar

pub fn dtype(self) -> DType

Return this scalar’s tensor dtype.

Examples

use tenferro_tensor::{ContractionScalar, DType};

assert_eq!(ContractionScalar::F32(1.0).dtype(), DType::F32);

pub fn one(dtype: DType) -> Result<Self>

Return the multiplicative identity for a supported contraction dtype.

Examples

use tenferro_tensor::{ContractionScalar, DType};

assert_eq!(ContractionScalar::one(DType::F64).unwrap(), ContractionScalar::F64(1.0));
assert!(ContractionScalar::one(DType::I32).is_err());

pub fn zero(dtype: DType) -> Result<Self>

Return the additive identity for a supported contraction dtype.

Examples

use tenferro_tensor::{ContractionScalar, DType};

assert_eq!(ContractionScalar::zero(DType::F64).unwrap(), ContractionScalar::F64(0.0));

Trait Implementations

impl Clone for ContractionScalar

fn clone(&self) -> ContractionScalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractionScalar

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

Formats the value using the given formatter.

impl PartialEq for ContractionScalar

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ContractionScalar

impl StructuralPartialEq for ContractionScalar