add more help pages related to CAPI - check parameters - optional parameters
[scilab.git] / scilab / modules / core / examples / capi / check_properties / check_properties.c
1 #include <stack-c.h>
2 #include <sciprint.h>
3
4 int sci_check_properties_1(char * fname)
5 {
6   int m1, n1, l1;
7   int m2, n2, l2;
8   int m3, n3, l3;
9   int m4, n4, l4;
10   int m5, n5, l5;
11
12   CheckRhs(5,5);
13   CheckLhs(0,1) ;
14
15   ////////////////////////////
16   // Getting first argument //
17   ////////////////////////////
18
19   GetRhsVar(1, "d", &m1, &n1, &l1);
20
21   CheckVector(1,m1,n1);   // Check that first argument is a vector
22   CheckLength(1,m1*n1,4); // Check vector length
23   
24   /////////////////////////////
25   // Getting second argument //
26   /////////////////////////////
27
28   GetRhsVar(2, "d", &m2, &n2, &l2);
29
30   CheckRow(2,m2,n2); // Checks that second argument is a row vector
31                      // CheckColumn can also be used
32
33   CheckDimProp(1,2, m1 * n1 != n2); // Check compatibility beetween arg 1 and arg 2. We want m1*n1 == n2 
34
35   ////////////////////////////
36   // Getting third argument //
37   ////////////////////////////
38
39   GetRhsVar(3, "d", &m3, &n3, &l3);
40
41   CheckSameDims(1,3,m1,n1,m3,n3); // Checks that arg 1 and arg3 have same dimensions
42
43   /////////////////////////////
44   // Getting fourth argument //
45   /////////////////////////////
46
47   GetRhsVar(4,"d",&m4,&n4,&l4);
48   
49   CheckScalar(4,m4,n4); // arg 4 must be scalar
50
51   /////////////////////////////
52   // Getting fourth argument //
53   /////////////////////////////
54
55   GetRhsVar(5,"d",&m5,&n5,&l5);
56   
57   CheckSquare(5,m5,n5);   // square matrix
58   CheckDims(5,m5,m5,5,5); // check dimensions
59
60   LhsVar(1)=0;
61
62   return 0;
63 }
64
65 // We must be careful on the scilab name function (8 chars max).
66
67 int sci_check_properties_2(char * fname)
68 {
69   int m1,n1,l1;
70
71   CheckRhs(1,1);
72   CheckLhs(0,1) ;
73
74   switch(VarType(1)) 
75     {
76     case 1: 
77       GetRhsVar(1, "d", &m1, &n1, &l1);
78       sciprint("1 is a scalar matrix\n");
79       break;
80     case 10:
81       GetRhsVar(1, "c", &m1, &n1, &l1);
82       sciprint("1 is a string\n");
83       break;
84     case 5:
85       sciprint("1 is a sparse trying to overload\n");
86       OverLoad(1);
87     }
88
89   LhsVar(1) = 0;
90
91   return 0;
92 }