Name

CheckDimProp — C interface function which checks the comatibility between 2 arguments send to the C function

Calling Sequence

CheckColumn(StackPos_var1,StackPos_var2,expression)

Parameters

StackPos_var1

the position in the Scilab memory of the first parameter for which we want to perform the check (input parameter)

StackPos_var2

the position in the Scilab memory of the second variable for which we want to perform the check (input parameter)

expression

a boolean expression which represent the size check we want to perform

Description

C interface function which checks the compatibility between 2 arguments send to the C function. You must include stack-c.h to benefit from this function. If the test fails, we return from the C interface and an adequate error message is printed in the Scilab console.

WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use API Scilab (the new Scilab API).

Examples

 
#include <stack-c.h>

int sci_check_properties(char * fname)
{
  int m1, n1, l1;
  int m2, n2, l2;

  CheckRhs(2,2);

  GetRhsVar(1, "d", &m1, &n1, &l1);
  GetRhsVar(2, "d", &m2, &n2, &l2);

  // Check compatibility beetween arg 1 and arg 2. We want m1*n1 == n2 
  CheckDimProp(1,2, m1 * n1 != n2); 

  return 0;
}
 

See Also

CheckColumn, CheckDims, CheckRow, CheckScalar, CheckVector, CheckOverLoad, CheckLength, CheckSameDims, CheckSquare, How to check parameters