localsolver

Interface LSIntBlackBoxFunction

public interface LSIntBlackBoxFunction

Integer black-box function interface. To use integer black-box functions with LocalSolver, you have to proceed in 3 steps:

1. Implement the LSIntBlackBoxFunction interface with the call method. The call method must take a LSBlackBoxArgumentValues and must return an integer value. The argument values contain the values of the expressions passed to the function. A distinction is made between integer arguments (bool, int) and floating point arguments (double).
2. Instantiate the function as an LSExpression with LSModel.createIntBlackBoxFunction(localsolver.LSIntBlackBoxFunction) or the dedicated shortcut LSModel.intBlackBoxFunction(localsolver.LSIntBlackBoxFunction).
3. Pass arguments to your function and call it. For that, you have to create expressions of type LSOperator.Call. The first operand must be your black-box function. The other operands must be LSExpressions. Their value will be made accessible to your black-box function through the LSBlackBoxArgumentValues.

Note: You can provide additional data for your function (such as bounds or the maximum number of evaluations) with the help of the LSBlackBoxContext associated with the function (see LSExpression.getBlackBoxContext()).

Since:

10.0

Method Summary

Modifier and Type	Method and Description
long	call(LSBlackBoxArgumentValues argumentValues) The function to call.

Method Detail

call

long call(LSBlackBoxArgumentValues argumentValues)

The function to call. The argument values contain the arguments to pass to your function.

Parameters:

argumentValues - Argument values containing the arguments of the function.

Returns:

The value of the LSExpression.