Module ojalgo

Package org.ojalgo.optimisation

Enum ExpressionsBasedModel.IntegrationProperty

java.lang.Object

java.lang.Enum<ExpressionsBasedModel.IntegrationProperty>

org.ojalgo.optimisation.ExpressionsBasedModel.IntegrationProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExpressionsBasedModel.IntegrationProperty>

Enclosing class:

ExpressionsBasedModel

public static enum ExpressionsBasedModel.IntegrationProperty
extends java.lang.Enum<ExpressionsBasedModel.IntegrationProperty>

Various switches that can be set by solver integrations to control its own behaviour. Typically used when a single integration is a facade delegating to a set of (switching between a pair of) other integrations.

The various properties are here are for very specific use cases, but have been given generic names to encourage reuse.

Solver integrations are (absolutely have to be) stateless. If they contain logic that cause them to take different paths, information about that needs to be stored in the model (or solver) instance. That's what these properties are for.

See Also:

ExpressionsBasedModel.Integration.setSwitch(ExpressionsBasedModel, IntegrationProperty, boolean), ExpressionsBasedModel.Integration.isSwitch(ExpressionsBasedModel, IntegrationProperty)

Enum Constant Summary

Enum Constants

Enum Constant	Description
JAVA_OR_NATIVE_CODE	Any integration that can switch between Java and native code solvers.
LP_OR_QP	Any integration that can handle both LP and QP models.
PRIMAL_OR_DUAL_LP	Any LP solver integration that can switch between primal and dual algorithm implementations.
TEMPORARY	Something temporary or experimental that does not yet have a specific constant.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IntegrationProperty()

Method Summary

Modifier and Type	Method	Description
static ExpressionsBasedModel.IntegrationProperty	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ExpressionsBasedModel.IntegrationProperty[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA_OR_NATIVE_CODE

public static final ExpressionsBasedModel.IntegrationProperty JAVA_OR_NATIVE_CODE

Any integration that can switch between Java and native code solvers.

JAVA==false, NATIVE==true

LP_OR_QP

public static final ExpressionsBasedModel.IntegrationProperty LP_OR_QP

Any integration that can handle both LP and QP models.

LP==false, QP==true

PRIMAL_OR_DUAL_LP

public static final ExpressionsBasedModel.IntegrationProperty PRIMAL_OR_DUAL_LP

Any LP solver integration that can switch between primal and dual algorithm implementations.

PRIMAL==false, DUAL==true

TEMPORARY

public static final ExpressionsBasedModel.IntegrationProperty TEMPORARY

Something temporary or experimental that does not yet have a specific constant.

Constructor Detail

IntegrationProperty

private IntegrationProperty()

Method Detail

values

public static ExpressionsBasedModel.IntegrationProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExpressionsBasedModel.IntegrationProperty c : ExpressionsBasedModel.IntegrationProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExpressionsBasedModel.IntegrationProperty valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null