Struct AnyScalar 

pub struct AnyScalar { /* private fields */ }

Dynamic scalar compatibility wrapper for tensor4all-core.

This owns a rank-0 TensorDynLen so that scalar values can participate in the same eager autodiff graph as tensors while preserving the existing dynamic scalar API shape.

Implementations

impl AnyScalar

pub fn from_value<T: TensorElement>(value: T) -> Self

pub fn from_real(x: f64) -> Self

pub fn from_complex(re: f64, im: f64) -> Self

pub fn new_real(x: f64) -> Self

pub fn new_complex(re: f64, im: f64) -> Self

pub fn primal(&self) -> Self

pub fn enable_grad(self) -> Self

pub fn tracks_grad(&self) -> bool

pub fn grad(&self) -> Result<Option<Self>>

pub fn clear_grad(&self) -> Result<()>

pub fn backward(&self) -> Result<()>

pub fn detach(&self) -> Self

pub fn real(&self) -> f64

pub fn imag(&self) -> f64

pub fn abs(&self) -> f64

pub fn is_complex(&self) -> bool

pub fn is_real(&self) -> bool

pub fn is_zero(&self) -> bool

pub fn as_f64(&self) -> Option<f64>

pub fn as_c64(&self) -> Option<Complex64>

pub fn conj(&self) -> Self

pub fn real_part(&self) -> Self

pub fn imag_part(&self) -> Self

pub fn compose_complex(real: Self, imag: Self) -> Result<Self>

pub fn sqrt(&self) -> Self

pub fn powf(&self, exponent: f64) -> Self

pub fn powi(&self, exponent: i32) -> Self

Trait Implementations

impl Add<&AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the + operator.

fn add(self, rhs: &AnyScalar) -> Self::Output

Performs the + operation.

impl Add<&AnyScalar> for AnyScalar

type Output = AnyScalar

The resulting type after applying the + operator.

fn add(self, rhs: &AnyScalar) -> Self::Output

Performs the + operation.

impl Add<AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for AnyScalar

type Output = AnyScalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for AnyScalar

fn clone(&self) -> AnyScalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnyScalar

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

Formats the value using the given formatter.

impl Default for AnyScalar

fn default() -> Self

Returns the “default value” for a type.

impl Display for AnyScalar

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

Formats the value using the given formatter.

impl Div<&AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the / operator.

fn div(self, rhs: &AnyScalar) -> Self::Output

Performs the / operation.

impl Div<&AnyScalar> for AnyScalar

type Output = AnyScalar

The resulting type after applying the / operator.

fn div(self, rhs: &AnyScalar) -> Self::Output

Performs the / operation.

impl Div<AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the / operator.

fn div(self, rhs: AnyScalar) -> Self::Output

Performs the / operation.

impl Div<AnyScalar> for Complex64

type Output = AnyScalar

The resulting type after applying the / operator.

fn div(self, rhs: AnyScalar) -> Self::Output

Performs the / operation.

impl Div for AnyScalar

type Output = AnyScalar

The resulting type after applying the / operator.

fn div(self, rhs: AnyScalar) -> Self::Output

Performs the / operation.

impl From<AnyScalar> for Complex64

fn from(value: AnyScalar) -> Self

Converts to this type from the input type.

impl From<Complex<f32>> for AnyScalar

fn from(value: Complex32) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for AnyScalar

fn from(value: Complex64) -> Self

Converts to this type from the input type.

impl From<f32> for AnyScalar

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for AnyScalar

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul<&AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the * operator.

fn mul(self, rhs: &AnyScalar) -> Self::Output

Performs the * operation.

impl Mul<&AnyScalar> for AnyScalar

type Output = AnyScalar

The resulting type after applying the * operator.

fn mul(self, rhs: &AnyScalar) -> Self::Output

Performs the * operation.

impl Mul<AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<AnyScalar> for Complex64

type Output = AnyScalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<AnyScalar> for f64

type Output = AnyScalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for AnyScalar

type Output = AnyScalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for &AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl One for AnyScalar

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl PartialEq for AnyScalar

fn eq(&self, other: &Self) -> 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 PartialOrd for AnyScalar

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<&AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn sub(self, rhs: &AnyScalar) -> Self::Output

Performs the - operation.

impl Sub<&AnyScalar> for AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn sub(self, rhs: &AnyScalar) -> Self::Output

Performs the - operation.

impl Sub<AnyScalar> for &AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn sub(self, rhs: AnyScalar) -> Self::Output

Performs the - operation.

impl Sub for AnyScalar

type Output = AnyScalar

The resulting type after applying the - operator.

fn sub(self, rhs: AnyScalar) -> Self::Output

Performs the - operation.

impl SumFromStorage for AnyScalar

fn sum_from_storage(storage: &Storage) -> Self

Compute the sum of all elements in the storage.

impl TryFrom<AnyScalar> for f64

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: AnyScalar) -> Result<Self, Self::Error>

Performs the conversion.

impl Zero for AnyScalar

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.