Struct argmin::core::KV

pub struct KV {
    pub kv: Vec<(&'static str, Rc<dyn Display>)>,
}

A simple key-value storage

Keeps pairs of (&'static str, Rc<dyn Display>) and is used to pass key-value pairs to Observers in each iteration of an optimization algorithm. Typically constructed using the make_kv! macro.

Example

use argmin::make_kv;

let kv = make_kv!(
    "key1" => "value1";
    "key2" => "value2";
    "key3" => 1234;
);

Fields

kv: Vec<(&'static str, Rc<dyn Display>)>

The actual key value storage

Implementations

impl KV

pub fn new() -> Self

Constructor a new empty KV

Example

let kv = KV::new();

pub fn push(&mut self, key: &'static str, val: Rc<dyn Display>) -> &mut Self

Push a key-value pair

Example

let mut kv = KV::new();
kv.push("key", Rc::new("value"));
kv.push("key", Rc::new(1234));

pub fn merge(self, other: KV) -> Self

Merge with another KV

Example

let mut kv1 = KV::new();
kv1.push("key1", Rc::new("value1"));

let mut kv2 = KV::new();
kv2.push("key2", Rc::new("value2"));

let kv1 = kv1.merge(kv2);

Trait Implementations

impl Clone for KV

fn clone(&self) -> KV

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KV

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

Formats the value using the given formatter.

impl Default for KV

fn default() -> KV

Returns the “default value” for a type.

impl Display for KV

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

Formats the value using the given formatter.

impl Extend<(&'static str, Rc<dyn Display + 'static>)> for KV

fn extend<I: IntoIterator<Item = (&'static str, Rc<dyn Display>)>>(
    &mut self,
    iter: I
)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<(&'static str, Rc<dyn Display + 'static>)> for KV

fn from_iter<I: IntoIterator<Item = (&'static str, Rc<dyn Display>)>>(
    iter: I
) -> Self

Creates a value from an iterator.

impl KV for KV

fn serialize(
    &self,
    _record: &Record<'_>,
    serializer: &mut dyn Serializer
) -> Result

Serialize self into Serializer