Purpose
Include an SLP or user function in an expression
Synopsis
Func (fName:string [, arg1:real|mpvar|linctr|XV|gexp
[, arg2:real|mpvar|linctr|XV|gexp]] [, rIndex:string]) :gexp
Arguments
|
fName
|
string containing the name of the function being evaluated. This can be
an Xpress-SLP internal function or a user-defined function
|
|
arg1
|
(optional) first argument to the function. This can be of any type (real,
mpvar or expression) acceptable to the function. Arguments of type XV are
always acceptable, provided the items in the XV are of the correct type
|
|
arg2
|
(optional) second argument to the function. The requirements are the
same as for arg1
|
|
rIndex
|
(optional) string indicating the index or name of the return value
from the function. This is only required when the function returns an array of values
|
Return value
For most purposes, Func can be regarded as returning a gexp
which contains the requested evaluation of the function.
Strictly speaking, Func returns a gexp describing how to call the specified
function, and the evaluation of the function then returns a real value.
Further information
Related topics
If you have any comments or suggestions about these pages,
please send mail to docs@dashoptimization.com.