Class SimplexSolver

java.lang.Object

org.ojalgo.optimisation.GenericSolver

org.ojalgo.optimisation.linear.LinearSolver

org.ojalgo.optimisation.linear.SimplexSolver

All Implemented Interfaces:

Optimisation, Optimisation.Solver, UpdatableSolver

Direct Known Subclasses:

DualSimplexSolver, PhasedSimplexSolver, PrimalSimplexSolver

abstract class SimplexSolver
extends LinearSolver

Meant to replace SimplexTableauSolver. It is already better in many aspects, but still can't do everything required to fully replace the old solver.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	SimplexSolver.Direction
(package private) static final class	SimplexSolver.EnterInfo	Enter to SimplexStore.ColumnState.BASIS from either SimplexStore.ColumnState.LOWER, SimplexStore.ColumnState.UPPER, or SimplexStore.ColumnState.UNBOUNDED.
(package private) static final class	SimplexSolver.ExitInfo	Exit from SimplexStore.ColumnState.BASIS to either SimplexStore.ColumnState.LOWER or SimplexStore.ColumnState.UPPER.
(package private) static final class	SimplexSolver.IterDescr

Nested classes/interfaces inherited from class LinearSolver

LinearSolver.Builder, LinearSolver.Configuration, LinearSolver.ModelIntegration, LinearSolver.NewIntegration, LinearSolver.OldIntegration

Nested classes/interfaces inherited from interface Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M,S>, 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 final SimplexStore	mySimplex
private final double[]	mySolutionShift
private double	myValueShift
private static final NumberContext	PIVOT
private static final NumberContext	RATIO

Fields inherited from class LinearSolver

INTEGRATION, NEWER_DUAL_SOLVER, OLDER_PRIMAL_SOLVER

Fields inherited from class GenericSolver

options

Constructor Summary

Constructors

Constructor	Description
SimplexSolver(Optimisation.Options solverOptions, SimplexStore simplexStore)

Method Summary

Modifier and Type	Method	Description
(package private) final SimplexSolver	basis(int[] basis)
(package private) static <S extends SimplexStore> S	build(ExpressionsBasedModel model, Function<LinearStructure, S> factory)
(package private) final void	doDualIterations(SimplexSolver.IterDescr iteration)
(package private) final void	doPrimalIterations(SimplexSolver.IterDescr iteration)
(package private) static Optimisation.Result	doSolveConvexAsDual(ConvexData<Double> convex, Optimisation.Options options, boolean zeroC)
(package private) static Optimisation.Result	doSolveConvexAsPrimal(ConvexData<Double> convex, Optimisation.Options options, boolean zeroC)
private Access1D<?>	extractMultipliers()
(package private) final Optimisation.Result	extractResult()
private double[]	extractSolution()
private double	extractValue()
boolean	fixVariable(int index, double value)
final Collection<Equation>	generateCutCandidates(double fractionality, boolean... integer)
private boolean	getDualExitCandidate(SimplexSolver.IterDescr iteration)
LinearStructure	getEntityMap()
private double	getLowerBound(int index)
private double[]	getLowerBounds()
private boolean	getPrimalEnterCandidate(SimplexSolver.IterDescr iteration)
private double	getUpperBound(int index)
private double[]	getUpperBounds()
(package private) final boolean	isDualFeasible()
(package private) final boolean	isPrimalFeasible()
private void	logCurrentState()
(package private) final SimplexSolver.IterDescr	prepareToIterate()
(package private) abstract void	setup(SimplexStore simplex)	Determine if non-basic variables are at their lower or upper bound (or if they are unbounded) Shift ranges/bounds so that (one of) the bound(s) is at zero Assumes that the ranges/bounds of basic variables are already defined this way.
(package private) final void	shift(int index, double shift, double weight)
private double	shift(int column, SimplexStore.ColumnState state)
(package private) static int	sizeOfDual(ConvexData<?> convex)
(package private) static int	sizeOfPrimal(ConvexData<?> convex)
private Optimisation.Result	solveUnconstrained()
(package private) void	switchToPhase2()
private boolean	testDualEnterRatio(SimplexSolver.IterDescr iteration)
private boolean	testPrimalExitRatio(SimplexSolver.IterDescr iteration)
private void	update(SimplexSolver.IterDescr iteration)
boolean	updateRange(int index, double lower, double upper)	A generalisation of UpdatableSolver.fixVariable(int, double) where the new/updated lower and upper bounds do not need to be equal.
private boolean	verifyDualFeasibility()
private boolean	verifyPrimalFeasibility()

Methods inherited from class LinearSolver

newBuilder, newBuilder, newGeneralBuilder, newGeneralBuilder, newSolver, newStandardBuilder, newStandardBuilder, solve, toObjectiveFunction

Methods inherited from class GenericSolver

countIterations, countTime, error, getClassSimpleName, getDuration, getState, incrementIterationsCount, isIterationAllowed, isLogDebug, isLogOff, isLogProgress, log, log, log, log, logProgress, printf, resetIterationsCount, setState, setValidator, validate, validate

Methods inherited from class Object

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

Methods inherited from interface Optimisation.Solver

dispose, solve, solve

Methods inherited from interface UpdatableSolver

integers, isMapped

Field Details

PIVOT

private static final NumberContext PIVOT

RATIO

private static final NumberContext RATIO

mySimplex

private final SimplexStore mySimplex

mySolutionShift

private final double[] mySolutionShift

myValueShift

private double myValueShift

Constructor Details

SimplexSolver

SimplexSolver(Optimisation.Options solverOptions,
 SimplexStore simplexStore)

Method Details

build

static <S extends SimplexStore> S build(ExpressionsBasedModel model,
 Function<LinearStructure, S> factory)

doSolveConvexAsDual

static Optimisation.Result doSolveConvexAsDual(ConvexData<Double> convex,
 Optimisation.Options options,
 boolean zeroC)

doSolveConvexAsPrimal

static Optimisation.Result doSolveConvexAsPrimal(ConvexData<Double> convex,
 Optimisation.Options options,
 boolean zeroC)

sizeOfDual

static int sizeOfDual(ConvexData<?> convex)

sizeOfPrimal

static int sizeOfPrimal(ConvexData<?> convex)

fixVariable

public boolean fixVariable(int index,
 double value)

Parameters:

index - The, solver specific, variable index

value - The value to fix that variable to

Returns:

true if fixing is supported and was successful, otherwise false

generateCutCandidates

public final Collection<Equation> generateCutCandidates(double fractionality,
 boolean... integer)

getEntityMap

public LinearStructure getEntityMap()

updateRange

public boolean updateRange(int index,
 double lower,
 double upper)

Description copied from interface: UpdatableSolver

A generalisation of UpdatableSolver.fixVariable(int, double) where the new/updated lower and upper bounds do not need to be equal.

Parameters:

index - The, solver specific, variable index

lower - New lower bound

upper - New upper bound

Returns:

true if updating the range is supported and was successful, otherwise false

extractMultipliers

private Access1D<?> extractMultipliers()

extractSolution

private double[] extractSolution()

extractValue

private double extractValue()

getDualExitCandidate

private boolean getDualExitCandidate(SimplexSolver.IterDescr iteration)

getLowerBound

private double getLowerBound(int index)

getLowerBounds

private double[] getLowerBounds()

getPrimalEnterCandidate

private boolean getPrimalEnterCandidate(SimplexSolver.IterDescr iteration)

getUpperBound

private double getUpperBound(int index)

getUpperBounds

private double[] getUpperBounds()

logCurrentState

private void logCurrentState()

shift

private double shift(int column,
 SimplexStore.ColumnState state)

solveUnconstrained

private Optimisation.Result solveUnconstrained()

testDualEnterRatio

private boolean testDualEnterRatio(SimplexSolver.IterDescr iteration)

testPrimalExitRatio

private boolean testPrimalExitRatio(SimplexSolver.IterDescr iteration)

update

private void update(SimplexSolver.IterDescr iteration)

verifyDualFeasibility

private boolean verifyDualFeasibility()

verifyPrimalFeasibility

private boolean verifyPrimalFeasibility()

basis

final SimplexSolver basis(int[] basis)

doDualIterations

final void doDualIterations(SimplexSolver.IterDescr iteration)

doPrimalIterations

final void doPrimalIterations(SimplexSolver.IterDescr iteration)

extractResult

final Optimisation.Result extractResult()

isDualFeasible

final boolean isDualFeasible()

isPrimalFeasible

final boolean isPrimalFeasible()

prepareToIterate

final SimplexSolver.IterDescr prepareToIterate()

setup

abstract void setup(SimplexStore simplex)

• Determine if non-basic variables are at their lower or upper bound (or if they are unbounded)
• Shift ranges/bounds so that (one of) the bound(s) is at zero
• Assumes that the ranges/bounds of basic variables are already defined this way.

shift

final void shift(int index,
 double shift,
 double weight)

switchToPhase2

void switchToPhase2()