Module ojalgo

Package org.ojalgo.optimisation.linear

Class LinearSolver.ModelIntegration

java.lang.Object

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

org.ojalgo.optimisation.linear.LinearSolver.ModelIntegration

All Implemented Interfaces:

Optimisation, Optimisation.Integration<ExpressionsBasedModel,LinearSolver>

Enclosing class:

LinearSolver

public static final class LinearSolver.ModelIntegration
extends ExpressionsBasedModel.Integration<LinearSolver>

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

Constructor Summary

Constructors

Constructor	Description
ModelIntegration()

Method Summary

Modifier and Type	Method	Description
LinearSolver	build(ExpressionsBasedModel model)	An integration must be able to instantiate a solver that can handle (any) model instance.
protected int	getIndexInSolver(ExpressionsBasedModel model, Variable variable)
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, isSwitch, newValidator, reduceFullToFree, setSwitch, withCapabilityPredicate, withOptionsModifier

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelIntegration

public ModelIntegration()

Method Detail

build

public LinearSolver 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,LinearSolver>

Overrides:

toModelState in class ExpressionsBasedModel.Integration<LinearSolver>

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,LinearSolver>

Overrides:

toSolverState in class ExpressionsBasedModel.Integration<LinearSolver>

See Also:

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

getIndexInSolver

protected int getIndexInSolver(ExpressionsBasedModel model,
                               Variable variable)

Overrides:

getIndexInSolver in class ExpressionsBasedModel.Integration<LinearSolver>

Returns:

The index with which one can reference parameters related to this variable in the solver.