Struct ParameterMap 

pub struct ParameterMap { /* private fields */ }

An ordered set of Parameters.

Implementations

impl ParameterMap

pub fn register_parameter(&mut self, p: &Parameter) -> LadduResult<ParameterID>

Register a parameter into the ordered map and return its assembled ParameterID.

pub fn free_parameter_indices(&self) -> Vec<usize>

Return the assembled indices of all free parameters.

pub fn rename_parameter(&mut self, old: &str, new: &str) -> LadduResult<()>

Rename a single parameter in place.

pub fn rename_parameters( &mut self, mapping: &HashMap<String, String>, ) -> LadduResult<()>

Rename multiple parameters in place.

pub fn fix_parameter(&self, name: &str, value: f64) -> LadduResult<()>

Fix a parameter to the supplied value.

pub fn free_parameter(&self, name: &str) -> LadduResult<()>

Mark a parameter as free.

pub fn contains_key(&self, name: &str) -> bool

Return whether a parameter with the given name exists.

pub fn index(&self, name: &str) -> Option<usize>

Return the storage index for a named parameter.

pub fn insert(&mut self, parameter: Parameter) -> Option<Parameter>

Insert or replace a parameter by name while preserving insertion order.

pub fn len(&self) -> usize

The number of parameters in the set.

pub fn is_empty(&self) -> bool

Returns true if the parameter set has no elements.

pub fn iter(&self) -> Iter<'_, Parameter>

Iterate over all parameters in the set.

pub fn get(&self, key: &str) -> Option<&Parameter>

Get a parameter by name.

pub fn get_indexed(&self, key: &str) -> Option<(usize, &Parameter)>

Get both the storage index and parameter for a given name.

pub fn names(&self) -> Vec<String>

Get all parameter names in order.

pub fn filter(&self, predicate: impl Fn(&Parameter) -> bool) -> Self

Filter the parameter set by a predicate.

pub fn free(&self) -> Self

Get a set containing only free parameters.

pub fn fixed(&self) -> Self

Get a set containing only fixed parameters.

pub fn initialized(&self) -> Self

Get a set containing only initialized parameters.

pub fn uninitialized(&self) -> Self

Get a set containing only uninitialized parameters.

pub fn assemble(&self, free_values: &[f64]) -> LadduResult<Parameters>

Assemble free inputs into a full Parameters object.

The resulting values are ordered with all free parameters first, followed by fixed ones.

pub fn merge(&self, other: &Self) -> (Self, Vec<usize>, Vec<usize>)

Merge two parameter maps.

When parameters overlap, the state and value stored in self always take precedence over entries from other.

pub fn extend_from(&self, other: &Self) -> (Self, Vec<usize>)

Extend a parameter map from another one.

When both managers reference the same parameter, the value and fixed/free status from self are retained.

Trait Implementations

impl Clone for ParameterMap

fn clone(&self) -> ParameterMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterMap

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

Formats the value using the given formatter.

impl Default for ParameterMap

fn default() -> ParameterMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParameterMap

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ParameterMap

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

Formats the value using the given formatter.

impl Index<&str> for ParameterMap

type Output = Parameter

The returned type after indexing.

fn index(&self, key: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for ParameterMap

type Output = Parameter

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a ParameterMap

type Item = &'a Parameter

The type of the elements being iterated over.

type IntoIter = Iter<'a, Parameter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ParameterMap

type Item = Parameter

The type of the elements being iterated over.

type IntoIter = IntoIter<Parameter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for ParameterMap

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.