localsolver

Interface LSDoubleArrayBlackBoxFunction

public interface LSDoubleArrayBlackBoxFunction

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

1. Implement the LSDoubleArrayBlackBoxFunction interface with the call method. The call method must take a LSBlackBoxArgumentValues and must return a double array 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.createDoubleArrayBlackBoxFunction(localsolver.LSDoubleArrayBlackBoxFunction) or the dedicated shortcut LSModel.doubleArrayBlackBoxFunction(localsolver.LSDoubleArrayBlackBoxFunction).
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 the maximum number of evaluations) with the help of the LSBlackBoxContext associated with the function (see LSExpression.getBlackBoxContext()).

Since:

11.0

Method Summary

Modifier and Type	Method and Description
double[]	call(LSBlackBoxArgumentValues argumentValues) The function to call.

Method Detail

call

double[] 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.