org.ojalgo.optimisation

Enum Optimisation.State

java.lang.Object

java.lang.Enum<Optimisation.State>

org.ojalgo.optimisation.Optimisation.State

All Implemented Interfaces:

Serializable, Comparable<Optimisation.State>, Optimisation

Enclosing interface:

Optimisation

public static enum Optimisation.State
extends Enum<Optimisation.State>
implements Optimisation

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROXIMATE Approximate and/or Intermediate solution - Iteration point Probably infeasible, but still "good"
DISTINCT Unique (and optimal) solution - there is no other solution that is equal or better
FAILED Unexpected failure or exception
FEASIBLE Solved - a solution that complies with all constraints
INFEASIBLE No solution that complies with all constraints exists
INVALID The problem/model is infeasible, unbounded or otherwise invalid.
OPTIMAL Optimal solution - there is no better
UNBOUNDED There's an infinite number of feasible solutions and no bound on the objective function value.
UNEXPLORED New/changed problem
VALID Model entities and solver components (matrices) are valid

Method Summary

Modifier and Type	Method and Description
boolean	isApproximate()
boolean	isDistinct()
boolean	isFailure() FAILED, INVALID, INFEASIBLE or UNBOUNDED
boolean	isFeasible()
boolean	isOptimal()
boolean	isSuccess() VALID, APPROXIMATE, FEASIBLE, OPTIMAL or DISTINCT
boolean	isUnexplored() UNEXPLORED
boolean	isValid()
static Optimisation.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Optimisation.State[]	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

APPROXIMATE

public static final Optimisation.State APPROXIMATE

Approximate and/or Intermediate solution - Iteration point Probably infeasible, but still "good"

DISTINCT

public static final Optimisation.State DISTINCT

Unique (and optimal) solution - there is no other solution that is equal or better

FAILED

public static final Optimisation.State FAILED

Unexpected failure or exception

FEASIBLE

public static final Optimisation.State FEASIBLE

Solved - a solution that complies with all constraints

INFEASIBLE

public static final Optimisation.State INFEASIBLE

No solution that complies with all constraints exists

INVALID

public static final Optimisation.State INVALID

The problem/model is infeasible, unbounded or otherwise invalid.

OPTIMAL

public static final Optimisation.State OPTIMAL

Optimal solution - there is no better

UNBOUNDED

public static final Optimisation.State UNBOUNDED

There's an infinite number of feasible solutions and no bound on the objective function value. Please note that using this state indicator implies a feasible solution. If a feasible solution has not been been found you should instead use INFEASIBLE or INVALID.

UNEXPLORED

public static final Optimisation.State UNEXPLORED

New/changed problem

VALID

public static final Optimisation.State VALID

Model entities and solver components (matrices) are valid

Method Detail

values

public static Optimisation.State[] 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 (Optimisation.State c : Optimisation.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Optimisation.State valueOf(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:

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

NullPointerException - if the argument is null

isApproximate

public boolean isApproximate()

isDistinct

public boolean isDistinct()

isFailure

public boolean isFailure()

FAILED, INVALID, INFEASIBLE or UNBOUNDED

isFeasible

public boolean isFeasible()

isOptimal

public boolean isOptimal()

isSuccess

public boolean isSuccess()

VALID, APPROXIMATE, FEASIBLE, OPTIMAL or DISTINCT

isUnexplored

public boolean isUnexplored()

UNEXPLORED

isValid

public boolean isValid()