This page is for an old version of Hexaly Optimizer.
We recommend that you update your version and read the documentation for the
latest stable release.
LSPFunctor Interface¶
-
class
LSPFunctor
¶ External modeler function interface. To use your own external functions in the modeler you have to follow these steps:
- Implement this interface with the call method.
- Then create a
LSPFunction
withLSPModeler::createFunction()
. - 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()
.
Note: This class should only be extended 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
localsolver::LSExternalFunction
).See: LSPFunction
Since: 10.0
Summary¶
call |
The function to call with its arguments. |
~LSPFunctor |
Default virtual destructor. |
Functions¶
-
virtual LSPValue
call
(LSPModeler &modeler, const LSPValue *arguments, int nbArguments) = 0¶ The function to call with its arguments.
Parameters: - modeler – Modeler instance.
- arguments – List of modeler values passed to the function by the caller.
- nbArguments – Number of arguments passed to the function by the caller.
Returns: Return value of the call.
-
virtual
LSPFunctor
::
~LSPFunctor
()¶ Default virtual destructor.