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
249
250
251
252
253
254
255
256
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Standalone Programs (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Standalone Programs (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Standalone Programs (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="External-Code-Interface.html" rel="up" title="External Code Interface">
<link href="Java-Interface.html" rel="next" title="Java Interface">
<link href="Calling-Other-Functions-in-Mex_002dFiles.html" rel="prev" title="Calling Other Functions in Mex-Files">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="Standalone-Programs"></span><div class="header">
<p>
Next: <a href="Java-Interface.html" accesskey="n" rel="next">Java Interface</a>, Previous: <a href="Mex_002dFiles.html" accesskey="p" rel="prev">Mex-Files</a>, Up: <a href="External-Code-Interface.html" accesskey="u" rel="up">External Code Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Standalone-Programs-1"></span><h3 class="section">A.3 Standalone Programs</h3>
<p>The libraries Octave uses itself can be utilized in standalone applications.
These applications then have access, for example, to the array and matrix
classes, as well as to all of the Octave algorithms. The following C++
program, uses class Matrix from <samp>liboctave.a</samp> or <samp>liboctave.so</samp>.
</p>
<div class="example">
<pre class="verbatim">#include <iostream>
#include <octave/oct.h>
int
main (void)
{
std::cout << "Hello Octave world!\n";
int n = 2;
Matrix a_matrix = Matrix (n, n);
for (octave_idx_type i = 0; i < n; i++)
for (octave_idx_type j = 0; j < n; j++)
a_matrix(i,j) = (i + 1) * 10 + (j + 1);
std::cout << a_matrix;
return 0;
}
</pre></div>
<p>mkoctfile can be used to build a standalone application with a command like
</p>
<div class="example">
<pre class="example">$ mkoctfile --link-stand-alone standalone.cc -o standalone
$ ./standalone
Hello Octave world!
11 12
21 22
$
</pre></div>
<p>Note that the application <code>standalone</code> will be dynamically linked against
the Octave libraries and any Octave support libraries. The above allows the
Octave math libraries to be used by an application. It does not, however,
allow the script files, oct-files, or built-in functions of Octave to be used
by the application. To do that, the Octave interpreter needs to be initialized
first. An example of how to do this can then be seen in the code
</p>
<div class="example">
<pre class="verbatim">#include <iostream>
#include <octave/oct.h>
#include <octave/octave.h>
#include <octave/parse.h>
#include <octave/interpreter.h>
int
main (void)
{
// Create interpreter.
octave::interpreter interpreter;
try
{
// Inhibit reading history file by calling
//
// interpreter.initialize_history (false);
// Set custom load path here if you wish by calling
//
// interpreter.initialize_load_path (false);
// Perform final initialization of interpreter, including
// executing commands from startup files by calling
//
// interpreter.initialize ();
//
// if (! interpreter.initialized ())
// {
// std::cerr << "Octave interpreter initialization failed!"
// << std::endl;
// exit (status);
// }
//
// You may skip this step if you don't need to do anything
// between reading the startup files and telling the interpreter
// that you are ready to execute commands.
// Tell the interpreter that we're ready to execute commands:
int status = interpreter.execute ();
if (status != 0)
{
std::cerr << "creating embedded Octave interpreter failed!"
<< std::endl;
return status;
}
octave_idx_type n = 2;
octave_value_list in;
for (octave_idx_type i = 0; i < n; i++)
in(i) = octave_value (5 * (i + 2));
octave_value_list out = octave::feval ("gcd", in, 1);
if (out.length () > 0)
std::cout << "GCD of ["
<< in(0).int_value ()
<< ", "
<< in(1).int_value ()
<< "] is " << out(0).int_value ()
<< std::endl;
else
std::cout << "invalid\n";
}
catch (const octave::exit_exception& ex)
{
std::cerr << "Octave interpreter exited with status = "
<< ex.exit_status () << std::endl;
}
catch (const octave::execution_exception&)
{
std::cerr << "error encountered in Octave evaluator!" << std::endl;
}
// Shutdown the interpreter which cleanly releases all memory.
interpreter.shutdown ();
return 0;
}
</pre></div>
<p>which, as before, is compiled and run as a standalone application with
</p>
<div class="example">
<pre class="example">$ mkoctfile --link-stand-alone embedded.cc -o embedded
$ ./embedded
GCD of [10, 15] is 5
$
</pre></div>
<p>It is worth re-iterating that, if only built-in functions are to be called from
a C++ standalone program then it does not need to initialize the interpreter.
The general rule is that for a built-in function named <code>function_name</code> in
the interpreter, there will be a C++ function named <code>Ffunction_name</code> (note
the prepended capital <code>F</code>) accessible in the C++ API. The declarations
for all built-in functions are collected in the header file
<code>builtin-defun-decls.h</code>. This feature should be used with care as the
list of built-in functions can change. No guarantees can be made that a
function that is currently a built-in won’t be implemented as a <samp>.m</samp> file
or as a dynamically linked function in the future. An example of how to call
built-in functions from C++ can be seen in the code
</p>
<div class="example">
<pre class="verbatim">#include <iostream>
#include <octave/oct.h>
#include <octave/builtin-defun-decls.h>
int
main (void)
{
int n = 2;
Matrix a_matrix = Matrix (n, n);
for (octave_idx_type i = 0; i < n; i++)
for (octave_idx_type j = 0; j < n; j++)
a_matrix(i,j) = (i + 1) * 10 + (j + 1);
std::cout << "This is a matrix:" << std::endl
<< a_matrix << std::endl;
octave_value_list in;
in(0) = a_matrix;
octave_value_list out = Fnorm (in, 1);
double norm_of_the_matrix = out(0).double_value ();
std::cout << "This is the norm of the matrix:" << std::endl
<< norm_of_the_matrix << std::endl;
return 0;
}
</pre></div>
<p>which is compiled and run as a standalone application with
</p>
<div class="example">
<pre class="example">$ mkoctfile --link-stand-alone standalonebuiltin.cc -o standalonebuiltin
$ ./standalonebuiltin
This is a matrix:
11 12
21 22
This is the norm of the matrix:
34.4952
$
</pre></div>
<hr>
<div class="header">
<p>
Next: <a href="Java-Interface.html" accesskey="n" rel="next">Java Interface</a>, Previous: <a href="Mex_002dFiles.html" accesskey="p" rel="prev">Mex-Files</a>, Up: <a href="External-Code-Interface.html" accesskey="u" rel="up">External Code Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
