1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FOSSEE Scilab Octave Toolbox: src/fun.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="Scilab_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FOSSEE Scilab Octave Toolbox
</div>
<div id="projectbrief">This is a scilab toolbox to call octave functions. It requires octave to be installed on the system.</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('src_2fun_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fun.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="src_2fun_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_s_t_r_u_c_t.html">FUNCSTRUCT</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct used to pass structs to Octave from the fun library. <a href="struct_f_u_n_c_s_t_r_u_c_t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_a_r_g_s.html">FUNCARGS</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct used to send/receive Scilab data to/from the gateway to <a class="el" href="fun_8cpp.html">fun.cpp</a> API. <a href="struct_f_u_n_c_a_r_g_s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_c_a_l_l.html">FUNCCALL</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct used to call and pass the data to <a class="el" href="fun_8cpp.html">fun.cpp</a> API. <a href="struct_f_u_n_c_c_a_l_l.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2ca3f7142a7018d5861959828144a9e9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#a2ca3f7142a7018d5861959828144a9e9">fun_h__</a></td></tr>
<tr class="separator:a2ca3f7142a7018d5861959828144a9e9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a160793ea95e0b5106580229a2a5f1134"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">FUNCTYPE</a> { <br />
  <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc">TYPE_COMPLEX</a>
, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a">TYPE_STRING</a>
, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c">TYPE_STRUCT</a>
, <br />
  <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc">TYPE_COMPLEX</a>
, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a">TYPE_STRING</a>
, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c">TYPE_STRUCT</a>
<br />
}</td></tr>
<tr class="memdesc:a160793ea95e0b5106580229a2a5f1134"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the data types suported. <a href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">More...</a><br /></td></tr>
<tr class="separator:a160793ea95e0b5106580229a2a5f1134"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adda0eaf7454844236de53495b494cdd4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#adda0eaf7454844236de53495b494cdd4">fun</a> (<a class="el" href="struct_f_u_n_c_a_r_g_s.html">FUNCARGS</a> *arr, <a class="el" href="struct_f_u_n_c_c_a_l_l.html">FUNCCALL</a> *call)</td></tr>
<tr class="memdesc:adda0eaf7454844236de53495b494cdd4"><td class="mdescLeft"> </td><td class="mdescRight">API Function to call/receive and pass the data to fun API <br />
<a href="src_2fun_8h.html#adda0eaf7454844236de53495b494cdd4">More...</a><br /></td></tr>
<tr class="separator:adda0eaf7454844236de53495b494cdd4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a2ca3f7142a7018d5861959828144a9e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ca3f7142a7018d5861959828144a9e9">◆ </a></span>fun_h__</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fun_h__</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a160793ea95e0b5106580229a2a5f1134"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a160793ea95e0b5106580229a2a5f1134">◆ </a></span>FUNCTYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">FUNCTYPE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration for the data types suported. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c"></a>TYPE_DOUBLE </td><td class="fielddoc"><p>similar to scilab double </p>
</td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc"></a>TYPE_COMPLEX </td><td class="fielddoc"><p>similar to scilab complex </p>
</td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a"></a>TYPE_STRING </td><td class="fielddoc"><p>similar to scilab string </p>
</td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c"></a>TYPE_STRUCT </td><td class="fielddoc"><p>similar to scilab struct </p>
</td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c"></a>TYPE_DOUBLE </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc"></a>TYPE_COMPLEX </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a"></a>TYPE_STRING </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c"></a>TYPE_STRUCT </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="adda0eaf7454844236de53495b494cdd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adda0eaf7454844236de53495b494cdd4">◆ </a></span>fun()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fun </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_u_n_c_a_r_g_s.html">FUNCARGS</a> * </td>
<td class="paramname"><em>inp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_f_u_n_c_c_a_l_l.html">FUNCCALL</a> * </td>
<td class="paramname"><em>funcall</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>API Function to call/receive and pass the data to fun API <br />
</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arr</td><td>Input data <a class="el" href="struct_f_u_n_c_a_r_g_s.html" title="Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.">FUNCARGS</a> </td></tr>
<tr><td class="paramname">call</td><td>Input Arguments <a class="el" href="struct_f_u_n_c_c_a_l_l.html" title="Struct used to call and pass the data to fun.cpp API.">FUNCCALL</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int Status Code</dd></dl>
<p>API Function to call/receive and pass the data to fun API <br />
</p>
<p>This Function will be communicating with Octave to access it's function. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="src_2fun_8h.html">fun.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
|
