localsolver

Interface LSFunction

public interface LSFunction

Function interface. This particular interface is used to instanciate LSOperator.Function in LocalSolver. A function is a particular LSExpression composed of two parts:

• The arguments of the function (which are also LSExpression of type LSOperator.Argument.
• The body of the function. The body is an LSExpression that will be used to evaluate the result of the function. The body can be any LSExpression composed of any operands and operators supported by LocalSolver.

Since:

7.0

Method Summary

Modifier and Type	Method and Description
LSExpression	call(LSExpression[] arguments) Evaluate and returns the body of the function.

Method Detail

call

LSExpression call(LSExpression[] arguments)

Evaluate and returns the body of the function. This particular method will be called by LSModel.createFunction(int, localsolver.LSFunction) with an array of LSExpression of type LSOperator.Argument. The size of the array will depend on the number of arguments you want for your function. The number of arguments is specified when you call the LSModel.createFunction(int, localsolver.LSFunction). Your implementation must return an LSExpression that will be used as the body of your LocalSolver function.