Mercurial > hg > octave-nkf
annotate examples/code/oct_demo.cc @ 20441:83792dd9bcc1
Use in-place operators in m-files where possible.
* scripts/audio/@audioplayer/set.m, scripts/audio/@audiorecorder/set.m,
scripts/audio/mu2lin.m, scripts/elfun/cosd.m, scripts/general/del2.m,
scripts/general/profexplore.m, scripts/general/quadl.m, scripts/general/rat.m,
scripts/general/rotdim.m, scripts/help/get_first_help_sentence.m,
scripts/help/private/__strip_html_tags__.m, scripts/image/cubehelix.m,
scripts/io/textread.m, scripts/linear-algebra/duplication_matrix.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/krylov.m,
scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m,
scripts/linear-algebra/onenormest.m, scripts/optimization/fminsearch.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/qp.m,
scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/specular.m,
scripts/plot/draw/colorbar.m, scripts/plot/draw/hist.m,
scripts/plot/draw/plotmatrix.m, scripts/plot/draw/private/__stem__.m,
scripts/plot/util/__actual_axis_position__.m,
scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/findobj.m,
scripts/plot/util/print.m, scripts/plot/util/private/__go_draw_axes__.m,
scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/rotate.m,
scripts/polynomial/pchip.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/private/__splinefit__.m,
scripts/polynomial/residue.m, scripts/signal/arch_fit.m,
scripts/signal/arch_rnd.m, scripts/signal/bartlett.m,
scripts/signal/blackman.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/stft.m,
scripts/sparse/bicgstab.m, scripts/sparse/cgs.m,
scripts/sparse/private/__sprand_impl__.m, scripts/sparse/qmr.m,
scripts/sparse/sprandsym.m, scripts/sparse/svds.m, scripts/specfun/legendre.m,
scripts/special-matrix/gallery.m, scripts/statistics/base/gls.m,
scripts/statistics/models/logistic_regression.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/manova.m, scripts/statistics/tests/wilcoxon_test.m,
scripts/time/datevec.m:
Use in-place operators in m-files where possible.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 26 May 2015 21:07:42 -0700 |
| parents | c8240a60dd01 |
| children |
| rev | line source |
|---|---|
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
1 // oct_demo.cc -- example of a dynamically linked function for Octave. |
| 2134 | 2 |
| 3 // To use this file, your version of Octave must support dynamic | |
| 2153 | 4 // linking. To find out if it does, type the command |
| 2134 | 5 // |
| 4128 | 6 // octave_config_info ("ENABLE_DYNAMIC_LINKING") |
| 2134 | 7 // |
| 8 // at the Octave prompt. Support for dynamic linking is included if | |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
9 // this expression returns the string "yes". |
| 2134 | 10 // |
| 11 // To compile this file, type the command | |
| 12 // | |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
13 // mkoctfile oct_demo.cc |
| 2134 | 14 // |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
15 // from within Octave or from the shell prompt. This will create a file |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
16 // called oct_demo.oct that can be loaded by Octave. To test the |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
17 // oct_demo.oct file, start Octave and type the command |
| 2134 | 18 // |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
19 // oct_demo ("easy as", 1, 2, 3) |
| 2134 | 20 // |
| 21 // at the Octave prompt. Octave should respond by printing | |
| 22 // | |
| 23 // Hello, world! | |
| 24 // easy as | |
| 25 // 1 | |
| 26 // 2 | |
| 27 // 3 | |
| 28 // ans = 3 | |
| 29 | |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
30 // Additional samples of real dynamically loaded functions are available in |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
31 // the files of the libinterp/dldfcn directory of the Octave distribution. |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
32 // See also the chapter External Code Interface in the documentation. |
| 2134 | 33 |
| 4399 | 34 #include <iostream> |
| 2134 | 35 |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
36 #include <octave/oct.h> |
| 2134 | 37 |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
38 // Every user function should include <octave/oct.h> which imports the |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
39 // basic set of Octave header files required. In particular this will define |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
40 // the DEFUN_DLD macro (defun-dld.h) which is used for every user function |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
41 // that is visible to Octave. |
| 2152 | 42 |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
43 // The four arguments to the DEFUN_DLD macro are: |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
44 // 1) The function name as seen in Octave. |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
45 // 2) The variable to hold any inputs (of type octave_value_list) |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
46 // 3) The number of output arguments |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
47 // 4) A string to use as help text if 'help <function_name>' is entered. |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
48 // |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
49 // Note below that the third parameter (nargout) of DEFUN_DLD is not used, |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
50 // so it is omitted from the list of arguments in order to avoid a warning |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
51 // from gcc about an unused function parameter. |
| 2134 | 52 |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
53 DEFUN_DLD (oct_demo, args, , |
|
17791
224e76250443
Use GNU style coding conventions for code in examples/
Rik <rik@octave.org>
parents:
16867
diff
changeset
|
54 "[...] = oct_demo (...)\n\ |
| 2134 | 55 \n\ |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
56 Print a greeting followed by the values of all the arguments passed.\n\ |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
57 Return all arguments in reverse order.") |
| 2134 | 58 { |
| 59 // The list of values to return. See the declaration in oct-obj.h | |
| 60 | |
| 61 octave_value_list retval; | |
| 62 | |
| 63 // This stream is normally connected to the pager. | |
| 64 | |
| 65 octave_stdout << "Hello, world!\n"; | |
| 66 | |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
67 // The inputs to this function are available in args. |
| 2134 | 68 |
| 69 int nargin = args.length (); | |
| 70 | |
|
16867
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
71 // The octave_value_list class is a zero-based array of octave_value objects. |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
72 // The declaration for the octave_value class is in the file ov.h. |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
73 // The print() method will send its output to octave_stdout, |
|
be41c30bcb44
Re-write documentation and all examples of dynamically linked functions.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
74 // so it will also end up going through the pager. |
| 2134 | 75 |
| 76 for (int i = 0; i < nargin; i++) | |
| 2142 | 77 { |
|
14844
5bc9b9cb4362
maint: Use Octave coding conventions for cuddled parenthesis in retval assignments.
Rik <octave@nomad.inbox5.com>
parents:
12174
diff
changeset
|
78 octave_value tmp = args(i); |
| 3242 | 79 tmp.print (octave_stdout); |
|
14844
5bc9b9cb4362
maint: Use Octave coding conventions for cuddled parenthesis in retval assignments.
Rik <octave@nomad.inbox5.com>
parents:
12174
diff
changeset
|
80 retval(nargin-i-1) = tmp; |
| 2142 | 81 } |
| 2134 | 82 |
| 83 return retval; | |
| 84 } |