From 96edee02e6414bf26b21420405cfc299f85683d3 Mon Sep 17 00:00:00 2001 From: KRIXUS-alpha Date: Wed, 12 May 2021 20:15:09 +0530 Subject: documentation struct data handling --- doc/html/src_2fun_8h_source.html | 137 ++++++++++++++++++++++++--------------- 1 file changed, 84 insertions(+), 53 deletions(-) (limited to 'doc/html/src_2fun_8h_source.html') diff --git a/doc/html/src_2fun_8h_source.html b/doc/html/src_2fun_8h_source.html index db54e52..3e00205 100644 --- a/doc/html/src_2fun_8h_source.html +++ b/doc/html/src_2fun_8h_source.html @@ -112,62 +112,93 @@ $(document).ready(function(){initNavTree('src_2fun_8h_source.html',''); initResi
13 //extern "C" int fun (double* answ, double* in1, int in1_row, std::string name, std::string opt);
14 
15 extern "C"
-
16 {
+
16 {
17 
-
18  typedef enum
-
19  {
-
20  TYPE_DOUBLE,
-
21  TYPE_STRING,
-
22  }FUNCTYPE;
-
23 
-
24  typedef struct
-
25  {
-
26  FUNCTYPE type;
-
27  int n_in_rows;
-
28  int n_in_cols;
-
29  int n_out_rows;
-
30  int n_out_cols;
-
31  int is_in_cmplx;
-
32  int is_out_cmplx;
-
33  void* in_data_real;
-
34  void* in_data_img;
-
35  void* out_data_real;
-
36  void* out_data_img;
-
37  }FUNCARGS;
-
38 
-
39  typedef struct {
-
40  int n_in_arguments; // number of input arguments
-
41  int n_out_arguments; // number of output arguments
-
42  int n_out_user; // number of output arguments
-
43  char *err; // Name
-
44  //char *package; //Name of octave package to be loaded
-
45  FUNCARGS *argument;
-
46 } FUNCCALL;
-
47 
-
48  int fun(FUNCARGS *arr, FUNCCALL *call);
-
49 }
+
18 
+
19  typedef enum {
+
20  TYPE_DOUBLE,
+
21  TYPE_COMPLEX,
+
22  TYPE_STRING,
+
23  TYPE_STRUCT,
+
24  }FUNCTYPE;
+
25 
+
32  typedef struct {
+
33  FUNCTYPE type;
+
34  void* key;
+
35  int rows;
+
36  int cols;
+
37  void* dataReal;
+
38  void* dataImg;
+
39  void* str;
+
41  } FUNCSTRUCT;
+
42 
+
48  typedef struct {
+
50  FUNCTYPE type;
+
51  int n_in_rows;
+
52  int n_in_cols;
+
53  int n_in_struct_len;
+
54  int n_out_rows;
+
55  int n_out_cols;
+
56  int n_out_struct_len;
+
57  int is_in_cmplx;
+
58  int is_out_cmplx;
+
59  int is_out_struct;
+
60  int is_out_string;
+
61  void* in_data_real;
+
62  void* in_data_img;
+
63  void* out_data_real;
+
64  void* out_data_img;
+
65  FUNCSTRUCT* in_struct;
+
66  FUNCSTRUCT* out_struct;
+
68  } FUNCARGS;
+
73  typedef struct {
+
75  int n_in_arguments;
+
76  int n_out_arguments;
+
77  int n_out_user;
+
78  char *err;
+
79  //char *package; //Name of octave package to be loaded*/
+
80  FUNCARGS *argument;
+
82  } FUNCCALL;
+
91  int fun(FUNCARGS *arr, FUNCCALL *call);
+
92 }
FUNCTYPE
FUNCTYPE
Definition: fun.h:19
TYPE_DOUBLE
@ TYPE_DOUBLE
Definition: fun.h:20
-
TYPE_STRING
@ TYPE_STRING
Definition: fun.h:21
-
fun
int fun(FUNCARGS *arr, FUNCCALL *call)
Function to Interact with Octave's API.
Definition: fun.cpp:29
-
FUNCARGS
Definition: fun.h:25
-
FUNCARGS::out_data_img
void * out_data_img
Definition: fun.h:36
-
FUNCARGS::n_out_cols
int n_out_cols
Definition: fun.h:30
-
FUNCARGS::out_data_real
void * out_data_real
Definition: fun.h:35
-
FUNCARGS::is_out_cmplx
int is_out_cmplx
Definition: fun.h:32
-
FUNCARGS::n_in_rows
int n_in_rows
Definition: fun.h:27
-
FUNCARGS::n_in_cols
int n_in_cols
Definition: fun.h:28
-
FUNCARGS::type
FUNCTYPE type
Definition: fun.h:26
-
FUNCARGS::is_in_cmplx
int is_in_cmplx
Definition: fun.h:31
-
FUNCARGS::n_out_rows
int n_out_rows
Definition: fun.h:29
-
FUNCARGS::in_data_img
void * in_data_img
Definition: fun.h:34
-
FUNCARGS::in_data_real
void * in_data_real
Definition: fun.h:33
-
FUNCCALL
Definition: fun.h:39
-
FUNCCALL::n_in_arguments
int n_in_arguments
Definition: fun.h:40
-
FUNCCALL::n_out_arguments
int n_out_arguments
Definition: fun.h:41
-
FUNCCALL::argument
FUNCARGS * argument
Definition: fun.h:45
-
FUNCCALL::n_out_user
int n_out_user
Definition: fun.h:42
-
FUNCCALL::err
char * err
Definition: fun.h:43
+
TYPE_STRUCT
@ TYPE_STRUCT
Definition: fun.h:23
+
TYPE_COMPLEX
@ TYPE_COMPLEX
Definition: fun.h:21
+
TYPE_STRING
@ TYPE_STRING
Definition: fun.h:22
+
fun
int fun(FUNCARGS *arr, FUNCCALL *call)
API Function to call/receive and pass the data to fun API
Definition: fun.cpp:30
+
FUNCARGS
Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.
Definition: fun.h:48
+
FUNCARGS::out_data_img
void * out_data_img
Definition: fun.h:64
+
FUNCARGS::n_out_cols
int n_out_cols
Definition: fun.h:55
+
FUNCARGS::out_data_real
void * out_data_real
Definition: fun.h:63
+
FUNCARGS::is_out_struct
int is_out_struct
Definition: fun.h:59
+
FUNCARGS::is_out_cmplx
int is_out_cmplx
Definition: fun.h:58
+
FUNCARGS::n_in_struct_len
int n_in_struct_len
Definition: fun.h:53
+
FUNCARGS::n_out_struct_len
int n_out_struct_len
Definition: fun.h:56
+
FUNCARGS::n_in_rows
int n_in_rows
Definition: fun.h:51
+
FUNCARGS::n_in_cols
int n_in_cols
Definition: fun.h:52
+
FUNCARGS::type
FUNCTYPE type
Definition: fun.h:50
+
FUNCARGS::is_out_string
int is_out_string
Definition: fun.h:60
+
FUNCARGS::is_in_cmplx
int is_in_cmplx
Definition: fun.h:57
+
FUNCARGS::in_struct
FUNCSTRUCT * in_struct
Definition: fun.h:65
+
FUNCARGS::out_struct
FUNCSTRUCT * out_struct
Definition: fun.h:66
+
FUNCARGS::n_out_rows
int n_out_rows
Definition: fun.h:54
+
FUNCARGS::in_data_img
void * in_data_img
Definition: fun.h:62
+
FUNCARGS::in_data_real
void * in_data_real
Definition: fun.h:61
+
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:73
+
FUNCCALL::n_in_arguments
int n_in_arguments
Definition: fun.h:75
+
FUNCCALL::n_out_arguments
int n_out_arguments
Definition: fun.h:76
+
FUNCCALL::argument
FUNCARGS * argument
Definition: fun.h:80
+
FUNCCALL::n_out_user
int n_out_user
Definition: fun.h:77
+
FUNCCALL::err
char * err
Definition: fun.h:78
+
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:32
+
FUNCSTRUCT::type
FUNCTYPE type
Definition: fun.h:33
+
FUNCSTRUCT::str
void * str
Definition: fun.h:39
+
FUNCSTRUCT::rows
int rows
Definition: fun.h:35
+
FUNCSTRUCT::dataReal
void * dataReal
Definition: fun.h:37
+
FUNCSTRUCT::cols
int cols
Definition: fun.h:36
+
FUNCSTRUCT::key
void * key
Definition: fun.h:34
+
FUNCSTRUCT::dataImg
void * dataImg
Definition: fun.h:38
-- cgit From 884558103568b38503b5010253cdd9d02d001c70 Mon Sep 17 00:00:00 2001 From: KRIXUS-alpha Date: Wed, 12 May 2021 20:24:32 +0530 Subject: Updated Documentation Struct data handling --- doc/html/src_2fun_8h_source.html | 167 +++++++++++++++++++-------------------- 1 file changed, 83 insertions(+), 84 deletions(-) (limited to 'doc/html/src_2fun_8h_source.html') diff --git a/doc/html/src_2fun_8h_source.html b/doc/html/src_2fun_8h_source.html index 3e00205..e10560c 100644 --- a/doc/html/src_2fun_8h_source.html +++ b/doc/html/src_2fun_8h_source.html @@ -114,91 +114,90 @@ $(document).ready(function(){initNavTree('src_2fun_8h_source.html',''); initResi
15 extern "C"
16 {
17 
-
18 
-
19  typedef enum {
-
20  TYPE_DOUBLE,
-
21  TYPE_COMPLEX,
-
22  TYPE_STRING,
-
23  TYPE_STRUCT,
-
24  }FUNCTYPE;
-
25 
-
32  typedef struct {
-
33  FUNCTYPE type;
-
34  void* key;
-
35  int rows;
-
36  int cols;
-
37  void* dataReal;
-
38  void* dataImg;
-
39  void* str;
-
41  } FUNCSTRUCT;
-
42 
-
48  typedef struct {
-
50  FUNCTYPE type;
-
51  int n_in_rows;
-
52  int n_in_cols;
-
53  int n_in_struct_len;
-
54  int n_out_rows;
-
55  int n_out_cols;
-
56  int n_out_struct_len;
-
57  int is_in_cmplx;
-
58  int is_out_cmplx;
-
59  int is_out_struct;
-
60  int is_out_string;
-
61  void* in_data_real;
-
62  void* in_data_img;
-
63  void* out_data_real;
-
64  void* out_data_img;
-
65  FUNCSTRUCT* in_struct;
-
66  FUNCSTRUCT* out_struct;
-
68  } FUNCARGS;
-
73  typedef struct {
-
75  int n_in_arguments;
-
76  int n_out_arguments;
-
77  int n_out_user;
-
78  char *err;
-
79  //char *package; //Name of octave package to be loaded*/
-
80  FUNCARGS *argument;
-
82  } FUNCCALL;
-
91  int fun(FUNCARGS *arr, FUNCCALL *call);
-
92 }
-
FUNCTYPE
FUNCTYPE
Definition: fun.h:19
-
TYPE_DOUBLE
@ TYPE_DOUBLE
Definition: fun.h:20
-
TYPE_STRUCT
@ TYPE_STRUCT
Definition: fun.h:23
-
TYPE_COMPLEX
@ TYPE_COMPLEX
Definition: fun.h:21
-
TYPE_STRING
@ TYPE_STRING
Definition: fun.h:22
+
22  typedef enum {
+
23  TYPE_DOUBLE,
+
24  TYPE_COMPLEX,
+
25  TYPE_STRING,
+
26  TYPE_STRUCT,
+
27  }FUNCTYPE;
+
28 
+
35  typedef struct {
+
36  FUNCTYPE type;
+
37  void* key;
+
38  int rows;
+
39  int cols;
+
40  void* dataReal;
+
41  void* dataImg;
+
42  void* str;
+
44  } FUNCSTRUCT;
+
45 
+
51  typedef struct {
+
53  FUNCTYPE type;
+
54  int n_in_rows;
+
55  int n_in_cols;
+
56  int n_in_struct_len;
+
57  int n_out_rows;
+
58  int n_out_cols;
+
59  int n_out_struct_len;
+
60  int is_in_cmplx;
+
61  int is_out_cmplx;
+
62  int is_out_struct;
+
63  int is_out_string;
+
64  void* in_data_real;
+
65  void* in_data_img;
+
66  void* out_data_real;
+
67  void* out_data_img;
+
68  FUNCSTRUCT* in_struct;
+
69  FUNCSTRUCT* out_struct;
+
71  } FUNCARGS;
+
76  typedef struct {
+
78  int n_in_arguments;
+
79  int n_out_arguments;
+
80  int n_out_user;
+
81  char *err;
+
82  //char *package; //Name of octave package to be loaded*/
+
83  FUNCARGS *argument;
+
85  } FUNCCALL;
+
94  int fun(FUNCARGS *arr, FUNCCALL *call);
+
95 }
+
FUNCTYPE
FUNCTYPE
Enumeration for the data types suported.
Definition: fun.h:22
+
TYPE_DOUBLE
@ TYPE_DOUBLE
Definition: fun.h:23
+
TYPE_STRUCT
@ TYPE_STRUCT
Definition: fun.h:26
+
TYPE_COMPLEX
@ TYPE_COMPLEX
Definition: fun.h:24
+
TYPE_STRING
@ TYPE_STRING
Definition: fun.h:25
fun
int fun(FUNCARGS *arr, FUNCCALL *call)
API Function to call/receive and pass the data to fun API
Definition: fun.cpp:30
-
FUNCARGS
Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.
Definition: fun.h:48
-
FUNCARGS::out_data_img
void * out_data_img
Definition: fun.h:64
-
FUNCARGS::n_out_cols
int n_out_cols
Definition: fun.h:55
-
FUNCARGS::out_data_real
void * out_data_real
Definition: fun.h:63
-
FUNCARGS::is_out_struct
int is_out_struct
Definition: fun.h:59
-
FUNCARGS::is_out_cmplx
int is_out_cmplx
Definition: fun.h:58
-
FUNCARGS::n_in_struct_len
int n_in_struct_len
Definition: fun.h:53
-
FUNCARGS::n_out_struct_len
int n_out_struct_len
Definition: fun.h:56
-
FUNCARGS::n_in_rows
int n_in_rows
Definition: fun.h:51
-
FUNCARGS::n_in_cols
int n_in_cols
Definition: fun.h:52
-
FUNCARGS::type
FUNCTYPE type
Definition: fun.h:50
-
FUNCARGS::is_out_string
int is_out_string
Definition: fun.h:60
-
FUNCARGS::is_in_cmplx
int is_in_cmplx
Definition: fun.h:57
-
FUNCARGS::in_struct
FUNCSTRUCT * in_struct
Definition: fun.h:65
-
FUNCARGS::out_struct
FUNCSTRUCT * out_struct
Definition: fun.h:66
-
FUNCARGS::n_out_rows
int n_out_rows
Definition: fun.h:54
-
FUNCARGS::in_data_img
void * in_data_img
Definition: fun.h:62
-
FUNCARGS::in_data_real
void * in_data_real
Definition: fun.h:61
-
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:73
-
FUNCCALL::n_in_arguments
int n_in_arguments
Definition: fun.h:75
-
FUNCCALL::n_out_arguments
int n_out_arguments
Definition: fun.h:76
-
FUNCCALL::argument
FUNCARGS * argument
Definition: fun.h:80
-
FUNCCALL::n_out_user
int n_out_user
Definition: fun.h:77
-
FUNCCALL::err
char * err
Definition: fun.h:78
-
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:32
-
FUNCSTRUCT::type
FUNCTYPE type
Definition: fun.h:33
-
FUNCSTRUCT::str
void * str
Definition: fun.h:39
-
FUNCSTRUCT::rows
int rows
Definition: fun.h:35
-
FUNCSTRUCT::dataReal
void * dataReal
Definition: fun.h:37
-
FUNCSTRUCT::cols
int cols
Definition: fun.h:36
-
FUNCSTRUCT::key
void * key
Definition: fun.h:34
-
FUNCSTRUCT::dataImg
void * dataImg
Definition: fun.h:38
+
FUNCARGS
Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.
Definition: fun.h:51
+
FUNCARGS::out_data_img
void * out_data_img
Definition: fun.h:67
+
FUNCARGS::n_out_cols
int n_out_cols
Definition: fun.h:58
+
FUNCARGS::out_data_real
void * out_data_real
Definition: fun.h:66
+
FUNCARGS::is_out_struct
int is_out_struct
Definition: fun.h:62
+
FUNCARGS::is_out_cmplx
int is_out_cmplx
Definition: fun.h:61
+
FUNCARGS::n_in_struct_len
int n_in_struct_len
Definition: fun.h:56
+
FUNCARGS::n_out_struct_len
int n_out_struct_len
Definition: fun.h:59
+
FUNCARGS::n_in_rows
int n_in_rows
Definition: fun.h:54
+
FUNCARGS::n_in_cols
int n_in_cols
Definition: fun.h:55
+
FUNCARGS::type
FUNCTYPE type
Definition: fun.h:53
+
FUNCARGS::is_out_string
int is_out_string
Definition: fun.h:63
+
FUNCARGS::is_in_cmplx
int is_in_cmplx
Definition: fun.h:60
+
FUNCARGS::in_struct
FUNCSTRUCT * in_struct
Definition: fun.h:68
+
FUNCARGS::out_struct
FUNCSTRUCT * out_struct
Definition: fun.h:69
+
FUNCARGS::n_out_rows
int n_out_rows
Definition: fun.h:57
+
FUNCARGS::in_data_img
void * in_data_img
Definition: fun.h:65
+
FUNCARGS::in_data_real
void * in_data_real
Definition: fun.h:64
+
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:76
+
FUNCCALL::n_in_arguments
int n_in_arguments
Definition: fun.h:78
+
FUNCCALL::n_out_arguments
int n_out_arguments
Definition: fun.h:79
+
FUNCCALL::argument
FUNCARGS * argument
Definition: fun.h:83
+
FUNCCALL::n_out_user
int n_out_user
Definition: fun.h:80
+
FUNCCALL::err
char * err
Definition: fun.h:81
+
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:35
+
FUNCSTRUCT::type
FUNCTYPE type
Definition: fun.h:36
+
FUNCSTRUCT::str
void * str
Definition: fun.h:42
+
FUNCSTRUCT::rows
int rows
Definition: fun.h:38
+
FUNCSTRUCT::dataReal
void * dataReal
Definition: fun.h:40
+
FUNCSTRUCT::cols
int cols
Definition: fun.h:39
+
FUNCSTRUCT::key
void * key
Definition: fun.h:37
+
FUNCSTRUCT::dataImg
void * dataImg
Definition: fun.h:41
-- cgit