Skip to main content

DotGeneralAccumulation

Struct DotGeneralAccumulation 

Source
pub struct DotGeneralAccumulation {
    pub lhs_conj: bool,
    pub rhs_conj: bool,
    pub alpha: ContractionScalar,
    pub beta: ContractionScalar,
}
Expand description

Output-update semantics for dot-general accumulation.

This keeps contraction axes in DotGeneralConfig and output update semantics here, so cached and non-cached backend traits can share the same accumulation contract.

§Examples

use tenferro_tensor::{ContractionScalar, DotGeneralAccumulation, DType};

let accum = DotGeneralAccumulation::overwrite(DType::F64).unwrap();
assert_eq!(accum.alpha, ContractionScalar::F64(1.0));
assert_eq!(accum.beta, ContractionScalar::F64(0.0));

Fields§

§lhs_conj: bool§rhs_conj: bool§alpha: ContractionScalar§beta: ContractionScalar

Implementations§

Source§

impl DotGeneralAccumulation

Source

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

Return overwrite semantics, out = lhs dot rhs, for dtype.

Source

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

Return additive update semantics, out += lhs dot rhs, for dtype.

§Examples
use tenferro_tensor::{ContractionScalar, DType, DotGeneralAccumulation};

let accum = DotGeneralAccumulation::add_to(DType::F64)?;
assert_eq!(accum.alpha, ContractionScalar::F64(1.0));
assert_eq!(accum.beta, ContractionScalar::F64(1.0));
Source

pub fn scaled(alpha: ContractionScalar, beta: ContractionScalar) -> Result<Self>

Return scaled update semantics, out = alpha * lhs dot rhs + beta * out.

§Examples
use tenferro_tensor::{ContractionScalar, DotGeneralAccumulation};

let accum = DotGeneralAccumulation::scaled(
    ContractionScalar::F32(0.5),
    ContractionScalar::F32(2.0),
)?;
assert_eq!(accum.alpha, ContractionScalar::F32(0.5));

Trait Implementations§

Source§

impl Clone for DotGeneralAccumulation

Source§

fn clone(&self) -> DotGeneralAccumulation

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 Debug for DotGeneralAccumulation

Source§

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

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

impl PartialEq for DotGeneralAccumulation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Copy for DotGeneralAccumulation

Source§

impl StructuralPartialEq for DotGeneralAccumulation

Auto Trait Implementations§

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