Enum ParamRange 

#[non_exhaustive]
pub enum ParamRange {
    IntRange {
        start: i64,
        end: i64,
        step: i64,
    },
    FloatRange {
        start: f64,
        end: f64,
        step: f64,
    },
    Values(Vec<ParamValue>),
}

Defines the search space for a single strategy parameter.

Constructor	Compatible with	Typical use
int_range(start, end, step)	GridSearch + BayesianSearch	Integer period with explicit grid step
float_range(start, end, step)	GridSearch + BayesianSearch	Float multiplier with explicit grid step
int_bounds(start, end)	GridSearch (step=1) + BayesianSearch	Integer period, let Bayesian sample freely
float_bounds(start, end)	BayesianSearch only	Continuous float range
Values(vec)	GridSearch + BayesianSearch	Explicit list of values

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

IntRange

Inclusive integer range with a step size.

Fields

start: i64

First value to include

end: i64

Last value to include (inclusive)

step: i64

Increment between values

FloatRange

Inclusive float range with a step size.

Fields

start: f64

First value in the range

end: f64

Last value to include (inclusive)

step: f64

Increment between values

Values(Vec<ParamValue>)

Explicit list of values.

Implementations

impl ParamRange

pub fn int_range(start: i64, end: i64, step: i64) -> Self

Stepped integer range — compatible with both GridSearch and BayesianSearch.

pub fn float_range(start: f64, end: f64, step: f64) -> Self

Stepped float range — compatible with both GridSearch and BayesianSearch.

pub fn int_bounds(start: i64, end: i64) -> Self

Continuous integer bounds for BayesianSearch.

Equivalent to int_range(start, end, 1). Also usable with GridSearch (enumerates every integer in [start, end]), but prefer int_range with a wider step when the grid would be very large.

pub fn float_bounds(start: f64, end: f64) -> Self

Continuous float bounds — BayesianSearch only.

A step of 0.0 intentionally makes GridSearch return an error, giving a clear signal when the wrong optimiser is used with this range type.

Trait Implementations

impl Clone for ParamRange

fn clone(&self) -> ParamRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamRange

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

Formats the value using the given formatter.