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: ScalarTensorElement>(value: T) -> Self

Creates an AnyScalar from a tensor element.

Use this when you already have a scalar value that implements TensorElement and want to lift it into the dynamic scalar wrapper.

Arguments

• value - The scalar value to wrap.

Returns

A rank-0 AnyScalar containing value.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::from_value(3.0f64);
assert_eq!(scalar.real(), 3.0);
assert!(scalar.is_real());

pub fn from_real(x: f64) -> Self

Creates a real-valued AnyScalar.

This is a convenience wrapper around AnyScalar::from_value.

Arguments

• x - The real scalar value to wrap.

Returns

A rank-0 AnyScalar with real dtype.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::from_real(1.25);
assert_eq!(scalar.as_f64(), Some(1.25));
assert!(scalar.is_real());

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

Creates a complex-valued AnyScalar.

This is a convenience wrapper around AnyScalar::from_value.

Arguments

• re - The real part of the complex value.
• im - The imaginary part of the complex value.

Returns

A rank-0 AnyScalar containing the requested complex number.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::from_complex(1.0, -2.0);
assert_eq!(scalar.as_c64().map(|z| (z.re, z.im)), Some((1.0, -2.0)));
assert!(scalar.is_complex());

pub fn new_real(x: f64) -> Self

Creates a real-valued AnyScalar.

This is an alias for AnyScalar::from_real.

Arguments

• x - The real scalar value to wrap.

Returns

A rank-0 AnyScalar with real dtype.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_real(2.5);
assert_eq!(scalar.real(), 2.5);
assert!(scalar.is_real());

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

Creates a complex-valued AnyScalar.

This is an alias for AnyScalar::from_complex.

Arguments

• re - The real part of the complex value.
• im - The imaginary part of the complex value.

Returns

A rank-0 AnyScalar containing the requested complex number.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(2.0, 3.0);
assert_eq!(scalar.as_c64().map(|z| (z.re, z.im)), Some((2.0, 3.0)));
assert!(scalar.is_complex());

pub fn primal(&self) -> Result<Self>

Returns the detached primal value of this scalar.

This is an alias for AnyScalar::detach.

Returns

A scalar with the same value and no gradient tracking.

Examples

use tensor4all_core::AnyScalar;

let primal = AnyScalar::new_real(5.0).enable_grad().unwrap().primal().unwrap();
assert_eq!(primal.real(), 5.0);
assert!(!primal.tracks_grad());

pub fn enable_grad(self) -> Result<Self>

Enables gradient tracking for this scalar.

Returns

A new scalar that shares the same value but participates in autodiff.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_real(2.0).enable_grad().unwrap();
assert!(scalar.tracks_grad());

pub fn tracks_grad(&self) -> bool

Returns whether this scalar tracks gradients.

Returns

true when the scalar participates in autodiff and can accumulate a gradient, otherwise false.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_real(1.0);
assert!(!scalar.tracks_grad());

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

Returns the stored gradient, if any.

Returns

Ok(Some(_)) when a gradient is available, Ok(None) when no gradient has been recorded, or an error if the backend cannot read it.

Errors

Propagates autodiff or tensor access failures from the underlying tensor runtime.

Examples

use tensor4all_core::AnyScalar;

let x = AnyScalar::new_real(2.0).enable_grad().unwrap();
let y = &x * &x;
y.backward().unwrap();

let grad = x.grad().unwrap().unwrap();
assert_eq!(grad.real(), 4.0);

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

Clears the stored gradient for this scalar.

Returns

Ok(()) when the gradient buffer was cleared successfully.

Errors

Propagates tensor runtime failures from the underlying autodiff state.

Examples

use tensor4all_core::AnyScalar;

let x = AnyScalar::new_real(2.0).enable_grad().unwrap();
let y = &x * &x;
y.backward().unwrap();
assert!(x.grad().unwrap().is_some());

x.clear_grad().unwrap();
assert!(x.grad().unwrap().is_none());

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

Runs reverse-mode autodiff starting from this scalar.

Returns

Ok(()) when gradients were accumulated successfully.

Errors

Propagates failures from the underlying tensor autodiff engine.

Examples

use tensor4all_core::AnyScalar;

let x = AnyScalar::new_real(2.0).enable_grad().unwrap();
let y = &x * &x;
y.backward().unwrap();

let grad = x.grad().unwrap().unwrap();
assert_eq!(grad.real(), 4.0);

pub fn detach(&self) -> Result<Self>

Returns a detached copy of this scalar.

Returns

A scalar with the same value but without gradient tracking.

Examples

use tensor4all_core::AnyScalar;

let detached = AnyScalar::new_real(7.0)
    .enable_grad()
    .unwrap()
    .detach()
    .unwrap();
assert_eq!(detached.real(), 7.0);
assert!(!detached.tracks_grad());

pub fn real(&self) -> f64

Returns the real part of this scalar.

Returns

The real component as an f64, regardless of the underlying storage type.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0);
assert_eq!(scalar.real(), 3.0);

pub fn imag(&self) -> f64

Returns the imaginary part of this scalar.

Returns

The imaginary component as an f64. Real-valued scalars return 0.0.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0);
assert_eq!(scalar.imag(), -4.0);

pub fn abs(&self) -> f64

Returns the magnitude of this scalar.

Returns

The absolute value for real scalars or the complex norm for complex scalars.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0);
assert_eq!(scalar.abs(), 5.0);

pub fn is_complex(&self) -> bool

Returns whether this scalar is complex-valued.

Returns

true for complex dtypes and false for real or integer dtypes.

Examples

use tensor4all_core::AnyScalar;

assert!(AnyScalar::new_complex(1.0, 2.0).is_complex());
assert!(!AnyScalar::new_real(1.0).is_complex());

pub fn is_real(&self) -> bool

Returns whether this scalar is real-valued.

Returns

true when the scalar is not complex-valued.

Examples

use tensor4all_core::AnyScalar;

assert!(AnyScalar::new_real(1.0).is_real());
assert!(!AnyScalar::new_complex(1.0, 2.0).is_real());

pub fn is_zero(&self) -> bool

Returns whether this scalar is exactly zero.

Returns

true for exact zeros and false for any nonzero value.

Examples

use tensor4all_core::AnyScalar;

assert!(AnyScalar::new_real(0.0).is_zero());
assert!(!AnyScalar::new_complex(0.0, 1.0).is_zero());

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

Returns this scalar as an f64 when it is real-valued.

Returns

Some(value) for real and integer scalars, or None for complex scalars.

Examples

use tensor4all_core::AnyScalar;

assert_eq!(AnyScalar::new_real(2.5).as_f64(), Some(2.5));
assert_eq!(AnyScalar::new_complex(2.5, 1.0).as_f64(), None);

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

Returns this scalar as a Complex64 when it is complex-valued.

Returns

Some(value) for complex scalars or None for real and integer scalars.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(2.5, 1.0);
assert_eq!(scalar.as_c64().map(|z| (z.re, z.im)), Some((2.5, 1.0)));
assert_eq!(AnyScalar::new_real(2.5).as_c64(), None);

pub fn try_conj(&self) -> Result<Self>

Returns the complex conjugate of this scalar.

Returns

The conjugated scalar. Real-valued inputs are returned unchanged.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0).conj();
assert_eq!(scalar.as_c64().map(|z| (z.re, z.im)), Some((3.0, 4.0)));

pub fn conj(&self) -> Self

Returns the complex conjugate of this scalar.

pub fn real_part(&self) -> Self

Returns the real part as a real-valued scalar.

Returns

A real-valued scalar containing the real component of self.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0).real_part();
assert_eq!(scalar.real(), 3.0);
assert!(scalar.is_real());

pub fn imag_part(&self) -> Self

Returns the imaginary part as a real-valued scalar.

Returns

A real-valued scalar containing the imaginary component of self.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_complex(3.0, -4.0).imag_part();
assert_eq!(scalar.real(), -4.0);
assert!(scalar.is_real());

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

Combines two real-valued scalars into a complex scalar.

Arguments

• real - The real component.
• imag - The imaginary component.

Returns

A complex AnyScalar whose real and imaginary parts come from the inputs.

Errors

Returns an error if either input is not real-valued.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::compose_complex(
    AnyScalar::new_real(3.0),
    AnyScalar::new_real(-4.0),
)
.unwrap();
assert_eq!(scalar.as_c64().map(|z| (z.re, z.im)), Some((3.0, -4.0)));

pub fn sqrt(&self) -> Self

Returns the square root of this scalar.

Returns

The principal square root. Negative real inputs and complex inputs use complex arithmetic.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_real(9.0).sqrt();
assert_eq!(scalar.real(), 3.0);
assert!(scalar.is_real());

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

Raises this scalar to a floating-point power.

Arguments

• exponent - The exponent to apply.

Returns

The value of self^exponent.

Examples

use tensor4all_core::AnyScalar;

let scalar = AnyScalar::new_real(2.0).powf(3.0);
assert_eq!(scalar.real(), 8.0);

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

Raises this scalar to an integer power.

Arguments

• exponent - The integer exponent to apply. Negative exponents return the reciprocal power.

Returns

The value of self^exponent. Zero exponents return 1.

Examples

use tensor4all_core::AnyScalar;

assert_eq!(AnyScalar::new_real(2.0).powi(3).real(), 8.0);
assert_eq!(AnyScalar::new_real(2.0).powi(-1).real(), 0.5);

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.