CheckSameDims

Arguments

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 parameter for which we want to perform the check (input parameter)

m_var1

the number of lines of the parameter at position StackPos_var1 in the Scilab memory

n_var1

the number of columns of the parameter at position StackPos_var1 in the Scilab memory

m_var2

the number of lines of the parameter at position StackPos_var2 in the Scilab memory

n_var2

the number of columns of the parameter at position StackPos_var2 in the Scilab memory

Description

C interface function which checks if two parameters send to the C function have the same size. 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

In this example, the C interface function takes one input parameters and prints the integer corresponding to the type of the variable sent as parameter in the Scilab console.

#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);

  CheckSameDims(1,2,m1,n1,m2,n2); // Check that both vectors have the same size

  return 0;
}

See Also

• CheckColumn
• CheckDims
• CheckRow
• CheckScalar
• CheckVector
• CheckOverLoad
• CheckDimProp
• CheckLength
• CheckSquare
• How to check parameters