diff options
Diffstat (limited to 'Doc/Manual/Octave.html')
| -rw-r--r-- | Doc/Manual/Octave.html | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/Doc/Manual/Octave.html b/Doc/Manual/Octave.html index be512f0ce..3c08d849b 100644 --- a/Doc/Manual/Octave.html +++ b/Doc/Manual/Octave.html @@ -8,7 +8,7 @@ <body bgcolor="#ffffff"> -<H1><a name="Octave"></a>28 SWIG and Octave</H1> +<H1><a name="Octave"></a>29 SWIG and Octave</H1> <!-- INDEX --> <div class="sectiontoc"> <ul> @@ -46,7 +46,7 @@ <p> Octave is a high-level language intended for numerical programming that is mostly compatible with MATLAB. -More information can be found at <a href="http://www.octave.org">www.octave.org</a>. +More information can be found at <a href="http://www.gnu.org/software/octave/">Octave web site</a>. </p> <p> @@ -54,14 +54,14 @@ More information can be found at <a href="http://www.octave.org">www.octave.org< Also, there are a dozen or so examples in the Examples/octave directory, and hundreds in the test suite (Examples/test-suite and Examples/test-suite/octave). </p> -<H2><a name="Octave_nn2"></a>28.1 Preliminaries</H2> +<H2><a name="Octave_nn2"></a>29.1 Preliminaries</H2> <p> The SWIG implemention was first based on Octave 2.9.12, so this is the minimum version required. Testing has only been done on Linux. </p> -<H2><a name="Octave_nn3"></a>28.2 Running SWIG</H2> +<H2><a name="Octave_nn3"></a>29.2 Running SWIG</H2> <p> @@ -97,7 +97,7 @@ This creates a C++ source file <tt>example_wrap.cxx</tt>. A C++ file is generate The swig command line has a number of options you can use, like to redirect it's output. Use <tt>swig --help</tt> to learn about these. </p> -<H3><a name="Octave_nn5"></a>28.2.1 Compiling a dynamic module</H3> +<H3><a name="Octave_nn5"></a>29.2.1 Compiling a dynamic module</H3> <p> @@ -124,7 +124,7 @@ $ mkoctfile example_wrap.cxx example.c <div class="targetlang"><pre>octave:1> example</pre></div> -<H3><a name="Octave_nn6"></a>28.2.2 Using your module</H3> +<H3><a name="Octave_nn6"></a>29.2.2 Using your module</H3> <p> @@ -142,10 +142,10 @@ octave:4> example.cvar.Foo=4; octave:5> example.cvar.Foo ans = 4 </pre></div> -<H2><a name="Octave_nn7"></a>28.3 A tour of basic C/C++ wrapping</H2> +<H2><a name="Octave_nn7"></a>29.3 A tour of basic C/C++ wrapping</H2> -<H3><a name="Octave_nn8"></a>28.3.1 Modules</H3> +<H3><a name="Octave_nn8"></a>29.3.1 Modules</H3> <p> @@ -187,7 +187,7 @@ One can also rename it by simple assignment, e.g., octave:1> some_vars = cvar; </pre></div> -<H3><a name="Octave_nn9"></a>28.3.2 Functions</H3> +<H3><a name="Octave_nn9"></a>29.3.2 Functions</H3> <p> @@ -204,7 +204,7 @@ int fact(int n); </pre></div> <div class="targetlang"><pre>octave:1> example.fact(4) 24 </pre></div> -<H3><a name="Octave_nn10"></a>28.3.3 Global variables</H3> +<H3><a name="Octave_nn10"></a>29.3.3 Global variables</H3> <p> @@ -257,7 +257,7 @@ octave:2> example.PI=3.142; octave:3> example.PI ans = 3.1420 </pre></div> -<H3><a name="Octave_nn11"></a>28.3.4 Constants and enums</H3> +<H3><a name="Octave_nn11"></a>29.3.4 Constants and enums</H3> <p> @@ -279,7 +279,7 @@ example.SCONST="Hello World" example.SUNDAY=0 .... </pre></div> -<H3><a name="Octave_nn12"></a>28.3.5 Pointers</H3> +<H3><a name="Octave_nn12"></a>29.3.5 Pointers</H3> <p> @@ -326,7 +326,7 @@ octave:2> f=example.fopen("not there","r"); error: value on right hand side of assignment is undefined error: evaluating assignment expression near line 2, column 2 </pre></div> -<H3><a name="Octave_nn13"></a>28.3.6 Structures and C++ classes</H3> +<H3><a name="Octave_nn13"></a>29.3.6 Structures and C++ classes</H3> <p> @@ -461,7 +461,7 @@ ans = 1 Depending on the ownership setting of a <tt>swig_ref</tt>, it may call C++ destructors when its reference count goes to zero. See the section on memory management below for details. </p> -<H3><a name="Octave_nn15"></a>28.3.7 C++ inheritance</H3> +<H3><a name="Octave_nn15"></a>29.3.7 C++ inheritance</H3> <p> @@ -470,7 +470,7 @@ This information contains the full class hierarchy. When an indexing operation ( the tree is walked to find a match in the current class as well as any of its bases. The lookup is then cached in the <tt>swig_ref</tt>. </p> -<H3><a name="Octave_nn17"></a>28.3.8 C++ overloaded functions</H3> +<H3><a name="Octave_nn17"></a>29.3.8 C++ overloaded functions</H3> <p> @@ -480,7 +480,7 @@ The dispatch function selects which overload to call (if any) based on the passe <tt>typecheck</tt> typemaps are used to analyze each argument, as well as assign precedence. See the chapter on typemaps for details. </p> -<H3><a name="Octave_nn18"></a>28.3.9 C++ operators</H3> +<H3><a name="Octave_nn18"></a>29.3.9 C++ operators</H3> <p> @@ -580,7 +580,7 @@ On the C++ side, the default mappings are as follows: %rename(__brace) *::operator[]; </pre></div> -<H3><a name="Octave_nn19"></a>28.3.10 Class extension with %extend</H3> +<H3><a name="Octave_nn19"></a>29.3.10 Class extension with %extend</H3> <p> @@ -610,7 +610,7 @@ octave:3> printf("%s\n",a); octave:4> a.__str() 4 </pre></div> -<H3><a name="Octave_nn20"></a>28.3.11 C++ templates</H3> +<H3><a name="Octave_nn20"></a>29.3.11 C++ templates</H3> <p> @@ -687,14 +687,14 @@ ans = </pre></div> -<H3><a name="Octave_nn21"></a>28.3.12 C++ Smart Pointers</H3> +<H3><a name="Octave_nn21"></a>29.3.12 C++ Smart Pointers</H3> <p> C++ smart pointers are fully supported as in other modules. </p> -<H3><a name="Octave_nn22"></a>28.3.13 Directors (calling Octave from C++ code)</H3> +<H3><a name="Octave_nn22"></a>29.3.13 Directors (calling Octave from C++ code)</H3> <p> @@ -755,7 +755,8 @@ Note that you have to enable directors via the %feature directive (see other mod <tt>subclass()</tt> will accept any number of C++ bases or other <tt>subclass()</tt>'ed objects, <tt>(string,octave_value)</tt> pairs, and <tt>function_handles</tt>. In the first case, these are taken as base classes; in the second case, as named members (either variables or functions, depending on whether the given value is a function handle); in the third case, as member functions whose name is taken from the given function handle. E.g., </p> <div class="targetlang"><pre> -octave:1> B=@(some_var=2) subclass(A(),'some_var',some_var,@some_func,'another_func',@(self) do_stuff()) +octave:1> B=@(some_var=2) subclass(A(),'some_var',some_var,@some_func,'another_func', +@(self) do_stuff()) </pre></div> <p> You can also assign non-C++ member variables and functions after construct time. There is no support for non-C++ static members. @@ -774,14 +775,14 @@ c-side routine called octave-side routine called </pre></div> -<H3><a name="Octave_nn23"></a>28.3.14 Threads</H3> +<H3><a name="Octave_nn23"></a>29.3.14 Threads</H3> <p> The use of threads in wrapped Director code is not supported; i.e., an Octave-side implementation of a C++ class must be called from the Octave interpreter's thread. Anything fancier (apartment/queue model, whatever) is left to the user. Without anything fancier, this amounts to the limitation that Octave must drive the module... like, for example, an optimization package that calls Octave to evaluate an objective function. </p> -<H3><a name="Octave_nn24"></a>28.3.15 Memory management</H3> +<H3><a name="Octave_nn24"></a>29.3.15 Memory management</H3> <p> @@ -815,14 +816,14 @@ The %newobject directive may be used to control this behavior for pointers retur In the case where one wishes for the C++ side to own an object that was created in Octave (especially a Director object), one can use the __disown() method to invert this logic. Then letting the Octave reference count go to zero will not destroy the object, but destroying the object will invalidate the Octave-side object if it still exists (and call destructors of other C++ bases in the case of multiple inheritance/<tt>subclass()</tt>'ing). </p> -<H3><a name="Octave_nn25"></a>28.3.16 STL support</H3> +<H3><a name="Octave_nn25"></a>29.3.16 STL support</H3> <p> Various STL library files are provided for wrapping STL containers. </p> -<H3><a name="Octave_nn26"></a>28.3.17 Matrix typemaps</H3> +<H3><a name="Octave_nn26"></a>29.3.17 Matrix typemaps</H3> <p> |