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.html | 3 + doc/html/src_2fun_8h_source.html | 167 ++++++++++----------- doc/html/struct_f_u_n_c_a_r_g_s.html | 2 +- doc/html/struct_f_u_n_c_c_a_l_l.html | 4 +- .../thirdparty_2linux_2include_2fun_8h_source.html | 16 +- doc/latex/src_2fun_8h.tex | 6 +- doc/latex/struct_f_u_n_c_a_r_g_s.tex | 2 +- doc/latex/struct_f_u_n_c_c_a_l_l.tex | 4 +- src/fun.h | 6 +- 9 files changed, 108 insertions(+), 102 deletions(-) diff --git a/doc/html/src_2fun_8h.html b/doc/html/src_2fun_8h.html index 81b1511..241daa6 100644 --- a/doc/html/src_2fun_8h.html +++ b/doc/html/src_2fun_8h.html @@ -136,6 +136,7 @@ Enumerations , TYPE_STRUCT
} + Enumeration for the data types suported. More...
 

@@ -172,6 +173,8 @@ Functions

+ +

Enumeration for the data types suported.

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
diff --git a/doc/html/struct_f_u_n_c_a_r_g_s.html b/doc/html/struct_f_u_n_c_a_r_g_s.html index 8e82bee..81cbfeb 100644 --- a/doc/html/struct_f_u_n_c_a_r_g_s.html +++ b/doc/html/struct_f_u_n_c_a_r_g_s.html @@ -307,7 +307,7 @@ Public Attributes
Enumerator
TYPE_DOUBLE 

similar to scilab double

-

Output cold dimension of data

+

Output cols dimension of data

diff --git a/doc/html/struct_f_u_n_c_c_a_l_l.html b/doc/html/struct_f_u_n_c_c_a_l_l.html index 32b9a9d..d53daa0 100644 --- a/doc/html/struct_f_u_n_c_c_a_l_l.html +++ b/doc/html/struct_f_u_n_c_c_a_l_l.html @@ -178,7 +178,7 @@ Public Attributes
-

Number of output arguments

+

Number of output arguements in Scilab

@@ -193,7 +193,7 @@ Public Attributes
-

Number of output arguements expected to be returned

+

Number of output arguements expected to be returned from Octave

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
diff --git a/doc/latex/src_2fun_8h.tex b/doc/latex/src_2fun_8h.tex index 1428746..af0ba56 100644 --- a/doc/latex/src_2fun_8h.tex +++ b/doc/latex/src_2fun_8h.tex @@ -28,7 +28,7 @@ enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} , \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}{TYPE\+\_\+\+STRING}} , \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}{TYPE\+\_\+\+STRUCT}} \} -\end{DoxyCompactItemize} +\begin{DoxyCompactList}\small\item\em Enumeration for the data types suported. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection*{Functions} \begin{DoxyCompactItemize} \item @@ -53,6 +53,10 @@ int \mbox{\hyperlink{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}{fun}} (\mbox \doxysubsubsection{\texorpdfstring{FUNCTYPE}{FUNCTYPE}} {\footnotesize\ttfamily enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}}} + + +Enumeration for the data types suported. + \begin{DoxyEnumFields}{Enumerator} \raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_DOUBLE@{TYPE\_DOUBLE}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_DOUBLE@{TYPE\_DOUBLE}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}} TYPE\+\_\+\+DOUBLE&similar to scilab double \\ diff --git a/doc/latex/struct_f_u_n_c_a_r_g_s.tex b/doc/latex/struct_f_u_n_c_a_r_g_s.tex index 891d6a6..248f71a 100644 --- a/doc/latex/struct_f_u_n_c_a_r_g_s.tex +++ b/doc/latex/struct_f_u_n_c_a_r_g_s.tex @@ -118,7 +118,7 @@ input struct length \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2 \doxysubsubsection{\texorpdfstring{n\_out\_cols}{n\_out\_cols}} {\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+out\+\_\+cols} -Output cold dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}\label{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}} +Output cols dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}\label{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}} \index{FUNCARGS@{FUNCARGS}!n\_out\_rows@{n\_out\_rows}} \index{n\_out\_rows@{n\_out\_rows}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{n\_out\_rows}{n\_out\_rows}} diff --git a/doc/latex/struct_f_u_n_c_c_a_l_l.tex b/doc/latex/struct_f_u_n_c_c_a_l_l.tex index 081134b..777013d 100644 --- a/doc/latex/struct_f_u_n_c_c_a_l_l.tex +++ b/doc/latex/struct_f_u_n_c_c_a_l_l.tex @@ -52,13 +52,13 @@ Number of input arguments \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a4c3ce57d438 \doxysubsubsection{\texorpdfstring{n\_out\_arguments}{n\_out\_arguments}} {\footnotesize\ttfamily int FUNCCALL\+::n\+\_\+out\+\_\+arguments} -Number of output arguments \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}\label{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}} +Number of output arguements in Scilab \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}\label{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}} \index{FUNCCALL@{FUNCCALL}!n\_out\_user@{n\_out\_user}} \index{n\_out\_user@{n\_out\_user}!FUNCCALL@{FUNCCALL}} \doxysubsubsection{\texorpdfstring{n\_out\_user}{n\_out\_user}} {\footnotesize\ttfamily int FUNCCALL\+::n\+\_\+out\+\_\+user} -Number of output arguements expected to be returned +Number of output arguements expected to be returned from Octave The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item diff --git a/src/fun.h b/src/fun.h index bbc0926..cbc8800 100644 --- a/src/fun.h +++ b/src/fun.h @@ -55,7 +55,7 @@ extern "C" int n_in_cols; /**< Input cols dimension of data*/ int n_in_struct_len; /**< input struct length*/ int n_out_rows; /**< Ouput rows dimension of data*/ - int n_out_cols; /**< Output cold dimension of data*/ + int n_out_cols; /**< Output cols dimension of data*/ int n_out_struct_len; /**< Output struct length*/ int is_in_cmplx; /**< Input is a Complex data type*/ int is_out_cmplx; /**< Output is a Complex data type*/ @@ -76,8 +76,8 @@ extern "C" typedef struct { /*@{*/ int n_in_arguments; /**< Number of input arguments*/ - int n_out_arguments; /**< Number of output arguments*/ - int n_out_user; /**< Number of output arguements expected to be returned */ + int n_out_arguments; /**< Number of output arguements in Scilab*/ + int n_out_user; /**< Number of output arguements expected to be returned from Octave */ char *err; /**< Return errors*/ //char *package; //Name of octave package to be loaded*/ FUNCARGS *argument; /**< Struct defining and containing the data*/ -- cgit