|
6686
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 2001, 2006 Paul Kienzle |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 /* |
|
|
25 |
|
|
26 Part of this code was originally distributed as part of Octave Forge under |
|
|
27 the following terms: |
|
|
28 |
|
|
29 Author: Paul Kienzle |
|
|
30 I grant this code to the public domain. |
|
|
31 2001-03-22 |
|
|
32 |
|
|
33 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
|
|
34 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
|
35 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
|
36 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
|
|
37 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
|
38 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
|
39 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
|
40 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
|
41 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|
|
42 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
|
43 SUCH DAMAGE. |
|
|
44 |
|
|
45 */ |
|
|
46 |
|
|
47 #if ! defined (MXARRAY_H) |
|
|
48 #define MXARRAY_H |
|
|
49 |
|
|
50 typedef enum |
|
|
51 { |
|
|
52 mxREAL = 0, |
|
|
53 mxCOMPLEX = 1 |
|
|
54 } |
|
|
55 mxComplexity; |
|
|
56 |
|
|
57 typedef enum |
|
|
58 { |
|
|
59 mxUNKNOWN_CLASS = 0, |
|
|
60 mxCELL_CLASS, |
|
|
61 mxSTRUCT_CLASS, |
|
|
62 mxLOGICAL_CLASS, |
|
|
63 mxCHAR_CLASS, |
|
|
64 mxUNUSED_CLASS, |
|
|
65 mxDOUBLE_CLASS, |
|
|
66 mxSINGLE_CLASS, |
|
|
67 mxINT8_CLASS, |
|
|
68 mxUINT8_CLASS, |
|
|
69 mxINT16_CLASS, |
|
|
70 mxUINT16_CLASS, |
|
|
71 mxINT32_CLASS, |
|
|
72 mxUINT32_CLASS, |
|
|
73 mxINT64_CLASS, |
|
|
74 mxUINT64_CLASS, |
|
|
75 mxFUNCTION_CLASS, |
|
|
76 } |
|
|
77 mxClassID; |
|
|
78 |
|
|
79 typedef int mxLogical; |
|
|
80 |
|
|
81 /* typedef Uint16 mxChar; */ |
|
|
82 typedef char mxChar; |
|
|
83 |
|
|
84 /* |
|
|
85 * FIXME? Mathworks says these should be size_t on 64-bit system and when |
|
|
86 * mex is used with the -largearraydims flag, but why do that? Its better |
|
|
87 * to conform to the same indexing as the rest of Octave |
|
|
88 */ |
|
|
89 typedef @OCTAVE_IDX_TYPE@ mwSize; |
|
|
90 typedef @OCTAVE_IDX_TYPE@ mwIndex; |
|
|
91 |
|
|
92 #if ! defined (MXARRAY_TYPEDEFS_ONLY) |
|
|
93 |
|
|
94 class octave_value; |
|
|
95 |
|
|
96 #define DO_MUTABLE_METHOD(RET_T, METHOD_CALL) \ |
|
|
97 RET_T retval = rep->METHOD_CALL; \ |
|
|
98 \ |
|
|
99 if (rep->mutation_needed ()) \ |
|
|
100 { \ |
|
|
101 maybe_mutate (); \ |
|
|
102 retval = rep->METHOD_CALL; \ |
|
|
103 } \ |
|
|
104 \ |
|
|
105 return retval |
|
|
106 |
|
|
107 #define DO_VOID_MUTABLE_METHOD(METHOD_CALL) \ |
|
|
108 rep->METHOD_CALL; \ |
|
|
109 \ |
|
|
110 if (rep->mutation_needed ()) \ |
|
|
111 { \ |
|
|
112 maybe_mutate (); \ |
|
|
113 rep->METHOD_CALL; \ |
|
|
114 } |
|
|
115 |
|
|
116 // This just provides a way to avoid infinite recursion when building |
|
|
117 // mxArray objects. |
|
|
118 |
|
|
119 struct |
|
|
120 xmxArray |
|
|
121 { |
|
|
122 xmxArray (void) { } |
|
|
123 }; |
|
|
124 |
|
|
125 // The main interface class. The representation can be based on an |
|
|
126 // octave_value object or a separate object that tries to reproduce |
|
|
127 // the semantics of mxArray objects in Matlab more directly. |
|
|
128 |
|
|
129 class mxArray |
|
|
130 { |
|
|
131 public: |
|
|
132 |
|
|
133 mxArray (const octave_value& ov); |
|
|
134 |
|
|
135 mxArray (mxClassID id, mwSize ndims, const mwSize *dims, |
|
|
136 mxComplexity flag = mxREAL); |
|
|
137 |
|
|
138 mxArray (mxClassID id, const dim_vector& dv, mxComplexity flag = mxREAL); |
|
|
139 |
|
|
140 mxArray (mxClassID id, mwSize m, mwSize n, mxComplexity flag = mxREAL); |
|
|
141 |
|
|
142 mxArray (mxClassID id, double val); |
|
|
143 |
|
|
144 mxArray (mxClassID id, mxLogical val); |
|
|
145 |
|
|
146 mxArray (const char *str); |
|
|
147 |
|
6806
|
148 mxArray (mwSize m, const char **str); |
|
6686
|
149 |
|
6806
|
150 mxArray (mxClassID id, mwSize m, mwSize n, mwSize nzmax, |
|
|
151 mxComplexity flag = mxREAL); |
|
6686
|
152 |
|
|
153 mxArray (mwSize ndims, const mwSize *dims, int num_keys, const char **keys); |
|
|
154 |
|
|
155 mxArray (const dim_vector& dv, int num_keys, const char **keys); |
|
|
156 |
|
|
157 mxArray (mwSize m, mwSize n, int num_keys, const char **keys); |
|
|
158 |
|
|
159 mxArray (mwSize ndims, const mwSize *dims); |
|
|
160 |
|
|
161 mxArray (const dim_vector& dv); |
|
|
162 |
|
|
163 mxArray (mwSize m, mwSize n); |
|
|
164 |
|
|
165 virtual mxArray *clone (void) const |
|
|
166 { |
|
|
167 mxArray *new_rep = rep->clone (); |
|
|
168 |
|
|
169 return new mxArray (new_rep, name); |
|
|
170 } |
|
|
171 |
|
|
172 virtual ~mxArray (void); |
|
|
173 |
|
|
174 virtual bool is_octave_value (void) const { return rep->is_octave_value (); } |
|
|
175 |
|
|
176 virtual int is_cell (void) const { return rep->is_cell (); } |
|
|
177 |
|
|
178 virtual int is_char (void) const { return rep->is_char (); } |
|
|
179 |
|
|
180 virtual int is_class (const char *name_arg) const { return rep->is_class (name_arg); } |
|
|
181 |
|
|
182 virtual int is_complex (void) const { return rep->is_complex (); } |
|
|
183 |
|
|
184 virtual int is_double (void) const { return rep->is_double (); } |
|
|
185 |
|
|
186 virtual int is_int16 (void) const { return rep->is_int16 (); } |
|
|
187 |
|
|
188 virtual int is_int32 (void) const { return rep->is_int32 (); } |
|
|
189 |
|
|
190 virtual int is_int64 (void) const { return rep->is_int64 (); } |
|
|
191 |
|
|
192 virtual int is_int8 (void) const { return rep->is_int8 (); } |
|
|
193 |
|
|
194 virtual int is_logical (void) const { return rep->is_logical (); } |
|
|
195 |
|
|
196 virtual int is_numeric (void) const { return rep->is_numeric (); } |
|
|
197 |
|
|
198 virtual int is_single (void) const { return rep->is_single (); } |
|
|
199 |
|
|
200 virtual int is_sparse (void) const { return rep->is_sparse (); } |
|
|
201 |
|
|
202 virtual int is_struct (void) const { return rep->is_struct (); } |
|
|
203 |
|
|
204 virtual int is_uint16 (void) const { return rep->is_uint16 (); } |
|
|
205 |
|
|
206 virtual int is_uint32 (void) const { return rep->is_uint32 (); } |
|
|
207 |
|
|
208 virtual int is_uint64 (void) const { return rep->is_uint64 (); } |
|
|
209 |
|
|
210 virtual int is_uint8 (void) const { return rep->is_uint8 (); } |
|
|
211 |
|
|
212 virtual int is_logical_scalar (void) const { return rep->is_logical_scalar (); } |
|
|
213 |
|
|
214 virtual int is_logical_scalar_true (void) const { return rep->is_logical_scalar_true (); } |
|
|
215 |
|
|
216 virtual mwSize get_m (void) const { return rep->get_m (); } |
|
|
217 |
|
|
218 virtual mwSize get_n (void) const { return rep->get_n (); } |
|
|
219 |
|
|
220 virtual mwSize *get_dimensions (void) const { return rep->get_dimensions (); } |
|
|
221 |
|
|
222 virtual mwSize get_number_of_dimensions (void) const { return rep->get_number_of_dimensions (); } |
|
|
223 |
|
|
224 virtual void set_m (mwSize m) { DO_VOID_MUTABLE_METHOD (set_m (m)); } |
|
|
225 |
|
|
226 virtual void set_n (mwSize n) { DO_VOID_MUTABLE_METHOD (set_n (n)); } |
|
|
227 |
|
|
228 virtual void set_dimensions (mwSize *dims_arg, mwSize ndims_arg) { DO_VOID_MUTABLE_METHOD (set_dimensions (dims_arg, ndims_arg)); } |
|
|
229 |
|
|
230 virtual mwSize get_number_of_elements (void) const { return rep->get_number_of_elements (); } |
|
|
231 |
|
|
232 virtual int is_empty (void) const { return get_number_of_elements () == 0; } |
|
|
233 |
|
|
234 const char *get_name (void) const { return name; } |
|
|
235 |
|
|
236 void set_name (const char *name_arg); |
|
|
237 |
|
|
238 virtual mxClassID get_class_id (void) const { return rep->get_class_id (); } |
|
|
239 |
|
|
240 virtual const char *get_class_name (void) const { return rep->get_class_name (); } |
|
|
241 |
|
|
242 virtual void set_class_name (const char *name_arg) { DO_VOID_MUTABLE_METHOD (set_class_name (name_arg)); } |
|
|
243 |
|
|
244 virtual mxArray *get_cell (mwIndex idx) const { DO_MUTABLE_METHOD (mxArray *, get_cell (idx)); } |
|
|
245 |
|
|
246 virtual void set_cell (mwIndex idx, mxArray *val) { DO_VOID_MUTABLE_METHOD (set_cell (idx, val)); } |
|
|
247 |
|
|
248 virtual double get_scalar (void) const { return rep->get_scalar (); } |
|
|
249 |
|
|
250 virtual void *get_data (void) const { DO_MUTABLE_METHOD (void *, get_data ()); } |
|
|
251 |
|
|
252 virtual void *get_imag_data (void) const { DO_MUTABLE_METHOD (void *, get_imag_data ()); } |
|
|
253 |
|
|
254 virtual void set_data (void *pr) { DO_VOID_MUTABLE_METHOD (set_data (pr)); } |
|
|
255 |
|
|
256 virtual void set_imag_data (void *pi) { DO_VOID_MUTABLE_METHOD (set_imag_data (pi)); } |
|
|
257 |
|
|
258 virtual mwIndex *get_ir (void) const { DO_MUTABLE_METHOD (mwIndex *, get_ir ()); } |
|
|
259 |
|
|
260 virtual mwIndex *get_jc (void) const { DO_MUTABLE_METHOD (mwIndex *, get_jc ()); } |
|
|
261 |
|
|
262 virtual mwSize get_nzmax (void) const { return rep->get_nzmax (); } |
|
|
263 |
|
|
264 virtual void set_ir (mwIndex *ir) { DO_VOID_MUTABLE_METHOD (set_ir (ir)); } |
|
|
265 |
|
|
266 virtual void set_jc (mwIndex *jc) { DO_VOID_MUTABLE_METHOD (set_jc (jc)); } |
|
|
267 |
|
|
268 virtual void set_nzmax (mwSize nzmax) { DO_VOID_MUTABLE_METHOD (set_nzmax (nzmax)); } |
|
|
269 |
|
|
270 virtual int add_field (const char *key) { DO_MUTABLE_METHOD (int, add_field (key)); } |
|
|
271 |
|
|
272 virtual void remove_field (int key_num) { DO_VOID_MUTABLE_METHOD (remove_field (key_num)); } |
|
|
273 |
|
|
274 virtual mxArray *get_field_by_number (mwIndex index, int key_num) const { DO_MUTABLE_METHOD (mxArray *, get_field_by_number (index, key_num)); } |
|
|
275 |
|
|
276 virtual void set_field_by_number (mwIndex index, int key_num, mxArray *val) { DO_VOID_MUTABLE_METHOD (set_field_by_number (index, key_num, val)); } |
|
|
277 |
|
|
278 virtual int get_number_of_fields (void) const { return rep->get_number_of_fields (); } |
|
|
279 |
|
|
280 virtual const char *get_field_name_by_number (int key_num) const { DO_MUTABLE_METHOD (const char*, get_field_name_by_number (key_num)); } |
|
|
281 |
|
|
282 virtual int get_field_number (const char *key) const { DO_MUTABLE_METHOD (int, get_field_number (key)); } |
|
|
283 |
|
6806
|
284 virtual int get_string (char *buf, mwSize buflen) const { return rep->get_string (buf, buflen); } |
|
6686
|
285 |
|
|
286 virtual char *array_to_string (void) const { return rep->array_to_string (); } |
|
|
287 |
|
|
288 virtual mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const { return rep->calc_single_subscript (nsubs, subs); } |
|
|
289 |
|
|
290 virtual size_t get_element_size (void) const { return rep->get_element_size (); } |
|
|
291 |
|
|
292 virtual bool mutation_needed (void) const { return rep->mutation_needed (); } |
|
|
293 |
|
|
294 virtual mxArray *mutate (void) const { return rep->mutate (); } |
|
|
295 |
|
|
296 static void *malloc (size_t n); |
|
|
297 |
|
|
298 static void *calloc (size_t n, size_t t); |
|
|
299 |
|
|
300 static char *strsave (const char *str) |
|
|
301 { |
|
|
302 char *retval = 0; |
|
|
303 |
|
|
304 if (str) |
|
|
305 { |
|
|
306 mwSize sz = sizeof (mxChar) * (strlen (str) + 1); |
|
|
307 retval = static_cast<char *> (mxArray::malloc (sz)); |
|
|
308 strcpy (retval, str); |
|
|
309 } |
|
|
310 |
|
|
311 return retval; |
|
|
312 } |
|
|
313 |
|
|
314 static octave_value as_octave_value (mxArray *ptr); |
|
|
315 |
|
|
316 protected: |
|
|
317 |
|
|
318 virtual octave_value as_octave_value (void) const; |
|
|
319 |
|
|
320 mxArray (const xmxArray&) : rep (0), name (0) { } |
|
|
321 |
|
|
322 private: |
|
|
323 |
|
|
324 mutable mxArray *rep; |
|
|
325 |
|
|
326 char *name; |
|
|
327 |
|
|
328 mxArray (mxArray *r, const char *n) |
|
|
329 : rep (r), name (strsave (n)) { } |
|
|
330 |
|
|
331 void maybe_mutate (void) const; |
|
|
332 |
|
|
333 // No copying! |
|
|
334 |
|
|
335 mxArray (const mxArray&); |
|
|
336 |
|
|
337 mxArray& operator = (const mxArray&); |
|
|
338 }; |
|
|
339 |
|
|
340 #undef DO_MUTABLE_METHOD |
|
|
341 #undef DO_VOID_MUTABLE_METHOD |
|
|
342 |
|
|
343 #endif |
|
|
344 #endif |
