Struct Adjoints 

pub struct Adjoints { /* private fields */ }

The recorded reverse-mode result: one gradient symbol per wrt entry, in wrt order, paired with the entry it differentiates.

Tape::differentiate and Tape::vjp return this carrier instead of bare symbols because their product exists to be paired — each gradient with its wrt entry for Run::recorded_gradients, and all of them with the target for a training request’s roots. Holding the pairs makes misordered pairs unrepresentable: no consumer rebuilds the pairing by parallel-vector discipline.

The carrier is plain data — detached symbols, no tape borrow — so it survives sealing the tape and crosses threads like any Symbol.

Implementations

impl Adjoints

pub fn target(&self) -> Symbol

Returns the differentiated value: the scalar loss for Tape::differentiate, the seeded value — any shape — for Tape::vjp.

pub fn pairs(&self) -> &[(Symbol, Symbol)]

Returns the (wrt, gradient) pairs in wrt order.

pub fn wrt(&self) -> impl Iterator<Item = Symbol> + '_

Returns the wrt entries in their original order.

pub fn gradients(&self) -> impl Iterator<Item = Symbol> + '_

Returns the gradient symbols in wrt order.

pub fn of(&self, wrt: Symbol) -> Symbol

Returns the gradient recorded for wrt.

Panics

Panics if wrt was not an entry of the transform that produced this carrier.

pub fn roots(&self) -> impl Iterator<Item = Symbol> + '_

Returns the training roots: the target, then every gradient in wrt order — the exact root list a compiled training plan wants, so Entry::roots(adjoints.roots()) replaces the hand-chained loss-plus-gradients idiom.

pub fn map_gradients(&self, rewrite: impl FnMut(Symbol) -> Symbol) -> Self

Returns a new carrier with each gradient symbol rewritten by rewrite, pairing and target preserved.

The emission consumers use this to substitute same-shape reshape aliases for the raw gradient nodes — pinning the emitted result order — without ever holding gradients as a bare list.

impl Adjoints

pub fn to_html(&self, theme: Theme) -> String

Renders the pairing as a self-contained HTML card: the target, then each wrt → gradient pair in wrt order.

pub fn evcxr_display(&self)

Displays the adjoints when they are the last expression in an Evcxr cell.

Trait Implementations

impl Clone for Adjoints

fn clone(&self) -> Adjoints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Adjoints

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

Formats the value using the given formatter.

impl Detach for Adjoints

Identity: a differentiation product is already detached names.

type Detached = Adjoints

The detached form of these names.

fn detach(self) -> Adjoints

Detaches the names.