Module ojalgo

Package org.ojalgo.optimisation

Class Optimisation.Result

java.lang.Object

org.ojalgo.optimisation.Optimisation.Result

All Implemented Interfaces:

java.lang.Comparable<Optimisation.Result>, Optimisation, Access1D<java.math.BigDecimal>, Structure1D

Enclosing interface:

Optimisation

public static final class Optimisation.Result
extends java.lang.Object
implements Optimisation, Access1D<java.math.BigDecimal>, java.lang.Comparable<Optimisation.Result>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.structure.Access1D

Access1D.Aggregatable<N extends java.lang.Comparable<N>>, Access1D.Collectable<N extends java.lang.Comparable<N>,R extends Mutate1D>, Access1D.ElementView<N extends java.lang.Comparable<N>>, Access1D.SelectionView<N extends java.lang.Comparable<N>>, Access1D.Sliceable<N extends java.lang.Comparable<N>>, Access1D.Visitable<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.optimisation.Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M extends Optimisation.Model,S extends Optimisation.Solver>, Optimisation.Model, Optimisation.Objective, Optimisation.Options, Optimisation.ProblemStructure, Optimisation.Result, Optimisation.Sense, Optimisation.Solver, Optimisation.State

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,B>>, Structure1D.LongIndex, Structure1D.LoopCallback

Field Summary

Fields

Modifier and Type	Field	Description
private ConstraintsMetaData	myConstraintsMap
private java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>>	myMatchedMultipliers
private Access1D<?>	myMultipliers
private Access1D<?>	mySolution
private Optimisation.State	myState
private double	myValue

Constructor Summary

Constructors

Constructor	Description
Result(Optimisation.State state, double value, Access1D<?> solution)
Result(Optimisation.State state, Optimisation.Result result)
Result(Optimisation.State state, Access1D<?> solution)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Optimisation.Result reference)
long	count()	The total number of elements in this structure.
double	doubleValue(int index)
boolean	equals(java.lang.Object obj)
java.math.BigDecimal	get(long index)
java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>>	getMatchedMultipliers()	The dual variables or Lagrange multipliers, matched to their respective constraints (model entity and constraint type pairs).
java.util.Optional<Access1D<?>>	getMultipliers()	The dual variables or Lagrange multipliers associated with the problem.
Optimisation.Result	getSolution(NumberContext precision)	Will round the solution to the given precision
Optimisation.State	getState()
double	getValue()	Objective Function Value
int	hashCode()
Optimisation.Result	multipliers(double... multipliers)
(package private) Optimisation.Result	multipliers(java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>> matchedMultipliers)
Optimisation.Result	multipliers(ConstraintsMetaData constraintsMap, Access1D<?> multipliers)
private void	multipliers(Optimisation.Result target)
Optimisation.Result	multipliers(Access1D<?> multipliers)
static Optimisation.Result	of(double value, Optimisation.State state, double... solution)
static Optimisation.Result	of(Optimisation.State state, double... solution)
static Optimisation.Result	parse(java.lang.String result)	Parse a String, as produced by the toString() method, into a new instance.
int	size()	The total number of elements in this structure.
java.lang.String	toString()	May potentially be a very long String as it must contain all variable values.
Optimisation.Result	withNegatedValue()
Optimisation.Result	withSolution(Access1D<?> solution)
Optimisation.Result	withSolutionLength(int length)
Optimisation.Result	withState(Optimisation.State state)
Optimisation.Result	withValue(double value)
static Optimisation.Result	wrap(Access1D<?> solution)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asKeyed1D, asList, axpy, byteValue, byteValue, dot, doubleValue, elements, floatValue, floatValue, intValue, intValue, longValue, longValue, nonzeros, select, shortValue, shortValue, supplyTo, toList, toRawCopy1D

Field Detail

myConstraintsMap

private ConstraintsMetaData myConstraintsMap

myMatchedMultipliers

private java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>> myMatchedMultipliers

myMultipliers

private Access1D<?> myMultipliers

mySolution

private final Access1D<?> mySolution

myState

private final Optimisation.State myState

myValue

private final double myValue

Constructor Detail

Result

public Result(Optimisation.State state,
              Access1D<?> solution)

Result

public Result(Optimisation.State state,
              double value,
              Access1D<?> solution)

Result

public Result(Optimisation.State state,
              Optimisation.Result result)

Method Detail

of

public static Optimisation.Result of(double value,
                                     Optimisation.State state,
                                     double... solution)

of

public static Optimisation.Result of(Optimisation.State state,
                                     double... solution)

parse

public static Optimisation.Result parse(java.lang.String result)

Parse a String, as produced by the toString() method, into a new instance.

wrap

public static Optimisation.Result wrap(Access1D<?> solution)

compareTo

public int compareTo(Optimisation.Result reference)

Specified by:

compareTo in interface java.lang.Comparable<Optimisation.Result>

count

public long count()

Description copied from interface: Structure1D

The total number of elements in this structure.

You only need to implement this method if the structure can contain more than Integer.MAX_VALUE elements.

Specified by:

count in interface Structure1D

doubleValue

public double doubleValue(int index)

Specified by:

doubleValue in interface Access1D<java.math.BigDecimal>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

get

public java.math.BigDecimal get(long index)

Specified by:

get in interface Access1D<java.math.BigDecimal>

getMatchedMultipliers

public java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>> getMatchedMultipliers()

The dual variables or Lagrange multipliers, matched to their respective constraints (model entity and constraint type pairs).

getMultipliers

public java.util.Optional<Access1D<?>> getMultipliers()

The dual variables or Lagrange multipliers associated with the problem.

getSolution

public Optimisation.Result getSolution(NumberContext precision)

Will round the solution to the given precision

getState

public Optimisation.State getState()

getValue

public double getValue()

Objective Function Value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

multipliers

public Optimisation.Result multipliers(Access1D<?> multipliers)

multipliers

public Optimisation.Result multipliers(ConstraintsMetaData constraintsMap,
                                       Access1D<?> multipliers)

multipliers

public Optimisation.Result multipliers(double... multipliers)

size

public int size()

Description copied from interface: Structure1D

The total number of elements in this structure.

Specified by:

size in interface Structure1D

toString

public java.lang.String toString()

May potentially be a very long String as it must contain all variable values. The String produced here is (must be) usable by the parse(String) method.

Overrides:

toString in class java.lang.Object

withNegatedValue

public Optimisation.Result withNegatedValue()

withSolution

public Optimisation.Result withSolution(Access1D<?> solution)

withSolutionLength

public Optimisation.Result withSolutionLength(int length)

withState

public Optimisation.Result withState(Optimisation.State state)

withValue

public Optimisation.Result withValue(double value)

multipliers

private void multipliers(Optimisation.Result target)

multipliers

Optimisation.Result multipliers(java.util.List<EntryPair.KeyedPrimitive<EntryPair<ModelEntity<?>,Optimisation.ConstraintType>>> matchedMultipliers)