Struct kurobako_core::domain::VariableBuilder

pub struct VariableBuilder { /* private fields */ }

Variable builder.

Implementations

impl VariableBuilder

pub fn new(name: &str) -> Self

Makes a new VariableBuilder with the given variable name.

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

Sets the name of this variable.

pub fn uniform(self) -> Self

Sets the distribution of this variable to Distribution::Uniform.

Note that Distribution::Uniform is the default distribution.

pub fn log_uniform(self) -> Self

Sets the distribution of this variable to Distribution::LogUniform.

pub fn continuous(self, low: f64, high: f64) -> Self

Sets the range of this variable to the given continuous numerical range.

pub fn discrete(self, low: i64, high: i64) -> Self

Sets the range of this variable to the given discrete numerical range.

pub fn categorical<I, T>(self, choices: I) -> Self where
    I: IntoIterator<Item = T>,
    T: AsRef<str>, 

Sets the range of this variable to the given categorical range.

pub fn boolean(self) -> Self

Sets the range of this variable to boolean.

This is equivalent to self.categorical(&["false", "true"]).

pub fn range(self, range: Range) -> Self

Sets the range of this variable.

pub fn constraint(self, constraint: Constraint) -> Self

Sets the evaluation constraint to this variable.

pub fn finish(self) -> Result<Variable>

Builds a Variable instance with the given settings.

Trait Implementations

impl Debug for VariableBuilder

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

Formats the value using the given formatter.

impl From<Variable> for VariableBuilder

fn from(f: Variable) -> Self

Converts to this type from the input type.