Struct VariableEnvironment 

pub struct VariableEnvironment<F> { /* private fields */ }

Manages variable arrays

See variable.

Implementations

impl VariableEnvironment<f32>

pub fn load<P: AsRef<Path>>( path: P, ) -> Result<VariableEnvironment<f32>, Box<dyn Error>>

Creates a new VariableEnvironment using the one that was previously persisted.

Returns the result of the execution.

pub fn initialize<P: AsRef<Path>>( &mut self, path: P, ) -> Result<(), Box<dyn Error>>

Initialize this instance with the one that was previously persisted.

impl VariableEnvironment<f64>

pub fn load<P: AsRef<Path>>( path: P, ) -> Result<VariableEnvironment<f64>, Box<dyn Error>>

Creates a new VariableEnvironment using the one that was previously persisted.

Returns the result of the execution.

pub fn initialize<P: AsRef<Path>>( &mut self, path: P, ) -> Result<(), Box<dyn Error>>

Initialize this instance with the one that was previously persisted.

impl<F: Float> VariableEnvironment<F>

pub fn new() -> VariableEnvironment<F>

impl<'env, F: Float> VariableEnvironment<F>

pub fn iter(&self) -> impl Iterator<Item = (VariableID, &RefCell<NdArray<F>>)>

Returns an iterator of the variable arrays and their ids in this env.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn Error>>

Saves the current VariableEnvironment to storage.

Returns the result of the execution.

pub fn slot(&'env mut self) -> DefaultVariableSlot<'env, F>

Makes a temporary slot for registering a variable array in the default namespace.

pub fn set<D: Dimension>(&'env mut self, v: Array<F, D>) -> VariableID

Registers the given array with the default namespace.

pub fn name<S: Into<String>>( &'env mut self, name: S, ) -> NamedDefaultVariableSlot<'env, F, S>

Prepares a slot for the default namespace to register a variable array

pub fn namespace( &'env self, namespaceid: &'static str, ) -> VariableNamespace<'env, F>

Get or create a namespace with specified id.

See variable. Same as Context::namespace.

pub fn namespace_mut( &'env mut self, namespace_id: &'static str, ) -> VariableNamespaceMut<'env, F>

Get or create a mutable namespace with specified name.

Return value is used for variable registration. See variable.

pub fn default_namespace(&'env self) -> VariableNamespace<'env, F>

Get or create the default namespace.

See variable. Same as Context::default_namespace.

pub fn default_namespace_mut(&'env mut self) -> VariableNamespaceMut<'env, F>

Get or create a mutable default namespace.

Return value is used for variable registration.

pub fn get_array_by_id(&self, vid: VariableID) -> Option<&RefCell<NdArray<F>>>

Returns a reference to the variable array with the specified id.

VariableID is returned by the *Slot::set.

pub fn run<FN, R>(&'env self, f: FN) -> R

where FN: FnOnce(&mut Context<'env, F>) -> R,

Creates a computation graph associated with this VariableEnvironment.

See variable.

Trait Implementations

impl<F: Clone> Clone for VariableEnvironment<F>

fn clone(&self) -> VariableEnvironment<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Float> Default for VariableEnvironment<F>

fn default() -> Self

Returns the “default value” for a type.