Struct InstanceBuilder 

pub struct InstanceBuilder { /* private fields */ }

Builder for creating Instance with validation.

This builder allows constructing an Instance step by step, with optional fields that can be set before calling build().

Example

use ommx::{Instance, Sense, Function};
use std::collections::BTreeMap;

let instance = Instance::builder()
    .sense(Sense::Minimize)
    .objective(Function::Zero)
    .decision_variables(BTreeMap::new())
    .constraints(BTreeMap::new())
    .build()
    .unwrap();

Implementations

impl InstanceBuilder

pub fn new() -> Self

Creates a new InstanceBuilder with all fields unset.

pub fn sense(self, sense: Sense) -> Self

Sets the optimization sense (minimize or maximize).

pub fn objective(self, objective: Function) -> Self

Sets the objective function.

pub fn decision_variables( self, decision_variables: BTreeMap<VariableID, DecisionVariable>, ) -> Self

Sets the decision variables.

pub fn constraints( self, constraints: BTreeMap<ConstraintID, Constraint>, ) -> Self

Sets the constraints.

pub fn named_functions( self, named_functions: BTreeMap<NamedFunctionID, NamedFunction>, ) -> Self

Sets the named functions.

pub fn removed_constraints( self, removed_constraints: BTreeMap<ConstraintID, RemovedConstraint>, ) -> Self

Sets the removed constraints.

pub fn decision_variable_dependency( self, decision_variable_dependency: AcyclicAssignments, ) -> Self

Sets the decision variable dependency.

pub fn constraint_hints(self, constraint_hints: ConstraintHints) -> Self

Sets the constraint hints.

pub fn parameters(self, parameters: Parameters) -> Self

Sets the parameters.

pub fn description(self, description: Description) -> Self

Sets the description.

pub fn build(self) -> Result<Instance>

Builds the Instance with validation.

Errors

Returns an error if:

• Required fields (sense, objective, decision_variables, constraints) are not set
• Map keys don’t match their value’s ID (decision_variables, constraints, removed_constraints)
• The objective function or constraints reference undefined variable IDs
• The keys of constraints and removed_constraints are not disjoint
• The keys of decision_variable_dependency are not in decision_variables
• used, fixed, and dependent are not pairwise disjoint (see DecisionVariableAnalysis)

Trait Implementations

impl Clone for InstanceBuilder

fn clone(&self) -> InstanceBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceBuilder

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

Formats the value using the given formatter.

impl Default for InstanceBuilder

fn default() -> InstanceBuilder

Returns the “default value” for a type.