Struct EnumParam 

pub struct EnumParam<T: Categorical> { /* private fields */ }

A parameter that selects from the variants of an enum implementing Categorical.

Prefer this over CategoricalParam when the choices map to a Rust enum, because the returned value is already the correct variant — no string matching required.

Examples

use optimizer::Trial;
use optimizer::parameter::{Categorical, EnumParam, Parameter};

#[derive(Clone, Debug)]
enum Optimizer {
    Sgd,
    Adam,
    Rmsprop,
}

impl Categorical for Optimizer {
    const N_CHOICES: usize = 3;
    fn from_index(index: usize) -> Self {
        match index {
            0 => Optimizer::Sgd,
            1 => Optimizer::Adam,
            2 => Optimizer::Rmsprop,
            _ => panic!("invalid index"),
        }
    }
    fn to_index(&self) -> usize {
        match self {
            Optimizer::Sgd => 0,
            Optimizer::Adam => 1,
            Optimizer::Rmsprop => 2,
        }
    }
}

let mut trial = Trial::new(0);
let opt = EnumParam::<Optimizer>::new()
    .name("optimizer")
    .suggest(&mut trial)
    .unwrap();

Implementations

impl<T: Categorical> EnumParam<T>

pub fn new() -> Self

Create a new enum parameter over all variants of T.

pub fn name(self, name: impl Into<String>) -> Self

Set a human-readable name for this parameter.

When set, this name is used as the parameter’s label instead of the default Debug output.

Trait Implementations

impl<T: Clone + Categorical> Clone for EnumParam<T>

fn clone(&self) -> EnumParam<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Categorical> Debug for EnumParam<T>

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

Formats the value using the given formatter.

impl<T: Categorical> Default for EnumParam<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Categorical + Debug> Parameter for EnumParam<T>

type Value = T

The typed value returned after sampling.

fn id(&self) -> ParamId

Return the unique identifier for this parameter.

fn distribution(&self) -> Distribution

Return the distribution that this parameter samples from.

fn cast_param_value(&self, param_value: &ParamValue) -> Result<T>

Convert a raw ParamValue into the typed value.

fn label(&self) -> String

Return a human-readable label for this parameter.

fn validate(&self) -> Result<()>

Validate the parameter configuration.

fn suggest(&self, trial: &mut Trial) -> Result<Self::Value>

where Self: Sized,

Suggest a value for this parameter from the given trial.