Struct AdScalar 

pub struct AdScalar<T>(pub AdValue<T>);

Scalar newtype carrying AD mode information.

Examples

use ad_tensors_rs::{AdMode, AdScalar};

let x: AdScalar<f64> = 2.0_f64.into();
assert_eq!(x.mode(), AdMode::Primal);

Tuple Fields

0: AdValue<T>

Implementations

impl<T> AdScalar<T>

pub fn new_primal(value: T) -> Self

Creates a primal scalar.

Examples

use ad_tensors_rs::{AdMode, AdScalar};

let x = AdScalar::new_primal(1.5_f64);
assert_eq!(x.mode(), AdMode::Primal);

pub fn new_forward(primal: T, tangent: T) -> Self

Creates a forward-mode scalar.

Examples

use ad_tensors_rs::{AdMode, AdScalar};

let x = AdScalar::new_forward(2.0_f64, 1.0_f64);
assert_eq!(x.mode(), AdMode::Forward);

pub fn new_reverse( primal: T, node: NodeId, tape: TapeId, tangent: Option<T>, ) -> Self

Creates a reverse-mode scalar.

Examples

use ad_tensors_rs::{AdMode, AdScalar, NodeId, TapeId};

let x = AdScalar::new_reverse(2.0_f64, NodeId(1), TapeId(2), Some(0.4));
assert_eq!(x.mode(), AdMode::Reverse);

pub fn mode(&self) -> AdMode

Returns AD mode.

Examples

use ad_tensors_rs::{AdMode, AdScalar};

let x = AdScalar::new_primal(2.0_f64);
assert_eq!(x.mode(), AdMode::Primal);

pub fn as_value(&self) -> &AdValue<T>

Returns reference to underlying AdValue.

Examples

use ad_tensors_rs::{AdScalar, AdValue};

let x = AdScalar::new_primal(2.0_f64);
assert!(matches!(x.as_value(), AdValue::Primal(_)));

pub fn into_value(self) -> AdValue<T>

Consumes wrapper and returns the underlying AdValue.

Examples

use ad_tensors_rs::{AdScalar, AdValue};

let x = AdScalar::new_primal(2.0_f64).into_value();
assert!(matches!(x, AdValue::Primal(_)));

pub fn primal(&self) -> &T

Returns primal scalar reference.

Examples

use ad_tensors_rs::AdScalar;

let x = AdScalar::new_forward(2.0_f64, 1.0_f64);
assert_eq!(x.primal(), &2.0);

pub fn tangent(&self) -> Option<&T>

Returns tangent scalar reference when available.

Examples

use ad_tensors_rs::AdScalar;

let x = AdScalar::new_forward(2.0_f64, 1.0_f64);
assert_eq!(x.tangent(), Some(&1.0));

Trait Implementations

impl<T: Clone> Clone for AdScalar<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AdScalar<T>

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

Formats the value using the given formatter.

impl<T: Clone> Differentiable for AdScalar<T>

type Primal = T

Underlying primal payload type.

fn ad_value(&self) -> &AdValue<T>

Borrow as an AdValue.

impl<T> From<AdScalar<T>> for AdValue<T>

fn from(value: AdScalar<T>) -> Self

Converts to this type from the input type.

impl<T> From<AdValue<T>> for AdScalar<T>

fn from(value: AdValue<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for AdScalar<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for AdScalar<T>

fn eq(&self, other: &AdScalar<T>) -> 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<T> StructuralPartialEq for AdScalar<T>