org.ojalgo.optimisation.integer

Class IntegerSolver

java.lang.Object

org.ojalgo.optimisation.GenericSolver

org.ojalgo.optimisation.integer.IntegerSolver

All Implemented Interfaces:

Optimisation, Optimisation.Solver

Direct Known Subclasses:

NewIntegerSolver, OldIntegerSolver

public abstract class IntegerSolver
extends GenericSolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegerSolver.ModelIntegration

Nested classes/interfaces inherited from class org.ojalgo.optimisation.GenericSolver

GenericSolver.Builder<B extends GenericSolver.Builder<?,?>,S extends GenericSolver>

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

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

Field Summary

Fields inherited from class org.ojalgo.optimisation.GenericSolver

options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntegerSolver(ExpressionsBasedModel model, Optimisation.Options solverOptions)

Method Summary

Modifier and Type	Method and Description
protected int	countIntegerSolutions()
protected double	evaluateFunction(Access1D<?> solution)
protected Optimisation.Result	getBestResultSoFar()
protected MatrixStore<Double>	getGradient(Access1D<Double> solution)
protected ExpressionsBasedModel	getIntegerModel()
protected ExpressionsBasedModel	getRelaxedModel()
protected abstract boolean	initialise(Optimisation.Result kickStarter)
protected boolean	isFunctionSet()
protected boolean	isGoodEnoughToContinueBranching(double relaxedNodeValue)
protected boolean	isIntegerSolutionFound()
protected boolean	isIterationNecessary()
protected boolean	isModelSet()
static IntegerSolver	make(ExpressionsBasedModel model)
protected void	markInteger(org.ojalgo.optimisation.integer.NodeKey key, ExpressionsBasedModel model, Optimisation.Result result)
protected abstract boolean	needsAnotherIteration()
protected abstract boolean	validate() Should validate the solver data/input/structue.

Methods inherited from class org.ojalgo.optimisation.GenericSolver

buildResult, countIterations, countTime, error, extractSolution, getState, incrementIterationsCount, isDebug, isIterationAllowed, isProgress, log, log, resetIterationsCount, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.optimisation.Optimisation.Solver

dispose, solve, solve

Constructor Detail

IntegerSolver

protected IntegerSolver(ExpressionsBasedModel model,
                        Optimisation.Options solverOptions)

Method Detail

make

public static IntegerSolver make(ExpressionsBasedModel model)

countIntegerSolutions

protected int countIntegerSolutions()

evaluateFunction

protected final double evaluateFunction(Access1D<?> solution)

Specified by:

evaluateFunction in class GenericSolver

getBestResultSoFar

protected Optimisation.Result getBestResultSoFar()

getGradient

protected final MatrixStore<Double> getGradient(Access1D<Double> solution)

getIntegerModel

protected ExpressionsBasedModel getIntegerModel()

getRelaxedModel

protected final ExpressionsBasedModel getRelaxedModel()

initialise

protected abstract boolean initialise(Optimisation.Result kickStarter)

isFunctionSet

protected final boolean isFunctionSet()

isGoodEnoughToContinueBranching

protected boolean isGoodEnoughToContinueBranching(double relaxedNodeValue)

isIntegerSolutionFound

protected boolean isIntegerSolutionFound()

isIterationNecessary

protected boolean isIterationNecessary()

isModelSet

protected final boolean isModelSet()

markInteger

protected void markInteger(org.ojalgo.optimisation.integer.NodeKey key,
                           ExpressionsBasedModel model,
                           Optimisation.Result result)

needsAnotherIteration

protected abstract boolean needsAnotherIteration()

validate

protected abstract boolean validate()

Should validate the solver data/input/structue. Even "expensive" validation can be performed as the method should only be called if Optimisation.Options#validate is set to true. In addition to returning true or false the implementation should set the state to either Optimisation.State#VALID or Optimisation.State#INVALID (or possibly Optimisation.State#FAILED). Typically the method should be called at the very beginning of the solve-method.

Returns:

Is the solver instance valid?