fmincon_checkrhs API Functions fmincon_checksquare

Fmincon Toolbox >> Fmincon Toolbox > API Functions > fmincon_checkscalar

fmincon_checkscalar

Generates an error if the variable is not a scalar.

Calling Sequence

errmsg = fmincon_checkscalar ( funname , var , varname , ivar )

Parameters

funname :

a 1 x 1 matrix of strings, the name of the calling function.

var :

a 1 x 1 matrix of valid Scilab data type, the variable

varname :

a 1 x 1 matrix of string, the name of the variable

ivar :

a 1 x 1 matrix of floating point integers, the index of the input argument in the calling sequence

errmsg :

a 1 x 1 matrix of strings, the error message. If there was no error, the error message is the empty matrix.

Description

This function is designed to be used to design functions where the input argument is a scalar, that is, a matrix for which and(size(var) == [1 1]). This function cannot be use when var is a function, or more generally, for any input argument for which the size function does not work.

Examples

// The function takes a scalar of double.
function y=myfunction(x)
fmincon_checkscalar ( "myfunction" , x , "x" , 1 )
y = x
endfunction
// Calling sequences which work
y = myfunction ( 1 )
y = myfunction ( 0 )
// Calling sequences which generate an error
y = myfunction ( ones(2,3) )
y = myfunction ( zeros(1,2) )

Authors

fmincon_checkrhs API Functions fmincon_checksquare