Struct Assignment 

pub struct Assignment(/* private fields */);

The parameters of one trial: names to typed values.

Backed by a BTreeMap, so iteration is sorted by parameter name — not a style preference but a determinism requirement: a sampler that walks an assignment, a journal that serializes one, and a hash computed over one must all see the same order on every machine and every run.

use atune_core::space::{Assignment, ParamValue};

let mut params = Assignment::new();
params.insert("lr", ParamValue::F64(0.01));
params.insert("batch", ParamValue::I64(64));
params.insert("amp", ParamValue::Bool(true));

let names: Vec<_> = params.iter().map(|(name, _)| name.as_str()).collect();
assert_eq!(names, ["amp", "batch", "lr"]); // sorted, always
assert_eq!(params.get("lr"), Some(&ParamValue::F64(0.01)));

Implementations

impl Assignment

pub fn new() -> Self

An empty assignment.

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

The value bound to name, if any.

pub fn insert( &mut self, name: impl Into<String>, value: ParamValue, ) -> Option<ParamValue>

Binds name to value, returning the previous binding if there was one.

pub fn remove(&mut self, name: &str) -> Option<ParamValue>

Removes name, returning its value if it was bound.

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

true if name is bound.

pub fn len(&self) -> usize

The number of bound parameters.

pub fn is_empty(&self) -> bool

true if nothing is bound.

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

Iterates over (name, value) pairs, sorted by name.

pub fn names(&self) -> Keys<'_, String, ParamValue>

Iterates over the names, sorted.

pub fn values(&self) -> Values<'_, String, ParamValue>

Iterates over the values, in name order.

pub fn merge_from(&mut self, other: &Self)

Inserts every binding of other, overwriting on conflict.

Trait Implementations

impl Clone for Assignment

fn clone(&self) -> Assignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Assignment

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

Formats the value using the given formatter.

impl Default for Assignment

fn default() -> Assignment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Assignment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K> FromIterator<(K, ParamValue)> for Assignment

where K: Into<String>,

fn from_iter<I: IntoIterator<Item = (K, ParamValue)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Assignment

type Item = (&'a String, &'a ParamValue)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, ParamValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Assignment

type Item = (String, ParamValue)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, ParamValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Assignment

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Assignment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Assignment