Struct TrackedTensor 

pub struct TrackedTensor<V: Differentiable> { /* private fields */ }

Value wrapper for reverse-mode AD.

Wraps any Differentiable value and connects it to a Tape for gradient computation.

Created via Tape::leaf for gradient-tracked values, or TrackedTensor::new for values that do not require gradients.

Examples

use chainrules::{Tape, TrackedTensor};
use tenferro_tensor::{MemoryOrder, Tensor};
use tenferro_device::LogicalMemorySpace;

let tape = Tape::<Tensor<f64>>::new();
let a = tape.leaf(Tensor::ones(
    &[2, 3],
    LogicalMemorySpace::MainMemory,
    MemoryOrder::ColumnMajor,
));
assert!(a.requires_grad());

Implementations

impl<V: Differentiable> TrackedTensor<V>

pub fn new(value: V) -> Self

Creates a tracked value with requires_grad = false (no tape).

Examples

use chainrules::TrackedTensor;
let x = TrackedTensor::new(value);
assert!(!x.requires_grad());

pub fn value(&self) -> &V

Returns the underlying value.

Examples

let v = tracked.value();

pub fn into_value(self) -> V

Consumes and returns the underlying value.

Examples

let raw = tracked.into_value();

pub fn requires_grad(&self) -> bool

Returns whether this value participates in gradient propagation.

Examples

assert!(tracked.requires_grad());

pub fn node_id(&self) -> Option<NodeId>

Returns the graph node ID when this value is connected to a tape.

Examples

if let Some(id) = tracked.node_id() {
    println!("node = {}", id.index());
}

pub fn tangent(&self) -> Option<&V::Tangent>

Returns the tangent for HVP, or None if not set.

Examples

if let Some(t) = tracked.tangent() {
    // use tangent
}

pub fn has_tangent(&self) -> bool

Returns whether this tracked value has a tangent for HVP.

Examples

assert!(tracked.has_tangent());

pub fn detach(self) -> Self

Consumes and returns a detached value that does not require gradients.

Examples

let detached = tracked.detach();
assert!(!detached.requires_grad());