Struct Objective

pub struct Objective<S> { /* private fields */ }

Defines the objective of an optimization problem, which is constant throughout the optimization. Afterwards an objective instance can be used to evaluate every solution object.

It is a hierarchical objective, i.e., it consists of several levels of LinearCombinations of Indicators. The objective is to be minimized with the most important level being the first entry of the vector. A solution is evaluated by using the evaluate method, which consumes the solution, computes its ObjectiveValue and returns both as EvaluatedSolution.

S: the solution type for which the objective is defined.

Implementations

impl<S> Objective<S>

pub fn evaluate(&self, solution: S) -> EvaluatedSolution<S>

Consumes the solution, computes its ObjectiveValue, and returns both as EvaluatedSolution.

pub fn zero(&self) -> ObjectiveValue

Returns the zero ObjectiveValue (BaseValue::Zero on each level).

pub fn maximum(&self) -> ObjectiveValue

Returns the maximum ObjectiveValue (BaseValue::Maximum on each level).

pub fn print_objective_value(&self, objective_value: &ObjectiveValue)

Prints the ObjectiveValue.

pub fn print_objective_value_with_comparison( &self, objective_value: &ObjectiveValue, comparison: &ObjectiveValue, )

Prints the ObjectiveValue with a comparison to another ObjectiveValue.

pub fn objective_value_to_json(&self, objective_value: &ObjectiveValue) -> Value

Converts an ObjectiveValue to a JSON object (using serde_json).

impl<S> Objective<S>

pub fn new(hierarchy_levels: Vec<LinearCombination<S>>) -> Objective<S>

Creates a new Objective with the given LinearCombinations as hierarchy levels. The most important level is the first entry of the vector.

pub fn new_single_level( linear_combination: LinearCombination<S>, ) -> Objective<S>

Creates a new Objective with a single LinearCombination as the only hierarchy level.

pub fn new_single_indicator(indicator: Box<dyn Indicator<S>>) -> Objective<S>

Creates a new Objective with a single Indicator as the only hierarchy level.

pub fn new_single_indicator_per_level( indicators: Vec<Box<dyn Indicator<S>>>, ) -> Objective<S>

Creates a new Objective with a single Indicator per hierarchy level. The most important level is the first entry of the vector.