Module org.maxicp

Package org.maxicp.search.blackbox

Record Class ModelingBlackBox.Result

java.lang.Object

java.lang.Record

org.maxicp.search.blackbox.ModelingBlackBox.Result

Record Components:

status - overall search status

solution - incumbent values for decision variables when one exists

objectiveValue - incumbent objective value for optimization models

varValues - mapping of model integer variables to their incumbent values

Enclosing class:

ModelingBlackBox

public static record ModelingBlackBox.Result(SearchStatus status, Optional<List<Integer>> solution, Optional<Integer> objectiveValue, Map<IntExpression,Integer> varValues)
extends Record

Final outcome returned by ModelingBlackBox.solve(org.maxicp.ModelDispatcher, int) and ModelingBlackBox.optimize(org.maxicp.ModelDispatcher, org.maxicp.modeling.symbolic.Objective, int).

Constructor Summary

Constructors

Constructor	Description
Result(SearchStatus status, Optional<List<Integer>> solution, Optional<Integer> objectiveValue)
Result(SearchStatus status, Optional<List<Integer>> solution, Optional<Integer> objectiveValue, Map<IntExpression,Integer> varValues)	Creates an instance of a Result record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<Integer>	objectiveValue()	Returns the value of the objectiveValue record component.
Optional<List<Integer>>	solution()	Returns the value of the solution record component.
SearchStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
Optional<Integer>	value(IntExpression expr)	Returns the value of expr in the best incumbent solution, if available.
Optional<List<Integer>>	values(IntExpression... vars)	Returns the values of vars in the best incumbent solution, if available.
Map<IntExpression,Integer>	varValues()	Returns the value of the varValues record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Result

public Result(SearchStatus status,
 Optional<List<Integer>> solution,
 Optional<Integer> objectiveValue,
 Map<IntExpression,Integer> varValues)

Creates an instance of a Result record class.

Parameters:

status - the value for the status record component

solution - the value for the solution record component

objectiveValue - the value for the objectiveValue record component

varValues - the value for the varValues record component

Result

public Result(SearchStatus status,
 Optional<List<Integer>> solution,
 Optional<Integer> objectiveValue)

Method Details

value

public Optional<Integer> value(IntExpression expr)

Returns the value of expr in the best incumbent solution, if available.

values

public Optional<List<Integer>> values(IntExpression... vars)

Returns the values of vars in the best incumbent solution, if available.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

status

public SearchStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

solution

public Optional<List<Integer>> solution()

Returns the value of the solution record component.

Returns:

the value of the solution record component

objectiveValue

public Optional<Integer> objectiveValue()

Returns the value of the objectiveValue record component.

Returns:

the value of the objectiveValue record component

varValues

public Map<IntExpression,Integer> varValues()

Returns the value of the varValues record component.

Returns:

the value of the varValues record component