Struct NamedJet1Vec 

pub struct NamedJet1Vec<T: Passive = f64> { /* private fields */ }

Labeled wrapper around the positional Jet1Vec type.

Example

The constructor API for NamedJet1Vec is owned by NamedForwardTape via the declare_jet1vec / into_scope / scope.jet1vec(handle) pattern. See the module docs in src/forward_tape.rs for the full rationale.

use xad_rs::{NamedForwardTape, NamedForwardScope};

let mut ft = NamedForwardTape::new();
let x_h = ft.declare_jet1vec("x", 2.0);
let y_h = ft.declare_jet1vec("y", 3.0);
let scope: NamedForwardScope = ft.into_scope();

let x = scope.jet1vec(x_h);
let y = scope.jet1vec(y_h);
let f = x * y + x - 2.0 * y;

assert_eq!(f.real(), 2.0);
assert_eq!(f.partial("x"), 4.0);
assert_eq!(f.partial("y"), 0.0);

Implementations

impl<T: Passive> NamedJet1Vec<T>

pub fn real(&self) -> T

Value part.

pub fn partial(&self, name: &str) -> T

Partial derivative with respect to a named variable.

Reads the active registry from the NamedForwardTape thread-local slot (stamped at freeze() time). Returns 0.0 if name is in the registry but not touched by this value (same as positional Jet1Vec::partial on an unused slot). Panics if name is not in the registry, or if called outside a frozen NamedForwardTape scope.

pub fn gradient(&self) -> Vec<(String, T)>

Full gradient as a Vec<(name, partial)>.

Iteration order matches the active registry’s insertion order — deterministic. Reads the active registry from the thread-local slot. Panics if called outside a frozen NamedForwardTape scope.

pub fn inner(&self) -> &Jet1Vec<T>

Escape hatch: direct access to the inner positional Jet1Vec.

pub fn exp(&self) -> Self

Natural exponential, preserving the parent scope’s generation.

pub fn ln(&self) -> Self

Natural logarithm, preserving the parent scope’s generation.

pub fn sqrt(&self) -> Self

Square root, preserving the parent scope’s generation.

pub fn sin(&self) -> Self

Sine, preserving the parent scope’s generation.

pub fn cos(&self) -> Self

Cosine, preserving the parent scope’s generation.

pub fn tan(&self) -> Self

Tangent, preserving the parent scope’s generation.

pub fn norm_cdf(&self) -> Self

Standard normal CDF, preserving the parent scope’s generation.

pub fn inv_norm_cdf(&self) -> Self

Inverse standard normal CDF, preserving the parent scope’s generation.

pub fn powf(&self, n: T) -> Self

self^n with scalar exponent, preserving the parent scope’s generation.

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

self^n with integer exponent, preserving the parent scope’s generation.

Trait Implementations

impl<T: Passive> Add<&NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the + operation.

impl<T: Passive> Add<&NamedJet1Vec<T>> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the + operation.

impl Add<&NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the + operator.

fn add(self, rhs: &NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the + operation.

impl Add<&NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the + operator.

fn add(self, rhs: &NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the + operation.

impl<T: Passive> Add<NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the + operation.

impl Add<NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the + operator.

fn add(self, rhs: NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the + operation.

impl Add<NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the + operator.

fn add(self, rhs: NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the + operation.

impl<T: Passive> Add<T> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> NamedJet1Vec<T>

Performs the + operation.

impl<T: Passive> Add<T> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> NamedJet1Vec<T>

Performs the + operation.

impl<T: Passive> Add for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the + operator.

fn add(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the + operation.

impl<T: Passive> AddAssign<&NamedJet1Vec<T>> for NamedJet1Vec<T>

fn add_assign(&mut self, rhs: &NamedJet1Vec<T>)

Performs the += operation.

impl<T: Passive> AddAssign for NamedJet1Vec<T>

fn add_assign(&mut self, rhs: NamedJet1Vec<T>)

Performs the += operation.

impl<T: Clone + Passive> Clone for NamedJet1Vec<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Passive> Debug for NamedJet1Vec<T>

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

Formats the value using the given formatter.

impl<T: Passive> Display for NamedJet1Vec<T>

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

Formats the value using the given formatter.

impl<T: Passive> Div<&NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the / operation.

impl<T: Passive> Div<&NamedJet1Vec<T>> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the / operation.

impl Div<&NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the / operator.

fn div(self, rhs: &NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the / operation.

impl Div<&NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the / operator.

fn div(self, rhs: &NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the / operation.

impl<T: Passive> Div<NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the / operation.

impl Div<NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the / operator.

fn div(self, rhs: NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the / operation.

impl Div<NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the / operator.

fn div(self, rhs: NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the / operation.

impl<T: Passive> Div<T> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> NamedJet1Vec<T>

Performs the / operation.

impl<T: Passive> Div<T> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> NamedJet1Vec<T>

Performs the / operation.

impl<T: Passive> Div for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the / operator.

fn div(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the / operation.

impl<T: Passive> Mul<&NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the * operation.

impl<T: Passive> Mul<&NamedJet1Vec<T>> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the * operation.

impl Mul<&NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: &NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the * operation.

impl Mul<&NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the * operator.

fn mul(self, rhs: &NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the * operation.

impl<T: Passive> Mul<NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the * operation.

impl Mul<NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the * operation.

impl Mul<NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the * operator.

fn mul(self, rhs: NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the * operation.

impl<T: Passive> Mul<T> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> NamedJet1Vec<T>

Performs the * operation.

impl<T: Passive> Mul<T> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> NamedJet1Vec<T>

Performs the * operation.

impl<T: Passive> Mul for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the * operation.

impl<T: Passive> Neg for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn neg(self) -> NamedJet1Vec<T>

Performs the unary - operation.

impl<T: Passive> Neg for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn neg(self) -> NamedJet1Vec<T>

Performs the unary - operation.

impl<T: Passive> Sub<&NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the - operation.

impl<T: Passive> Sub<&NamedJet1Vec<T>> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the - operation.

impl Sub<&NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the - operator.

fn sub(self, rhs: &NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the - operation.

impl Sub<&NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the - operator.

fn sub(self, rhs: &NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the - operation.

impl<T: Passive> Sub<NamedJet1Vec<T>> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the - operation.

impl Sub<NamedJet1Vec<f32>> for f32

type Output = NamedJet1Vec<f32>

The resulting type after applying the - operator.

fn sub(self, rhs: NamedJet1Vec<f32>) -> NamedJet1Vec<f32>

Performs the - operation.

impl Sub<NamedJet1Vec> for f64

type Output = NamedJet1Vec

The resulting type after applying the - operator.

fn sub(self, rhs: NamedJet1Vec<f64>) -> NamedJet1Vec<f64>

Performs the - operation.

impl<T: Passive> Sub<T> for &NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> NamedJet1Vec<T>

Performs the - operation.

impl<T: Passive> Sub<T> for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> NamedJet1Vec<T>

Performs the - operation.

impl<T: Passive> Sub for NamedJet1Vec<T>

type Output = NamedJet1Vec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: NamedJet1Vec<T>) -> NamedJet1Vec<T>

Performs the - operation.