Skip to main content

SolutionBuilder

Struct SolutionBuilder 

Source
pub struct SolutionBuilder { /* private fields */ }
Expand description

Builder for creating Solution with validation.

§Example

use ommx::{Solution, Sense};
use std::collections::BTreeMap;

let solution = Solution::builder()
    .objective(0.0)
    .evaluated_constraints(BTreeMap::new())
    .decision_variables(BTreeMap::new())
    .sense(Sense::Minimize)
    .build()
    .unwrap();

Implementations§

Source§

impl SolutionBuilder

Source

pub fn new() -> Self

Creates a new SolutionBuilder with all fields unset.

Source

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

Sets the objective value.

Source

pub fn evaluated_constraints( self, evaluated_constraints: BTreeMap<ConstraintID, EvaluatedConstraint>, ) -> Self

Sets the evaluated constraints.

Source

pub fn evaluated_constraints_collection( self, evaluated_constraints: EvaluatedCollection<Constraint>, ) -> Self

Sets the evaluated constraints from a collection.

Source

pub fn evaluated_indicator_constraints_collection( self, evaluated_indicator_constraints: EvaluatedCollection<IndicatorConstraint>, ) -> Self

Sets the evaluated indicator constraints from a collection.

Source

pub fn evaluated_indicator_constraints( self, evaluated_indicator_constraints: BTreeMap<IndicatorConstraintID, EvaluatedIndicatorConstraint>, ) -> Self

Sets the evaluated indicator constraints.

Source

pub fn evaluated_one_hot_constraints_collection( self, evaluated_one_hot_constraints: EvaluatedCollection<OneHotConstraint>, ) -> Self

Sets the evaluated one-hot constraints from a collection.

Source

pub fn evaluated_sos1_constraints_collection( self, evaluated_sos1_constraints: EvaluatedCollection<Sos1Constraint>, ) -> Self

Sets the evaluated SOS1 constraints from a collection.

Source

pub fn evaluated_named_functions( self, evaluated_named_functions: BTreeMap<NamedFunctionID, EvaluatedNamedFunction>, ) -> Self

Sets the evaluated named functions.

Source

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

Sets the decision variables.

Source

pub fn variable_labels(self, variable_labels: VariableLabelStore) -> Self

Sets the per-variable modeling-label store.

Source

pub fn named_function_labels( self, named_function_labels: NamedFunctionLabelStore, ) -> Self

Sets the per-named-function modeling-label store.

Source

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

Sets the optimization sense.

Source

pub fn feasibility_atol(self, feasibility_atol: ATol) -> Self

Sets the absolute tolerance used to compute and validate feasibility fields.

Source

pub fn optimality(self, optimality: Optimality) -> Self

Sets the optimality status.

Source

pub fn relaxation(self, relaxation: Relaxation) -> Self

Sets the relaxation status.

Source

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

Builds the Solution with full validation.

§Errors

Returns an error if:

  • Required fields (objective, evaluated_constraints, decision_variables, sense) are not set
  • Constraint collection sidecars contain invalid keys
  • Named-function labels reference IDs not present in the evaluated named-function table
  • Variables referenced in constraints’ or named functions’ used_decision_variable_ids are not in decision_variables
Source

pub unsafe fn build_unchecked(self) -> Result<Solution>

Builds the Solution without host-level revalidation.

§Safety

This method still constructs table owners through their checked constructors, so table-level invariants such as label IDs referring to existing table rows are enforced. It does not revalidate host-level cross references. The caller must ensure:

  • decision_variables is keyed by the intended VariableID for each row
  • All used_decision_variable_ids in constraints and evaluated named functions exist in decision_variables
  • Special-constraint indicator_active, active_variable, and per-constraint feasible fields are consistent with decision_variables under feasibility_atol

Use Self::build for validated construction. This method is useful when invariants are guaranteed by construction, such as when creating a Solution from Instance::evaluate.

§Errors

Returns an error if required fields are not set or table-level sidecar invariants fail.

Trait Implementations§

Source§

impl Clone for SolutionBuilder

Source§

fn clone(&self) -> SolutionBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SolutionBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SolutionBuilder

Source§

fn default() -> SolutionBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more