localsolverblackbox

Class LocalSolverBlackBox

java.lang.Object

localsolverblackbox.LocalSolverBlackBox

public class LocalSolverBlackBox
extends java.lang.Object

LocalSolverBlackBox environment. Main class of LocalSolverBlackBox library. Here are described the basic steps for using LocalSolverBlackBox:

1. Build your model (LSBBModel) by creating some expressions (LSBBExpression).
2. If desired, parameterize the solver (LSBBParam).
3. Run the solver (LocalSolverBlackBox).
4. Retrieve the best solution found by the solver (LSBBSolution).

Note that this API is not thread safe. If multiple threads access and modify a same LocalSolver environment, it must be synchronized. The only methods that can be used without synchronization are getState() and stop().

Constructor Summary

Constructors

Constructor and Description
LocalSolverBlackBox()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Delete the LocalSolverBlackBox objects and release the licence token.
boolean	equals(java.lang.Object obj)
LSBBModel	getModel() Gets the model associated to this LocalSolverBlackBox environment.
LSBBParam	getParam() Gets the parameters of this LocalSolverBlackBox environment.
LSBBSolution	getSolution() Gets the best solution found by the solver.
LSBBState	getState() Gets the state of this LocalSolverBlackBox environment.
int	hashCode()
void	solve() Solves the model.
void	stop() Aborts the resolution previously launched using solve().
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalSolverBlackBox

public LocalSolverBlackBox()

Method Detail

delete

public void delete()

Delete the LocalSolverBlackBox objects and release the licence token. Calling this method is necessary for deleting the native memory used by LocalSolverBlackBox and making the LocalSolverBlackBox licence available for another LocalSolverBlackBox model.

getState

public LSBBState getState()

Gets the state of this LocalSolverBlackBox environment. This method can be called in any state. In particular, this method can be called in state LSBBState.Running.

Returns:

State of LocalSolverBlackBox.

getModel

public LSBBModel getModel()

Gets the model associated to this LocalSolverBlackBox environment. Once the model is created and closed, the solver can be launched with solve().

Returns:

Model.

getParam

public LSBBParam getParam()

Gets the parameters of this LocalSolverBlackBox environment.

Returns:

Parameters.

solve

public void solve()

Solves the model. This method returns only when the time limit or the evaluation limit are reached. The model must be closed to launch the resolution.

stop

public void stop()

Aborts the resolution previously launched using solve(). If no resolution was launched, this method does nothing. Called from another thread, this method enables users to stop the resolution properly. Solution remains valid. This method can be called in any state, notably in state LSBBState.Running.

getSolution

public LSBBSolution getSolution()

Gets the best solution found by the solver. If the solver has not been started at least once, all the decision variables of the solution are set to 0 (such a solution may be infeasible). Only allowed in states LSBBState.Paused or LSBBState.Stopped.

Returns:

Best solution.

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