Struct CategoricalParameter 

pub struct CategoricalParameter {
    pub name: String,
    pub values: Vec<ParameterValue>,
    pub ordered: bool,
    pub default: Option<ParameterValue>,
    pub description: Option<String>,
}

Categorical parameter definition with enhanced features

Fields

name: String

Name of the parameter

values: Vec<ParameterValue>

Possible values

ordered: bool

Whether the categories have an ordering

default: Option<ParameterValue>

Default value if any

description: Option<String>

Description of the parameter

Implementations

impl CategoricalParameter

pub fn new(name: String, values: Vec<ParameterValue>) -> Self

Create a new categorical parameter

pub fn ordered(name: String, values: Vec<ParameterValue>) -> Self

Create an ordered categorical parameter

pub fn with_default(self, default: ParameterValue) -> Self

Set default value

pub fn with_description(self, description: String) -> Self

Set description

pub fn sample(&self, rng: &mut impl Rng) -> ParameterValue

Sample a random value from this parameter

pub fn get_index(&self, value: &ParameterValue) -> Option<usize>

Get the index of a value (useful for ordered categories)

pub fn get_neighbors(&self, value: &ParameterValue) -> Vec<ParameterValue>

Get neighboring values for ordered categories

Trait Implementations

impl Clone for CategoricalParameter

fn clone(&self) -> CategoricalParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CategoricalParameter

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

Formats the value using the given formatter.