Struct StateSource 

pub struct StateSource { /* private fields */ }

Provides the named tensors and scalars consumed while reconstructing an RecordState.

Tensors are taken (removed) by name so the same source can feed several parameters in turn; scalars are looked up by name and left in place.

Implementations

impl StateSource

pub fn new(scalars: BTreeMap<String, Scalar>) -> Self

Create a source from an existing scalar map (e.g. the burnpack scalars).

pub fn insert_tensor(&mut self, name: String, data: TensorData)

Register a tensor under its full name.

pub fn take_tensor(&mut self, prefix: &str, leaf: &str) -> Option<TensorData>

Take the tensor named {prefix}.{leaf}, if present.

pub fn take_scalar(&mut self, prefix: &str, leaf: &str) -> Option<Scalar>

Read the scalar named {prefix}.{leaf}, if present.

pub fn has_under(&self, prefix: &str) -> bool

Whether any tensor or scalar leaf was recorded under prefix (a key beginning with "{prefix}.").

Used by the derive to tell an absent optional nested state (nothing recorded) apart from a present one whose leaves all happen to be optional.

Trait Implementations

impl Debug for StateSource

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

Formats the value using the given formatter.

impl Default for StateSource

fn default() -> StateSource

Returns the “default value” for a type.