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 --- .../thirdparty_2linux_2include_2fun_8h_source.html | 89 +++++++++++++--------- 1 file changed, 54 insertions(+), 35 deletions(-) (limited to 'doc/html/thirdparty_2linux_2include_2fun_8h_source.html') diff --git a/doc/html/thirdparty_2linux_2include_2fun_8h_source.html b/doc/html/thirdparty_2linux_2include_2fun_8h_source.html index f8ecedc..ab0fa9b 100644 --- a/doc/html/thirdparty_2linux_2include_2fun_8h_source.html +++ b/doc/html/thirdparty_2linux_2include_2fun_8h_source.html @@ -114,44 +114,63 @@ $(document).ready(function(){initNavTree('thirdparty_2linux_2include_2fun_8h_sou
15 extern "C"
16 {
17 
-
18  typedef enum
-
19  {
-
20  TYPE_DOUBLE,
+
18  typedef enum {
+
19  TYPE_DOUBLE,
+
20  TYPE_COMPLEX,
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 }
+
22  TYPE_STRUCT,
+
23  }FUNCTYPE;
+
24 
+
25  typedef struct {
+
26  FUNCTYPE type; // type of value in struct's field
+
27  void* key; // key of struct field
+
28  int rows; // rows dimension of struct field's value
+
29  int cols; // cols dimension of struct fields' value
+
30  void* dataReal; // Real data if struct field's value is real
+
31  void* dataImg; // Img data if struct field's value is complex
+
32  void* str; // string data if struct field's value is string
+
33  } FUNCSTRUCT;
+
34 
+
35  typedef struct {
+
36  FUNCTYPE type;
+
37  int n_in_rows;
+
38  int n_in_cols;
+
39  int n_in_struct_len; // ip struct length
+
40  int n_out_rows;
+
41  int n_out_cols;
+
42  int n_out_struct_len; // op struct length
+
43  int is_in_cmplx;
+
44  int is_out_cmplx;
+
45  int is_out_string;
+
46  int is_out_struct;
+
47  void* in_data_real;
+
48  void* in_data_img;
+
49  void* out_data_real;
+
50  void* out_data_img;
+
51  FUNCSTRUCT* in_struct;
+
52  FUNCSTRUCT* out_struct;
+
53  } FUNCARGS;
+
54 
+
55  typedef struct {
+
56  int n_in_arguments; // number of input arguments
+
57  int n_out_arguments; // number of output arguments
+
58  int n_out_user; // number of output arguments
+
59  char *err; // Name
+
60  //char *package; //Name of octave package to be loaded
+
61  FUNCARGS *argument;
+
62  } FUNCCALL;
+
63 
+
64  int fun(FUNCARGS *arr, FUNCCALL *call);
+
65 }
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
-
FUNCCALL
Definition: fun.h:39
+
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
+
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:73
+
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:32
-- 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/thirdparty_2linux_2include_2fun_8h_source.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/html/thirdparty_2linux_2include_2fun_8h_source.html') diff --git a/doc/html/thirdparty_2linux_2include_2fun_8h_source.html b/doc/html/thirdparty_2linux_2include_2fun_8h_source.html index ab0fa9b..0c42ddc 100644 --- a/doc/html/thirdparty_2linux_2include_2fun_8h_source.html +++ b/doc/html/thirdparty_2linux_2include_2fun_8h_source.html @@ -162,15 +162,15 @@ $(document).ready(function(){initNavTree('thirdparty_2linux_2include_2fun_8h_sou
63 
64  int fun(FUNCARGS *arr, FUNCCALL *call);
65 }
-
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
+
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
-
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:73
-
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:32
+
FUNCARGS
Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.
Definition: fun.h:51
+
FUNCCALL
Struct used to call and pass the data to fun.cpp API.
Definition: fun.h:76
+
FUNCSTRUCT
Struct used to pass structs to Octave from the fun library.
Definition: fun.h:35
-- cgit