Struct Visit 

pub struct Visit<'a> { /* private fields */ }

The read-only visitor that Leaves::visit reports to: it builds paths and dispatches leaves, child trees, enum variants, mode flags and static fields to a Visitor.

Implementations

impl<'a> Visit<'a>

pub fn new(visitor: &'a mut dyn Visitor) -> Visit<'a>

A visit reporting to visitor, starting at the root (empty path).

pub fn path(&self) -> &str

The current path.

pub fn array(&mut self, name: &str, a: &Array)

A plain array leaf (always differentiable).

pub fn param(&mut self, name: &str, p: &Param)

A parameter leaf (trainable unless frozen).

pub fn buffer(&mut self, name: &str, a: &(impl BufferLeaf + ?Sized))

A buffer leaf (never trainable): an Array, or an Option<Array> that is a leaf when present.

pub fn child<T>(&mut self, name: &str, t: &T)

where T: Leaves + ?Sized,

A child tree named name (empty: transparent).

pub fn variant(&mut self, index: u32)

The active variant of an enum (its index), part of the structure.

pub fn mode(&mut self, training: bool)

A mode flag (true in training mode), part of the structure.

pub fn static_field(&mut self, name: &str, value: &(dyn Static + 'static))

A static field, hashed into the structure.