org.ojalgo.optimisation

Class Optimisation.Options

java.lang.Object

org.ojalgo.optimisation.Optimisation.Options

All Implemented Interfaces:

Cloneable, Optimisation

Enclosing interface:

Optimisation

public static final class Optimisation.Options
extends Object
implements Optimisation, Cloneable

Nested Class Summary

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
NumberContext	feasibility Used to determine/validate feasibility.
int	iterations_abort The maximmum number of iterations allowed for the solve() command.
int	iterations_suffice Calculations will be terminated after this number of iterations if a feasible solution has been found.
BasicLogger.Printer	logger_appender If this is null nothing is printed, if it is not null then progress/debug messages are printed to that BasicLogger.Printer.
boolean	logger_detailed Detailed (debug) logging or not.
Class<? extends Optimisation.Solver>	logger_solver Which Optimisation.Solver to debug.
double	mip_gap The (relative) MIP gap is the difference between the best integer solution found so far and a node's non-integer solution, relative to the optimal value (approximated by the currently best integer solution).
NumberContext	print For display only!
NumberContext	solution Used when copying the solver's solution back to the model (converting from double to BigDecimal).
long	time_abort The maximmum number of millis allowed for the solve() command.
long	time_suffice Calculations will be terminated after this amount of time if a feasible solution has been found.
boolean	validate If true models and solvers will validate data at various points.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
protected Object	clone() Deprecated. Since v45 Don't copy or clone these, create them the waynyou need them.
Optimisation.Options	copy() Deprecated. Since v45 Wont be Cloneable either
void	debug(Class<? extends Optimisation.Solver> solver) Will configure detailed dubug logging and validation
<T> Optional<T>	getConfigurator(Class<T> type)
void	progress(Class<? extends Optimisation.Solver> solver) Will configure high level (low volume) progress logging
void	setConfigurator(Object configurator)

Methods inherited from class java.lang.Object

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

Field Detail

feasibility

public NumberContext feasibility

Used to determine/validate feasibility. Are the constraints violated or not? Are the variable values integer or not?

iterations_abort

public int iterations_abort

The maximmum number of iterations allowed for the solve() command.

iterations_suffice

public int iterations_suffice

Calculations will be terminated after this number of iterations if a feasible solution has been found. If no feasible solution has been found calculations will continue until one is found or iterations_abort is reached. This option is, probably, only of interest with the IntegerSolver.

logger_appender

public BasicLogger.Printer logger_appender

If this is null nothing is printed, if it is not null then progress/debug messages are printed to that BasicLogger.Printer.

logger_detailed

public boolean logger_detailed

Detailed (debug) logging or not.

logger_solver

public Class<? extends Optimisation.Solver> logger_solver

Which Optimisation.Solver to debug. Null means NO solvers. This setting is only relevant if logger_appender has been set.

mip_gap

public double mip_gap

The (relative) MIP gap is the difference between the best integer solution found so far and a node's non-integer solution, relative to the optimal value (approximated by the currently best integer solution). If the gap is smaller than this value, then the corresponding branch i terminated as it is deemed unlikely or too "expensive" to find better integer solutions there.

print

public NumberContext print

For display only!

solution

public NumberContext solution

Used when copying the solver's solution back to the model (converting from double to BigDecimal). Variable values, dual variable values, lagrange multipliers...

time_abort

public long time_abort

The maximmum number of millis allowed for the solve() command. Executions will be aborted regardless of if a solution has been found or not.

time_suffice

public long time_suffice

Calculations will be terminated after this amount of time if a feasible solution has been found. If no feasible solution has been found calculations will continue until one is found or time_abort is reached. This option is , probably, only of interest with the IntegerSolver.

validate

public boolean validate

If true models and solvers will validate data at various points. Validation is turned off by default. Turning it on will significantly slow down execution - even very expensive validation may be performed.

Constructor Detail

Options

public Options()

Method Detail

copy

@Deprecated
public Optimisation.Options copy()

Deprecated. Since v45 Wont be Cloneable either

debug

public void debug(Class<? extends Optimisation.Solver> solver)

Will configure detailed dubug logging and validation

Parameters:

solver -

getConfigurator

public <T> Optional<T> getConfigurator(Class<T> type)

progress

public void progress(Class<? extends Optimisation.Solver> solver)

Will configure high level (low volume) progress logging

Parameters:

solver -

setConfigurator

public void setConfigurator(Object configurator)

clone

@Deprecated
protected Object clone()
                            throws CloneNotSupportedException

Deprecated. Since v45 Don't copy or clone these, create them the waynyou need them.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException