Standard

Struct Standard 

Source
#[repr(transparent)]
pub struct Standard<T: Scalar>(pub T);
Expand description

Standard arithmetic semiring with addition and multiplication.

This represents the usual (+, ×) operations used in linear algebra.

§Example

use omeinsum::algebra::{Standard, Semiring};

let a = Standard(2.0f32);
let b = Standard(3.0f32);

assert_eq!(a.add(b).to_scalar(), 5.0);  // 2 + 3 = 5
assert_eq!(a.mul(b).to_scalar(), 6.0);  // 2 × 3 = 6

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T: Scalar + Zero + One + PartialEq + Add<Output = T> + Mul<Output = T>> Algebra for Standard<T>

Source§

type Index = u32

Index type for argmax tracking
Source§

fn add_with_argmax( self, _self_idx: Self::Index, rhs: Self, _rhs_idx: Self::Index, ) -> (Self, Self::Index)

Addition with argmax tracking. Read more
Source§

fn add_backward( self, _rhs: Self, grad_out: Self::Scalar, _winner_idx: Option<Self::Index>, ) -> (Self::Scalar, Self::Scalar)

Backward pass for addition. Read more
Source§

fn mul_backward( self, rhs: Self, grad_out: Self::Scalar, ) -> (Self::Scalar, Self::Scalar)

Backward pass for multiplication. Read more
Source§

fn needs_argmax() -> bool

Whether this algebra requires argmax tracking for backprop.
Source§

fn is_better(&self, _other: &Self) -> bool

Check if self is “better” than other for tropical selection. Read more
Source§

impl<T: Clone + Scalar> Clone for Standard<T>

Source§

fn clone(&self) -> Standard<T>

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<T: Debug + Scalar> Debug for Standard<T>

Source§

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

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

impl<T: PartialEq + Scalar> PartialEq for Standard<T>

Source§

fn eq(&self, other: &Standard<T>) -> 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<T: Scalar + Zero + One + PartialEq + Add<Output = T> + Mul<Output = T>> Semiring for Standard<T>

Source§

type Scalar = T

The underlying scalar type
Source§

fn zero() -> Self

Additive identity (zero element for ⊕)
Source§

fn one() -> Self

Multiplicative identity (one element for ⊗)
Source§

fn add(self, rhs: Self) -> Self

Addition operation (⊕)
Source§

fn mul(self, rhs: Self) -> Self

Multiplication operation (⊗)
Source§

fn from_scalar(s: T) -> Self

Create from scalar value
Source§

fn to_scalar(self) -> T

Extract scalar value
Source§

fn is_zero(&self) -> bool

Check if this is the zero element
Source§

impl<T: Copy + Scalar> Copy for Standard<T>

Source§

impl<T: Scalar> StructuralPartialEq for Standard<T>

Auto Trait Implementations§

§

impl<T> Freeze for Standard<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Standard<T>
where T: RefUnwindSafe,

§

impl<T> Send for Standard<T>

§

impl<T> Sync for Standard<T>

§

impl<T> Unpin for Standard<T>
where T: Unpin,

§

impl<T> UnwindSafe for Standard<T>
where T: UnwindSafe,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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
§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

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

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

§

fn vzip(self) -> V

§

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