Mercurial > hg > octave-nkf
annotate libinterp/octave-value/ov-fcn-handle.h @ 19318:995df67fc912
Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip.
* fliplr.m, flipud.m: add support for N-dimensional arrays by making use
of flip(). Added new tests for ND arrays and defaults.
* flipdim.m: deprecate in favour of new function flip() which has exactly the
same syntax and is part of Matlab since R2014a.
* flip.m: new function copied from flipdim. Added tests for ND arrays and
defaults.
* matrix.txi: replace flipdim DOCSTRINg with flip.
* rot90.m, rotdim.m, del2.m: replace flipdim() with flip()
* NEWS: note deprecation of flip(), new function flipdim(), and ND support
for flipud() and fliplr().
author | Carnë Draug <carandraug+dev@gmail.com> |
---|---|
date | Sun, 21 Sep 2014 18:49:08 +0100 |
parents | bcd71a2531d3 |
children | 76478d2da117 |
rev | line source |
---|---|
4343 | 1 /* |
2 | |
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
3 Copyright (C) 2003-2013 John W. Eaton |
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10324
diff
changeset
|
4 Copyright (C) 2009 VZLU Prague |
4343 | 5 |
6 This file is part of Octave. | |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
9 under the terms of the GNU General Public License as published by the | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
4343 | 12 |
13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
4343 | 21 |
22 */ | |
23 | |
17822
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
24 #if !defined (octave_ov_fcn_handle_h) |
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
25 #define octave_ov_fcn_handle_h 1 |
4343 | 26 |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
27 #include <iosfwd> |
4343 | 28 #include <string> |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
29 #include <memory> |
4343 | 30 |
31 #include "oct-alloc.h" | |
32 | |
33 #include "ov-base.h" | |
4654 | 34 #include "ov-base-mat.h" |
4343 | 35 #include "ov-fcn.h" |
4654 | 36 #include "ov-typeinfo.h" |
4343 | 37 |
38 // Function handles. | |
39 | |
4925 | 40 class |
7867
f6fffa74b9b5
Export additional symbols: octave_fcn_inline, octave_fcn_handle, read_binary_data, save_binary_data.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
7761
diff
changeset
|
41 OCTINTERP_API |
4925 | 42 octave_fcn_handle : public octave_base_value |
4654 | 43 { |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
44 private: |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
45 |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
46 typedef std::map<std::string, octave_value> str_ov_map; |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
47 |
4654 | 48 public: |
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
49 |
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
50 static const std::string anonymous; |
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
51 |
4930 | 52 octave_fcn_handle (void) |
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
53 : fcn (), nm (), has_overloads (false), overloads () { } |
4654 | 54 |
5007 | 55 octave_fcn_handle (const std::string& n) |
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
56 : fcn (), nm (n), has_overloads (false), overloads () { } |
5007 | 57 |
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
58 octave_fcn_handle (const octave_value& f, const std::string& n = anonymous); |
4654 | 59 |
4967 | 60 octave_fcn_handle (const octave_fcn_handle& fh) |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
61 : octave_base_value (fh), fcn (fh.fcn), nm (fh.nm), |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
62 has_overloads (fh.has_overloads), overloads () |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
63 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
64 for (int i = 0; i < btyp_num_types; i++) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
65 builtin_overloads[i] = fh.builtin_overloads[i]; |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
66 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
67 overloads = fh.overloads; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
68 } |
4967 | 69 |
4654 | 70 ~octave_fcn_handle (void) { } |
71 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
72 octave_base_value *clone (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 { return new octave_fcn_handle (*this); } |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 octave_base_value *empty_clone (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 { return new octave_fcn_handle (); } |
4967 | 76 |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
77 octave_value subsref (const std::string& type, |
10313 | 78 const std::list<octave_value_list>& idx) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 octave_value_list tmp = subsref (type, idx, 1); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
81 return tmp.length () > 0 ? tmp(0) : octave_value (); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
82 } |
4924 | 83 |
84 octave_value_list subsref (const std::string& type, | |
10313 | 85 const std::list<octave_value_list>& idx, |
86 int nargout); | |
4924 | 87 |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
88 octave_value_list subsref (const std::string& type, |
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
89 const std::list<octave_value_list>& idx, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
90 int nargout, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
91 const std::list<octave_lvalue>* lvalue_list); |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
92 |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
93 octave_value_list |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
94 do_multi_index_op (int nargout, const octave_value_list& args); |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
95 |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
96 octave_value_list |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
97 do_multi_index_op (int nargout, const octave_value_list& args, |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
98 const std::list<octave_lvalue>* lvalue_list); |
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
99 |
4925 | 100 bool is_defined (void) const { return true; } |
4654 | 101 |
102 bool is_function_handle (void) const { return true; } | |
103 | |
10087
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10075
diff
changeset
|
104 builtin_type_t builtin_type (void) const { return btyp_func_handle; } |
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10075
diff
changeset
|
105 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
106 bool is_overloaded (void) const { return has_overloads; } |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
107 |
5654 | 108 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; } |
109 | |
4930 | 110 octave_function *function_value (bool = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
111 { return fcn.function_value (); } |
4930 | 112 |
6625 | 113 octave_user_function *user_function_value (bool = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
114 { return fcn.user_function_value (); } |
6625 | 115 |
4654 | 116 octave_fcn_handle *fcn_handle_value (bool = false) { return this; } |
117 | |
5007 | 118 octave_value fcn_val (void) const { return fcn; } |
119 | |
4933 | 120 std::string fcn_name (void) const { return nm; } |
4930 | 121 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
122 void set_overload (builtin_type_t btyp, const octave_value& ov_fcn) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
123 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
124 if (btyp != btyp_unknown) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
125 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
126 has_overloads = true; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
127 builtin_overloads[btyp] = ov_fcn; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
128 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
129 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
130 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
131 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
132 void set_overload (const std::string& dispatch_type, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
133 const octave_value& ov_fcn) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
134 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
135 has_overloads = true; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
136 overloads[dispatch_type] = ov_fcn; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
137 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
138 |
10322
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
139 bool is_equal_to (const octave_fcn_handle&) const; |
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
140 |
6974 | 141 bool save_ascii (std::ostream& os); |
4988 | 142 |
143 bool load_ascii (std::istream& is); | |
144 | |
145 bool save_binary (std::ostream& os, bool& save_as_floats); | |
146 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
147 bool load_binary (std::istream& is, bool swap, |
10313 | 148 oct_mach_info::float_format fmt); |
4988 | 149 |
150 #if defined (HAVE_HDF5) | |
151 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
152 | |
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9463
diff
changeset
|
153 bool load_hdf5 (hid_t loc_id, const char *name); |
4988 | 154 #endif |
155 | |
18484
bcd71a2531d3
Support disp/display overloading in classdef
Michael Goffioul <michael.goffioul@gmail.com>
parents:
17822
diff
changeset
|
156 void print (std::ostream& os, bool pr_as_read_syntax = false); |
4654 | 157 |
158 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
159 | |
10324
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
160 // Simple function handles are printed without a newline. |
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
161 bool print_as_scalar (void) const { return nm != anonymous; } |
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
162 |
4654 | 163 private: |
4343 | 164 |
6625 | 165 bool set_fcn (const std::string &octaveroot, const std::string& fpath); |
166 | |
4612 | 167 DECLARE_OCTAVE_ALLOCATOR |
4343 | 168 |
4612 | 169 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
4925 | 170 |
4933 | 171 protected: |
4930 | 172 |
4925 | 173 // The function we are handling. |
4930 | 174 octave_value fcn; |
4925 | 175 |
176 // The name of the handle, including the "@". | |
177 std::string nm; | |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
178 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
179 // Whether the function is overloaded at all. |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
180 bool has_overloads; |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
181 |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
182 // Overloads for builtin types. We use array to make lookup faster. |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
183 octave_value builtin_overloads[btyp_num_types]; |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
184 |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
185 // Overloads for other classes. |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
186 str_ov_map overloads; |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
187 |
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
188 friend octave_value make_fcn_handle (const std::string &, bool); |
4343 | 189 }; |
190 | |
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
191 extern octave_value make_fcn_handle (const std::string& nm, |
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
192 bool local_funcs = true); |
4343 | 193 |
10960 | 194 class |
195 OCTINTERP_API | |
196 octave_fcn_binder : public octave_fcn_handle | |
197 { | |
198 private: | |
199 // Private ctor. | |
200 octave_fcn_binder (const octave_value& f, const octave_value& root, | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
201 const octave_value_list& templ, |
10960 | 202 const std::vector<int>& mask, int exp_nargin); |
203 | |
204 public: | |
205 | |
206 // Factory method. | |
207 static octave_fcn_handle *maybe_binder (const octave_value& f); | |
208 | |
209 octave_value_list | |
210 do_multi_index_op (int nargout, const octave_value_list& args); | |
211 | |
212 octave_value_list | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
213 do_multi_index_op (int nargout, const octave_value_list& args, |
10960 | 214 const std::list<octave_lvalue>* lvalue_list); |
215 | |
216 protected: | |
217 | |
218 octave_value root_handle; | |
219 octave_value_list arg_template; | |
220 std::vector<int> arg_mask; | |
221 int expected_nargin; | |
222 }; | |
4343 | 223 #endif |