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.

HxmFunctor Interface

class HxmFunctor

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

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 optimizer API directly (see HxExternalFunction).

See:

HxmFunction

Since:

10.0

Summary

Functions

call

The function to call with its arguments.

~HxmFunctor

Default virtual destructor.

Functions

virtual HxmValue call(HexalyModeler &modeler, const HxmValue *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 HxmFunctor::~HxmFunctor()

Default virtual destructor.