Check that the value is in a given range.
errmsg = fmincon_checkrange ( funname , var , varname , ivar , expectedopt )
a 1 x 1 matrix of strings, the name of the calling function.
a 1 x 1 matrix of valid Scilab data type, the variable
a 1 x 1 matrix of string, the name of the variable
a 1 x 1 matrix of floating point integers, the index of the input argument in the calling sequence
a matrix of values, the minimum value for the variable #ivar
a matrix of values, the maximum value for the variable #ivar
a 1 x 1 matrix of strings, the error message. If there was no error, the error message is the empty matrix.
This function is designed to be used to design functions where an input argument is expected to be greater or equal to a threshold. The error is generated if the condition and ( vmin <= var & var <= vmax ) is false. This function can be used for whatever variable type for which the comparison "<=" can be evaluated.
// The function takes an argument x such that 0<= x <=1. function y=myfunction(x) fmincon_checkrange ( "myfunction" , x , "x" , 1 , 0 , 1 ) y = sqrt(1-x) endfunction // Calling sequences which work myfunction ( [0.1 0.2 0.8] ) // Calling sequences which generate an error myfunction ( [-0.1 0.2 0.8] ) myfunction ( [0.1 0.2 1.8] ) | ![]() | ![]() |