LSNativeFunction Interface

class localsolver::LSNativeFunction

Native function interface.

To use your own native functions within LocalSolver, you have to proceed in 3 steps:

  1. Implement the LSNativeFunction interface with the call method. The call method must take the native context associated to the function and must return a double value. This native context contains the values of the expressions passed to the function. A distinction is made between integer arguments (bool, int) and floating point arguments (double).
  2. Instanciate the function as an LSExpression with LSModel#createNativeFunction or the dedicated shortcut LSModel#function.
  3. Pass arguments to your function and call it. For that, you have to create expressions of type O_Call. The first operand must be your native function. The other operands must be LSExpressions. 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 S_Running. Do not attempt to call any method of the solver (to retrieve statistics, values of LSExpressions or whatever) in that state or an exception will be thrown. The only accessible function is LocalSolver#stop().

Note 2: Your functions must be thread-safe. According to the “nbThreads” parameter, LocalSolver can be multi-threaded. In that case, your native functions must be thread safe. If you cannot guarantee the thread-safety of your code, we strongly recommend you to limit the search of LocalSolver to one thread with LSParam#setNbThreads.

Note 3: You have to free the memory of the native functions you created. LocalSolver does not manage memory of objects created outside of its environment.



call The function to call.


virtual lsdouble call(const LSNativeContext &context) = 0

The function to call.

The native context contains the arguments to pass to your function.

Return:The value of the LSExpression.
Parameters:context - Native context containing the arguments of the function.