localsolver.modeler

Interface LSPFunctor

public interface LSPFunctor

External modeler function interface. To use your own external functions in the modeler, you have to follow these steps :

• Implement the LSPFunctor interface with the call method.
• Then create a LSPFunction with LSPModeler.createFunction(java.lang.String, localsolver.modeler.LSPFunctor).
• Finally, if you want to make this function available in your LSP code, you have to assign it to a module variable with LSPModule.setFunction(java.lang.String, localsolver.modeler.LSPFunction).

Note: This class should only be implemented to expose functions used during the modeling process. You should not use this class to create a function that will be called during the resolution as an external function. In this case, you should instead use the solver API directly (see LSIntExternalFunction or LSDoubleExternalFunction).

Since:

10.0

See Also:

LSPFunction

Method Summary

Modifier and Type	Method and Description
LSPValue	call(LSPModeler modeler, java.util.List<LSPValue> arguments) The function to call with its arguments.

Method Detail

call

LSPValue call(LSPModeler modeler,
              java.util.List<LSPValue> arguments)

The function to call with its arguments.

Parameters:

modeler - Modeler instance.

arguments - List of modeler values passed to the function by the caller.

Returns:

Return value of the call.