Struct ParameterVector 

pub struct ParameterVector {
    pub values: Vec<f64>,
    pub names: Vec<String>,
}

A named parameter vector.

Fields

values: Vec<f64>

Parameter values.

names: Vec<String>

Parameter names (parallel to values).

Implementations

impl ParameterVector

pub fn new(names: Vec<String>, values: Vec<f64>) -> Self

Construct a new ParameterVector.

If names and values lengths differ the shorter one determines the logical length; the remainder is ignored.

pub fn get(&self, name: &str) -> Option<f64>

Return the value of the parameter with the given name, if present.

pub fn set(&mut self, name: &str, value: f64) -> bool

Set the value of the parameter with the given name.

Returns true if the name was found and updated, false otherwise.

pub fn l2_norm(&self) -> f64

Compute the L2 (Euclidean) norm of the value vector.

pub fn len(&self) -> usize

Number of parameters.

pub fn is_empty(&self) -> bool

Return true when there are no parameters.

pub fn iter(&self) -> impl Iterator<Item = (&str, f64)>

Iterate over (name, value) pairs.

Trait Implementations

impl Clone for ParameterVector

fn clone(&self) -> ParameterVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterVector

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

Formats the value using the given formatter.

impl PartialEq for ParameterVector

fn eq(&self, other: &ParameterVector) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParameterVector