localsolverblackbox

Class LSBBModel

java.lang.Object

localsolverblackbox.LSBBModel

public class LSBBModel
extends java.lang.Object

Mathematical optimization model. A model is composed of a native function (the blackbox), a number of decisions and a function call that associates the decisions and the function. Once your optimization model is created and closed, the solver can be launched to resolve it. Note that you cannot modify a model which has been closed.

See Also:

LSBBExpression, LSBBOperator

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjective(LSBBExpression expr, LSBBObjectiveDirection direction) Sets the given expression to the current objective to optimize.
LSBBExpression	boolVar() Creates a boolean decision.
LSBBExpression	call() Creates a call expression.
void	close() Closes the model.
LSBBExpression	createNativeFunction(LSBBNativeFunction func) Creates a native function.
boolean	equals(java.lang.Object obj)
LSBBExpression	floatVar(double min, double max) Creates a float decision.
LocalSolverBlackBox	getLocalSolverBlackBox() Returns the LocalSolverBlackBox object associated to this model.
int	hashCode()
LSBBExpression	intVar(long min, long max) Creates an integer decision.
boolean	isClosed() Returns true if the model is closed, false otherwise.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLocalSolverBlackBox

public LocalSolverBlackBox getLocalSolverBlackBox()

Returns the LocalSolverBlackBox object associated to this model.

Returns:

LocalSolverBlackBox object.

createNativeFunction

public LSBBExpression createNativeFunction(LSBBNativeFunction func)

Creates a native function. Once you instanciated it, you have to pass arguments to your function and call it. For that, you have to create expressions of type LSBBOperator.Call. The first operand must be your native function. The other operands must be LSBBExpressions. Their value will be made accessible to your native function through the native context.

Note 1: Most of the time your native function will be called when the solver is in state LSBBState.Running. Do not attempt to call any method of the solver (to retrieve statistics, values of LSBBExpressions or whatever) in that state or an exception will be thrown. The only accessible function is LocalSolverBlackBox.stop().

Parameters:

func - Native function to call.

Returns:

The expression associated to the function.

See Also:

LSBBOperator.NativeFunction

call

public LSBBExpression call()

Creates a call expression.

See Also:

LSBBOperator.Call

boolVar

public LSBBExpression boolVar()

Creates a boolean decision. Binary decision variable with domain [0.1].

See Also:

LSBBOperator.Bool

floatVar

public LSBBExpression floatVar(double min,
                      double max)

Creates a float decision. Decision variable with domain [min,max].

See Also:

LSBBOperator.Float

intVar

public LSBBExpression intVar(long min,
                    long max)

Creates an integer decision. Decision variable with domain [min,max].

See Also:

LSBBOperator.Int

addObjective

public void addObjective(LSBBExpression expr,
                LSBBObjectiveDirection direction)

Sets the given expression to the current objective to optimize. Only allowed in state LSBBState.Modeling.

Parameters:

expr - Expression of type LSBBOperator.Call.

direction - Optimization direction of this objective.

close

public void close()

Closes the model. Only allowed in state LSBBState.Modeling. Once the model is closed, no expression, constraints or objectives can be added. The model must be closed before starting its resolution.

isClosed

public boolean isClosed()

Returns true if the model is closed, false otherwise.

Returns:

True if the model is closed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object