Initializing help system before first use

XSLPgetfunctioninstance

XSLPgetfunctioninstance


Purpose
Retrieve the base signature of a user function instance
Synopsis
int XPRS_CC XSLPgetfunctioninstance(XSLPprob Prob, int Instance, int *nSLPUF, int BufferSize, int *TokenCount, int *Type, double *Value)
Arguments
Prob 
The current SLP problem.
Instance 
The function instance to retrieve.
nSLPUF 
The base user function the instance has been instantiated from.
BufferSize 
Maximum number of tokens to return, i.e. length of the Type and Value arrays.
TokenCount 
Number of tokens returned in Type and Value.
Type 
Array to receive token types for the formula.
Value 
Array to receive values corresponding to the types in Type.
Further information

If any of the addresses is NULL the corresponding information will not be returned.

Instances are counted from 1 to XSLP_UFINSTANCES.

Functions are instantiated by XSLPconstruct, and are only available for interrogation after the problem has been augmented.

The array of Tokens are return in reversed Polish order.

Always the full signature will be returned. Please note, that for functions returning named returns, a colon and a corresponding return string will also be returned, but only one of the possible returns (i.e. the different types of occurrences of the same instance are not collected).

The function can be used to identify the different function instances that are created.


Related topics