Mercurial > octave
annotate libinterp/corefcn/mxarray.in.h @ 19075:14bb81940528 stable
doc: Update docstring for datenum to describe format argument (bug #43181)
* datenum.m: Update docstring to describe the format argument exactly like
the docstring for datevec. Add test using format argument.
author | Mike Miller <mtmiller@ieee.org> |
---|---|
date | Wed, 10 Sep 2014 08:19:43 -0400 |
parents | 175b392e91fe |
children | 4197fc428c7d |
rev | line source |
---|---|
15100
8523df595d42
maint: Add DO NOT EDIT messages to build system for src/*.in.h.
Rik <rik@octave.org>
parents:
15096
diff
changeset
|
1 // %NO_EDIT_WARNING% |
6686 | 2 /* |
3 | |
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
16892
diff
changeset
|
4 Copyright (C) 2001-2013 Paul Kienzle |
6686 | 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. | |
6686 | 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/>. | |
6686 | 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 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
51 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
52 mxREAL = 0, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
53 mxCOMPLEX = 1 |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
54 } |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
55 mxComplexity; |
6686 | 56 |
57 typedef enum | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
58 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
59 mxUNKNOWN_CLASS = 0, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
60 mxCELL_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
61 mxSTRUCT_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
62 mxLOGICAL_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
63 mxCHAR_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
64 mxUNUSED_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
65 mxDOUBLE_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
66 mxSINGLE_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
67 mxINT8_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
68 mxUINT8_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
69 mxINT16_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
70 mxUINT16_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
71 mxINT32_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
72 mxUINT32_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 mxINT64_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 mxUINT64_CLASS, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 mxFUNCTION_CLASS |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
76 } |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
77 mxClassID; |
6686 | 78 |
7574
9669b69e34ef
define mxLogical as unsigned char instead of int
John W. Eaton <jwe@octave.org>
parents:
7417
diff
changeset
|
79 typedef unsigned char mxLogical; |
6686 | 80 |
81 /* typedef Uint16 mxChar; */ | |
82 typedef char mxChar; | |
83 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
84 /* |
6686 | 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 */ | |
9906 | 89 typedef %OCTAVE_IDX_TYPE% mwSize; |
90 typedef %OCTAVE_IDX_TYPE% mwIndex; | |
15240
a23693fa5ba9
Add mwSignedIndex type for better mex compatibility with Matlab (bug #37133)
Rik <rik@octave.org>
parents:
15195
diff
changeset
|
91 typedef %OCTAVE_IDX_TYPE% mwSignedIndex; |
6686 | 92 |
93 #if ! defined (MXARRAY_TYPEDEFS_ONLY) | |
94 | |
7417 | 95 #include <cstring> |
96 | |
6686 | 97 class octave_value; |
98 | |
99 #define DO_MUTABLE_METHOD(RET_T, METHOD_CALL) \ | |
100 RET_T retval = rep->METHOD_CALL; \ | |
101 \ | |
102 if (rep->mutation_needed ()) \ | |
103 { \ | |
104 maybe_mutate (); \ | |
105 retval = rep->METHOD_CALL; \ | |
106 } \ | |
107 \ | |
108 return retval | |
109 | |
110 #define DO_VOID_MUTABLE_METHOD(METHOD_CALL) \ | |
111 rep->METHOD_CALL; \ | |
112 \ | |
113 if (rep->mutation_needed ()) \ | |
114 { \ | |
115 maybe_mutate (); \ | |
116 rep->METHOD_CALL; \ | |
117 } | |
118 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
119 // A class to provide the default implemenation of some of the virtual |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
120 // functions declared in the mxArray class. |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
121 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
122 class mxArray; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
123 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
124 class mxArray_base |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
125 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
126 protected: |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
127 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
128 mxArray_base (void) { } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
129 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
130 public: |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
131 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
132 virtual mxArray_base *dup (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
133 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
134 virtual mxArray *as_mxArray (void) const { return 0; } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
135 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
136 virtual ~mxArray_base (void) { } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
137 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
138 virtual bool is_octave_value (void) const { return false; } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
139 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
140 virtual int is_cell (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
141 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
142 virtual int is_char (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
143 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
144 virtual int is_class (const char *name_arg) const |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
145 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
146 int retval = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
147 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
148 const char *cname = get_class_name (); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
149 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
150 if (cname && name_arg) |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
151 retval = ! strcmp (cname, name_arg); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
152 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
153 return retval; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
154 } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
155 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
156 virtual int is_complex (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
157 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
158 virtual int is_double (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
159 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
160 virtual int is_function_handle (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
161 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
162 virtual int is_int16 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
163 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
164 virtual int is_int32 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
165 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
166 virtual int is_int64 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
167 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
168 virtual int is_int8 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
169 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
170 virtual int is_logical (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
171 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
172 virtual int is_numeric (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
173 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
174 virtual int is_single (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
175 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
176 virtual int is_sparse (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
177 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
178 virtual int is_struct (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
179 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
180 virtual int is_uint16 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
181 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
182 virtual int is_uint32 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
183 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
184 virtual int is_uint64 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
185 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
186 virtual int is_uint8 (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
187 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
188 virtual int is_logical_scalar (void) const |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
189 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
190 return is_logical () && get_number_of_elements () == 1; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
191 } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
192 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
193 virtual int is_logical_scalar_true (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
194 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
195 virtual mwSize get_m (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
196 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
197 virtual mwSize get_n (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
198 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
199 virtual mwSize *get_dimensions (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
200 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
201 virtual mwSize get_number_of_dimensions (void) const = 0; |
6686 | 202 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
203 virtual void set_m (mwSize m) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
204 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
205 virtual void set_n (mwSize n) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
206 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
207 virtual void set_dimensions (mwSize *dims_arg, mwSize ndims_arg) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
208 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
209 virtual mwSize get_number_of_elements (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
210 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
211 virtual int is_empty (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
212 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
213 virtual mxClassID get_class_id (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
214 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
215 virtual const char *get_class_name (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
216 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
217 virtual void set_class_name (const char *name_arg) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
218 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
219 virtual mxArray *get_cell (mwIndex /*idx*/) const |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
220 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
221 invalid_type_error (); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
222 return 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
223 } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
224 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
225 virtual void set_cell (mwIndex idx, mxArray *val) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
226 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
227 virtual double get_scalar (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
228 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
229 virtual void *get_data (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
230 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
231 virtual void *get_imag_data (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
232 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
233 virtual void set_data (void *pr) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
234 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
235 virtual void set_imag_data (void *pi) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
236 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
237 virtual mwIndex *get_ir (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
238 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
239 virtual mwIndex *get_jc (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
240 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
241 virtual mwSize get_nzmax (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
242 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
243 virtual void set_ir (mwIndex *ir) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
244 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
245 virtual void set_jc (mwIndex *jc) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
246 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
247 virtual void set_nzmax (mwSize nzmax) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
248 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
249 virtual int add_field (const char *key) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
250 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
251 virtual void remove_field (int key_num) = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
252 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
253 virtual mxArray *get_field_by_number (mwIndex index, int key_num) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
254 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
255 virtual void |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
256 set_field_by_number (mwIndex index, int key_num, mxArray *val) = 0; |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
257 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
258 virtual int get_number_of_fields (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
259 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
260 virtual const char *get_field_name_by_number (int key_num) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
261 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
262 virtual int get_field_number (const char *key) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
263 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
264 virtual int get_string (char *buf, mwSize buflen) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
265 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
266 virtual char *array_to_string (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
267 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
268 virtual mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
269 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
270 virtual size_t get_element_size (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
271 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
272 virtual bool mutation_needed (void) const { return false; } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
273 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
274 virtual mxArray *mutate (void) const { return 0; } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
275 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
276 virtual octave_value as_octave_value (void) const = 0; |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
277 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
278 protected: |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
279 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
280 mxArray_base (const mxArray_base&) { } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
281 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
282 void invalid_type_error (void) const |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
283 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
284 error ("invalid type for operation"); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
285 } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
286 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
287 void error (const char *msg) const; |
6686 | 288 }; |
289 | |
290 // The main interface class. The representation can be based on an | |
291 // octave_value object or a separate object that tries to reproduce | |
292 // the semantics of mxArray objects in Matlab more directly. | |
293 | |
294 class mxArray | |
295 { | |
296 public: | |
297 | |
298 mxArray (const octave_value& ov); | |
299 | |
300 mxArray (mxClassID id, mwSize ndims, const mwSize *dims, | |
10317
42d098307c30
untabify additional source files
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
301 mxComplexity flag = mxREAL); |
6686 | 302 |
303 mxArray (mxClassID id, const dim_vector& dv, mxComplexity flag = mxREAL); | |
304 | |
305 mxArray (mxClassID id, mwSize m, mwSize n, mxComplexity flag = mxREAL); | |
306 | |
307 mxArray (mxClassID id, double val); | |
308 | |
309 mxArray (mxClassID id, mxLogical val); | |
310 | |
311 mxArray (const char *str); | |
312 | |
6806 | 313 mxArray (mwSize m, const char **str); |
6686 | 314 |
6806 | 315 mxArray (mxClassID id, mwSize m, mwSize n, mwSize nzmax, |
10317
42d098307c30
untabify additional source files
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
316 mxComplexity flag = mxREAL); |
6686 | 317 |
318 mxArray (mwSize ndims, const mwSize *dims, int num_keys, const char **keys); | |
319 | |
320 mxArray (const dim_vector& dv, int num_keys, const char **keys); | |
321 | |
322 mxArray (mwSize m, mwSize n, int num_keys, const char **keys); | |
323 | |
324 mxArray (mwSize ndims, const mwSize *dims); | |
325 | |
326 mxArray (const dim_vector& dv); | |
327 | |
328 mxArray (mwSize m, mwSize n); | |
329 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
330 mxArray *dup (void) const |
6686 | 331 { |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
332 mxArray *retval = rep->as_mxArray (); |
6686 | 333 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
334 if (retval) |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
335 retval->set_name (name); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
336 else |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
337 { |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
338 mxArray_base *new_rep = rep->dup (); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
339 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
340 retval = new mxArray (new_rep, name); |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
341 } |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
342 |
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
343 return retval; |
6686 | 344 } |
345 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
346 ~mxArray (void); |
6686 | 347 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
348 bool is_octave_value (void) const { return rep->is_octave_value (); } |
6686 | 349 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
350 int is_cell (void) const { return rep->is_cell (); } |
6686 | 351 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
352 int is_char (void) const { return rep->is_char (); } |
6686 | 353 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
354 int is_class (const char *name_arg) const { return rep->is_class (name_arg); } |
6686 | 355 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
356 int is_complex (void) const { return rep->is_complex (); } |
6686 | 357 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
358 int is_double (void) const { return rep->is_double (); } |
6686 | 359 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
360 int is_function_handle (void) const { return rep->is_function_handle (); } |
11100
cdf940db26a0
provide mxIsFunctionHandle MEX interface function
John W. Eaton <jwe@octave.org>
parents:
10317
diff
changeset
|
361 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
362 int is_int16 (void) const { return rep->is_int16 (); } |
6686 | 363 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
364 int is_int32 (void) const { return rep->is_int32 (); } |
6686 | 365 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
366 int is_int64 (void) const { return rep->is_int64 (); } |
6686 | 367 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
368 int is_int8 (void) const { return rep->is_int8 (); } |
6686 | 369 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
370 int is_logical (void) const { return rep->is_logical (); } |
6686 | 371 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
372 int is_numeric (void) const { return rep->is_numeric (); } |
6686 | 373 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
374 int is_single (void) const { return rep->is_single (); } |
6686 | 375 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
376 int is_sparse (void) const { return rep->is_sparse (); } |
6686 | 377 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
378 int is_struct (void) const { return rep->is_struct (); } |
6686 | 379 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
380 int is_uint16 (void) const { return rep->is_uint16 (); } |
6686 | 381 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
382 int is_uint32 (void) const { return rep->is_uint32 (); } |
6686 | 383 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
384 int is_uint64 (void) const { return rep->is_uint64 (); } |
6686 | 385 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
386 int is_uint8 (void) const { return rep->is_uint8 (); } |
6686 | 387 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
388 int is_logical_scalar (void) const { return rep->is_logical_scalar (); } |
6686 | 389 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
390 int is_logical_scalar_true (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
391 { return rep->is_logical_scalar_true (); } |
6686 | 392 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
393 mwSize get_m (void) const { return rep->get_m (); } |
6686 | 394 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
395 mwSize get_n (void) const { return rep->get_n (); } |
6686 | 396 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
397 mwSize *get_dimensions (void) const { return rep->get_dimensions (); } |
6686 | 398 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
399 mwSize get_number_of_dimensions (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
400 { return rep->get_number_of_dimensions (); } |
6686 | 401 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
402 void set_m (mwSize m) { DO_VOID_MUTABLE_METHOD (set_m (m)); } |
6686 | 403 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
404 void set_n (mwSize n) { DO_VOID_MUTABLE_METHOD (set_n (n)); } |
6686 | 405 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
406 void set_dimensions (mwSize *dims_arg, mwSize ndims_arg) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
407 { DO_VOID_MUTABLE_METHOD (set_dimensions (dims_arg, ndims_arg)); } |
6686 | 408 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
409 mwSize get_number_of_elements (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
410 { return rep->get_number_of_elements (); } |
6686 | 411 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
412 int is_empty (void) const { return get_number_of_elements () == 0; } |
6686 | 413 |
414 const char *get_name (void) const { return name; } | |
415 | |
416 void set_name (const char *name_arg); | |
417 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
418 mxClassID get_class_id (void) const { return rep->get_class_id (); } |
6686 | 419 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
420 const char *get_class_name (void) const { return rep->get_class_name (); } |
6686 | 421 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
422 void set_class_name (const char *name_arg) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
423 { DO_VOID_MUTABLE_METHOD (set_class_name (name_arg)); } |
6686 | 424 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
425 mxArray *get_cell (mwIndex idx) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
426 { DO_MUTABLE_METHOD (mxArray *, get_cell (idx)); } |
6686 | 427 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
428 void set_cell (mwIndex idx, mxArray *val) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
429 { DO_VOID_MUTABLE_METHOD (set_cell (idx, val)); } |
6686 | 430 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
431 double get_scalar (void) const { return rep->get_scalar (); } |
6686 | 432 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
433 void *get_data (void) const { DO_MUTABLE_METHOD (void *, get_data ()); } |
6686 | 434 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
435 void *get_imag_data (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
436 { DO_MUTABLE_METHOD (void *, get_imag_data ()); } |
6686 | 437 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
438 void set_data (void *pr) { DO_VOID_MUTABLE_METHOD (set_data (pr)); } |
6686 | 439 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
440 void set_imag_data (void *pi) { DO_VOID_MUTABLE_METHOD (set_imag_data (pi)); } |
6686 | 441 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
442 mwIndex *get_ir (void) const { DO_MUTABLE_METHOD (mwIndex *, get_ir ()); } |
6686 | 443 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
444 mwIndex *get_jc (void) const { DO_MUTABLE_METHOD (mwIndex *, get_jc ()); } |
6686 | 445 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
446 mwSize get_nzmax (void) const { return rep->get_nzmax (); } |
6686 | 447 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
448 void set_ir (mwIndex *ir) { DO_VOID_MUTABLE_METHOD (set_ir (ir)); } |
6686 | 449 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
450 void set_jc (mwIndex *jc) { DO_VOID_MUTABLE_METHOD (set_jc (jc)); } |
6686 | 451 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
452 void set_nzmax (mwSize nzmax) { DO_VOID_MUTABLE_METHOD (set_nzmax (nzmax)); } |
6686 | 453 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
454 int add_field (const char *key) { DO_MUTABLE_METHOD (int, add_field (key)); } |
6686 | 455 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
456 void remove_field (int key_num) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
457 { DO_VOID_MUTABLE_METHOD (remove_field (key_num)); } |
6686 | 458 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
459 mxArray *get_field_by_number (mwIndex index, int key_num) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
460 { DO_MUTABLE_METHOD (mxArray *, get_field_by_number (index, key_num)); } |
6686 | 461 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
462 void set_field_by_number (mwIndex index, int key_num, mxArray *val) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
463 { DO_VOID_MUTABLE_METHOD (set_field_by_number (index, key_num, val)); } |
6686 | 464 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
465 int get_number_of_fields (void) const { return rep->get_number_of_fields (); } |
6686 | 466 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
467 const char *get_field_name_by_number (int key_num) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
468 { DO_MUTABLE_METHOD (const char*, get_field_name_by_number (key_num)); } |
6686 | 469 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
470 int get_field_number (const char *key) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
471 { DO_MUTABLE_METHOD (int, get_field_number (key)); } |
6686 | 472 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
473 int get_string (char *buf, mwSize buflen) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
474 { return rep->get_string (buf, buflen); } |
6686 | 475 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
476 char *array_to_string (void) const { return rep->array_to_string (); } |
6686 | 477 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
478 mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
479 { return rep->calc_single_subscript (nsubs, subs); } |
6686 | 480 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
481 size_t get_element_size (void) const { return rep->get_element_size (); } |
6686 | 482 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
483 bool mutation_needed (void) const { return rep->mutation_needed (); } |
6686 | 484 |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
485 mxArray *mutate (void) const { return rep->mutate (); } |
6686 | 486 |
487 static void *malloc (size_t n); | |
488 | |
489 static void *calloc (size_t n, size_t t); | |
490 | |
491 static char *strsave (const char *str) | |
492 { | |
493 char *retval = 0; | |
494 | |
495 if (str) | |
496 { | |
10317
42d098307c30
untabify additional source files
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
497 mwSize sz = sizeof (mxChar) * (strlen (str) + 1); |
42d098307c30
untabify additional source files
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
498 retval = static_cast<char *> (mxArray::malloc (sz)); |
42d098307c30
untabify additional source files
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
499 strcpy (retval, str); |
6686 | 500 } |
501 | |
502 return retval; | |
503 } | |
504 | |
15353
5f3a69a309a7
fix decl of mexPutVariable
John W. Eaton <jwe@octave.org>
parents:
15351
diff
changeset
|
505 static octave_value as_octave_value (const mxArray *ptr); |
6686 | 506 |
507 protected: | |
508 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
509 octave_value as_octave_value (void) const; |
6686 | 510 |
511 private: | |
512 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
513 mutable mxArray_base *rep; |
6686 | 514 |
515 char *name; | |
516 | |
15351
a291f850743c
modernize mxArray class hierarchy
John W. Eaton <jwe@octave.org>
parents:
15240
diff
changeset
|
517 mxArray (mxArray_base *r, const char *n) |
15354
93dff6435fe1
tag calls to mxArray::malloc, mxArray::calloc, and mxArray::strsave with class name
John W. Eaton <jwe@octave.org>
parents:
15353
diff
changeset
|
518 : rep (r), name (mxArray::strsave (n)) { } |
6686 | 519 |
520 void maybe_mutate (void) const; | |
521 | |
522 // No copying! | |
523 | |
524 mxArray (const mxArray&); | |
525 | |
526 mxArray& operator = (const mxArray&); | |
527 }; | |
528 | |
529 #undef DO_MUTABLE_METHOD | |
530 #undef DO_VOID_MUTABLE_METHOD | |
531 | |
532 #endif | |
533 #endif |