Module ojalgo

Package org.ojalgo.optimisation

Class ConfiguredIntegration<S extends Optimisation.Solver>

java.lang.Object

org.ojalgo.optimisation.ExpressionsBasedModel.Integration<S>

org.ojalgo.optimisation.ConfiguredIntegration<S>

All Implemented Interfaces:

Optimisation, Optimisation.Integration<ExpressionsBasedModel,S>

final class ConfiguredIntegration<S extends Optimisation.Solver>
extends ExpressionsBasedModel.Integration<S>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.optimisation.Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M extends Optimisation.Model,S extends Optimisation.Solver>, Optimisation.Model, Optimisation.Objective, Optimisation.Options, Optimisation.ProblemStructure, Optimisation.Result, Optimisation.Sense, Optimisation.Solver, Optimisation.State

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.function.Predicate<ExpressionsBasedModel>	myCapabilityPredicate
private ExpressionsBasedModel.Integration<S>	myDelegate
private java.util.function.Consumer<Optimisation.Options>	myOptionsModifier

Constructor Summary

Constructors

Constructor	Description
ConfiguredIntegration(ExpressionsBasedModel.Integration<S> delegate, java.util.function.Predicate<ExpressionsBasedModel> capabilityPredicate, java.util.function.Consumer<Optimisation.Options> optionsModifier)

Method Summary

Modifier and Type	Method	Description
S	build(ExpressionsBasedModel model)	An integration must be able to instantiate a solver that can handle (any) model instance.
boolean	isCapable(ExpressionsBasedModel model)
Optimisation.Result	toModelState(Optimisation.Result solverState, ExpressionsBasedModel model)	The reverse of ExpressionsBasedModel.Integration.toSolverState(Optimisation.Result, ExpressionsBasedModel).
Optimisation.Result	toSolverState(Optimisation.Result modelState, ExpressionsBasedModel model)	This default implementation assumes the solver state and model state are identical, and simply returns the supplied model state.

Methods inherited from class org.ojalgo.optimisation.ExpressionsBasedModel.Integration

expandFreeToFull, extractSolverState, getIndexInSolver, isSwitch, newValidator, reduceFullToFree, setSwitch, withCapabilityPredicate, withOptionsModifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myCapabilityPredicate

private final java.util.function.Predicate<ExpressionsBasedModel> myCapabilityPredicate

myDelegate

private final ExpressionsBasedModel.Integration<S extends Optimisation.Solver> myDelegate

myOptionsModifier

private final java.util.function.Consumer<Optimisation.Options> myOptionsModifier

Constructor Detail

ConfiguredIntegration

ConfiguredIntegration(ExpressionsBasedModel.Integration<S> delegate,
                      java.util.function.Predicate<ExpressionsBasedModel> capabilityPredicate,
                      java.util.function.Consumer<Optimisation.Options> optionsModifier)

Method Detail

build

public S build(ExpressionsBasedModel model)

Description copied from interface: Optimisation.Integration

An integration must be able to instantiate a solver that can handle (any) model instance.

isCapable

public boolean isCapable(ExpressionsBasedModel model)

Returns:

true if this solver (integration) can handle the input model

toModelState

public Optimisation.Result toModelState(Optimisation.Result solverState,
                                        ExpressionsBasedModel model)

Description copied from class: ExpressionsBasedModel.Integration

The reverse of ExpressionsBasedModel.Integration.toSolverState(Optimisation.Result, ExpressionsBasedModel).

Specified by:

toModelState in interface Optimisation.Integration<ExpressionsBasedModel,S extends Optimisation.Solver>

Overrides:

toModelState in class ExpressionsBasedModel.Integration<S extends Optimisation.Solver>

See Also:

ExpressionsBasedModel.Integration.reduceFullToFree(Optimisation.Result, ExpressionsBasedModel, DenseArray.Factory), ExpressionsBasedModel.Integration.expandFreeToFull(Optimisation.Result, ExpressionsBasedModel, DenseArray.Factory)

toSolverState

public Optimisation.Result toSolverState(Optimisation.Result modelState,
                                         ExpressionsBasedModel model)

Description copied from class: ExpressionsBasedModel.Integration

This default implementation assumes the solver state and model state are identical, and simply returns the supplied model state.

In any case where the set of variables present in the solver does not match what's in the model one-to-one, this method and its reciprocal ExpressionsBasedModel.Integration.toModelState(Optimisation.Result, ExpressionsBasedModel) needs to be overridden with custom mapping implementations.

A very common case is when the solver only works with free (not eliminated by the pre-solver) variables. There are helper methods to do just that.

Specified by:

toSolverState in interface Optimisation.Integration<ExpressionsBasedModel,S extends Optimisation.Solver>

Overrides:

toSolverState in class ExpressionsBasedModel.Integration<S extends Optimisation.Solver>

See Also:

ExpressionsBasedModel.Integration.reduceFullToFree(Optimisation.Result, ExpressionsBasedModel, DenseArray.Factory), ExpressionsBasedModel.Integration.expandFreeToFull(Optimisation.Result, ExpressionsBasedModel, DenseArray.Factory)