org.ojalgo.optimisation

Class GenericSolver

java.lang.Object

org.ojalgo.optimisation.GenericSolver

All Implemented Interfaces:

Optimisation, Optimisation.Solver

Direct Known Subclasses:

ConvexSolver, IntegerSolver, LinearSolver

public abstract class GenericSolver
extends Object
implements Optimisation.Solver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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

Modifier and Type	Field and Description
Optimisation.Options	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericSolver(Optimisation.Options solverOptions)

Method Summary

Modifier and Type	Method and Description
protected Optimisation.Result	buildResult()
protected int	countIterations()
protected long	countTime()
protected void	error(String messagePattern, Object... arguments)
protected abstract double	evaluateFunction(Access1D<?> solution)
protected abstract MatrixStore<Double>	extractSolution() Should be able to feed this to evaluateFunction(Access1D).
protected Optimisation.State	getState()
protected int	incrementIterationsCount() Should be called after a completed iteration.
protected boolean	isDebug()
protected boolean	isIterationAllowed() Should be called at the start of an iteration (before it actually starts) to check if you should abort instead.
protected boolean	isProgress()
protected void	log(String descripttion, Access2D<?> matrix)
protected void	log(String messagePattern, Object... arguments)
protected void	resetIterationsCount()
protected void	setState(Optimisation.State aState)

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

Field Detail

options

public final Optimisation.Options options

Constructor Detail

GenericSolver

protected GenericSolver(Optimisation.Options solverOptions)

Method Detail

buildResult

protected Optimisation.Result buildResult()

countIterations

protected final int countIterations()

countTime

protected final long countTime()

error

protected final void error(String messagePattern,
                           Object... arguments)

evaluateFunction

protected abstract double evaluateFunction(Access1D<?> solution)

extractSolution

protected abstract MatrixStore<Double> extractSolution()

Should be able to feed this to evaluateFunction(Access1D).

getState

protected final Optimisation.State getState()

incrementIterationsCount

protected final int incrementIterationsCount()

Should be called after a completed iteration. The iterations count is not "1" untill the first iteration is completed.

isDebug

protected final boolean isDebug()

isIterationAllowed

protected final boolean isIterationAllowed()

Should be called at the start of an iteration (before it actually starts) to check if you should abort instead. Will return false if either the iterations count or the execution time has reached their respective limits.

isProgress

protected final boolean isProgress()

log

protected final void log(String descripttion,
                         Access2D<?> matrix)

log

protected final void log(String messagePattern,
                         Object... arguments)

resetIterationsCount

protected final void resetIterationsCount()

setState

protected final void setState(Optimisation.State aState)