Interface to Scilab's Core

function CheckRhs
    (FunctionName    : in String;
     MinNumParameter : in Integer;
     MaxNumParameter : in Integer)
    return Boolean;

Check the number of actual parameters on the right-hand side to be in the range MinNumParameter : MaxNumParameter. Return true if it is in the range, otherwise raise error 77 associated with FunctionName.

Note that a function that is called without any parameters, i.e. Foo(), gets an Rhs of -1.

The semantics of CheckRhs are slightly goofy. If the number of actual input parameters is in the specified range, CheckRhs returns True, but it never returns False as it raises an error in this case.

Ensure that at least 2, but not more than 5 parameters are passed to the function:

      if (.not. checkrhs(fname, 2, 5)) return
            

We have assumed that fname is set to the function's name.

CheckLhs, Rhs, Lhs

function CheckLhs
    (FunctionName    : in String;
     MinNumParameter : in Integer;
     MaxNumParameter : in Integer)
    return Boolean;

Check the number of output variables, i.e. arguments on the right-hand side to be in the range MinNumParameter : MaxNumParameter. Return true if it is in the range, otherwise raise error 78 associated with FunctionName.

Note that it is no error to supply less output parameters than the function actually yields. The extra values are silently discarded. This is true for the case of zero output values, too; then ans gets the first output value. So, a function called without any output parameters gets an Lhs of 1.

The semantics of CheckLhs are slightly goofy. If the number of actual output parameters is in the specified range, CheckLhs returns True, but it never returns False as it raises an error in this case.

Ensure that there are not more than 2 output parameters, when the function is called:

      if (.not. checklhs(fname, 1, 2)) return
            

We have assumed that fname is set to the function's name.

CheckRhs, Rhs, Lhs

Lhs : Integer

The number of actual output parameters (i.e. those on the left-hand side of the assignment operator) is stored in the global variable Lhs.

CheckLhs, CheckRhs, Rhs

Rhs : Integer

The number of actual input parameters (i.e. those on the right-hand side of the assignment operator) is stored in the global variable Rhs.

CheckLhs, CheckRhs, Lhs

function GetMat
    (FunctionName   : in     String;
     BasePointer    : in     ParameterStackAddress;
     StackPointer   : in     ParameterStackAddress;
     IsComplex      :    out ComplexFlag;
     Rows           :    out Natural;
     Columns        :    out Natural;
     RealIndex      :    out DataStackIndex;
     ImaginaryIndex :    out DataStackIndex)
    return Boolean;

Retrieve the address(es) and dimensions of a real or complex matrix from the parameter stack. The BasePointer must be set to the parameter stack pointer's value on entry of the calling function. StackPointer points to the desired parameter on the parameter stack. If successful, GetMat returns True, and IsComplex, Rows, Columns, and RealIndex have valid values. If IsComplex = ComplexVariable then ImaginaryIndex is valid, too. If the parameter indexed by StackPointer is not a matrix then GetMat returns False.

The output parameter IsComplex indicates whether the matrix on the data stack is purely real or complex. In the first case RealIndex points to the matrix, in the second case RealIndex points to the real part of matrix, and ImaginaryIndex points to the imaginary part. In any case Rows and Columns are the number of rows and columns in the matrix.

Fetch the addresses of a possible complex m times n matrix from position top of the parameter stack.

      if (.not. getmat(fname, topk, top, iscmpx, m, n, are, aim)) return
            

It is assumed that fname has been set to the function's name, and topk carries the position of the stack on entry to the calling function.

GetRMat, GetRVect, GetVect

function GetRMat
    (FunctionName   : in     String;
     BasePointer    : in     ParameterStackAddress;
     StackPointer   : in     ParameterStackAddress;
     Rows           :    out Natural;
     Columns        :    out Natural;
     RealIndex      :    out DataStackIndex)
    return Boolean;

function GetRVect
    (FunctionName   : in     String;
     BasePointer    : in     ParameterStackAddress;
     StackPointer   : in     ParameterStackAddress;
     Rows           :    out Natural;
     Columns        :    out Natural;
     RealIndex      :    out DataStackIndex)
    return Boolean;

function GetVect
    (FunctionName   : in     String;
     BasePointer    : in     ParameterStackAddress;
     StackPointer   : in     ParameterStackAddress;
     IsComplex      :    out ComplexFlag;
     Rows           :    out Natural;
     Columns        :    out Natural;
     RealIndex      :    out DataStackIndex;
     ImaginaryIndex :    out DataStackIndex)
    return Boolean;

function GetScalar
    (FunctionName   : in     String;
     BasePointer    : in     ParameterStackAddress;
     StackPointer   : in     ParameterStackAddress;
     Index          :    out DataStackIndex)
    return Boolean;

function CreMat
    (FunctionName   : in     String;
     StackPointer   : in     ParameterStackAddress;
     WantComplex    : in     ComplexFlag;
     Rows           : in     Natural;
     Columns        : in     Natural;
     RealIndex      :    out DataStackIndex;
     ImaginaryIndex :    out DataStackIndex)
    return Boolean;