Struct Choice 

pub struct Choice<'choices> { /* private fields */ }

The set of hyperparameter choices OnlineTuner::suggest produced this round — one value per cluster, borrowed from the tuner (no allocation).

Read a value by cluster name with get or by declaration index with value_at. The borrow is released as soon as the choices are copied out, which is why the loop pattern extracts the f64s it needs before calling observe.

Implementations

impl<'choices> Choice<'choices>

pub fn value_at(&self, index: usize) -> Option<f64>

The chosen value of the cluster at declaration index, if it exists.

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

The chosen value of the cluster named name, if there is one.

pub fn len(&self) -> usize

The number of clusters (choices).

pub fn is_empty(&self) -> bool

true if there are no clusters (never, for a built tuner).

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

Iterates (cluster name, chosen value) in declaration order.

Trait Implementations

impl<'choices> Clone for Choice<'choices>

fn clone(&self) -> Choice<'choices>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'choices> Copy for Choice<'choices>

impl<'choices> Debug for Choice<'choices>

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

Formats the value using the given formatter.

impl<'choices> IntoIterator for &Choice<'choices>

fn into_iter(self) -> Self::IntoIter

Iterates (cluster name, chosen value) in declaration order, as Choice::iter.

type Item = (&'choices str, f64)

The type of the elements being iterated over.

type IntoIter = Zip<Map<Iter<'choices, String>, fn(&'choices String) -> &'choices str>, Copied<Iter<'choices, f64>>>

Which kind of iterator are we turning this into?