Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: English - Fran├žais - Portugu├¬s -

Please note that the recommended version of Scilab is 6.0.1. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab help >> API Scilab > Scilab Gateway API > CheckDimProp

CheckDimProp

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

Calling Sequence

CheckColumn(StackPos_var1,StackPos_var2,expression)

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 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 — C interface function which checks if a parameter send to the C function is a column vector or not
  • CheckDims — C interface function which checks if a parameter send to the C function has the required dimensions
  • CheckRow — C interface function which checks if a parameter send to the C function is a row vector or not
  • CheckScalar — C interface function which checks if a parameter send to the C function is a scalar or not
  • CheckVector — C interface function which checks if a parameter send to the C function is a vector (column or row) or not
  • CheckOverLoad — C gateway function which tells Scilab to look for another overloaded function
  • CheckLength — C interface function which checks the length of a vector send as a parameter to the C function
  • CheckSameDims — C interface function which checks if two parameters send to the C function have the same size
  • CheckSquare — C interface function which checks if a parameter send to the C function is a square matrix or not
  • How to check parameters — how to check parameter send to an interface using the C gateway functions
Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Thu Mar 03 11:01:00 CET 2011