Mercurial > octave-nkf
annotate src/ov-class.h @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | f687bd17ce21 |
| children | cda4aa780d58 |
| rev | line source |
|---|---|
| 7338 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 2007-2011 John W. Eaton |
|
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
4 Copyright (C) 2009 VZLU Prague |
| 7338 | 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 | |
| 7444 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 7338 | 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 | |
| 7444 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 7338 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_class_h) | |
| 25 #define octave_class_h 1 | |
| 26 | |
| 27 #include <cstdlib> | |
| 28 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
29 #include <iosfwd> |
| 7338 | 30 #include <string> |
| 31 | |
| 32 #include "mx-base.h" | |
| 33 #include "str-vec.h" | |
| 34 | |
| 35 #include "error.h" | |
| 36 #include "oct-alloc.h" | |
| 37 #include "oct-map.h" | |
| 38 #include "ov-base.h" | |
| 39 #include "ov-typeinfo.h" | |
| 40 | |
| 41 class octave_value_list; | |
| 42 | |
| 43 class tree_walker; | |
| 44 | |
| 45 // Data structures. | |
| 46 | |
| 47 class | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
48 octave_class : public octave_base_value |
| 7338 | 49 { |
| 50 public: | |
| 51 | |
| 52 octave_class (void) | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
53 : octave_base_value (), obsolete_copies (0) { } |
| 7338 | 54 |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
55 octave_class (const octave_map& m, const std::string& id) |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
56 : octave_base_value (), map (m), c_name (id), obsolete_copies (0) { } |
| 7338 | 57 |
| 58 octave_class (const octave_class& s) | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
59 : octave_base_value (s), map (s.map), c_name (s.c_name), |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
60 parent_list (s.parent_list), obsolete_copies (0) { } |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
61 |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
62 octave_class (const octave_map& m, const std::string& id, |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
63 const octave_value_list& parents); |
| 7338 | 64 |
| 65 ~octave_class (void) { } | |
| 66 | |
| 67 octave_base_value *clone (void) const { return new octave_class (*this); } | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
68 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
69 octave_base_value *unique_clone (void); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
70 |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
71 octave_base_value *empty_clone (void) const |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
72 { |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
73 return new octave_class (octave_map (map.keys ()), class_name ()); |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
74 } |
| 7338 | 75 |
| 76 Cell dotref (const octave_value_list& idx); | |
| 77 | |
|
9329
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
78 Matrix size (void); |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
79 |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
80 octave_idx_type numel (const octave_value_list&); |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
81 |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
82 octave_value subsref (const std::string& type, |
| 10313 | 83 const std::list<octave_value_list>& idx) |
| 7338 | 84 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
85 octave_value_list tmp = subsref (type, idx, 1); |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
86 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 7338 | 87 } |
| 88 | |
| 89 octave_value_list subsref (const std::string& type, | |
| 10313 | 90 const std::list<octave_value_list>& idx, |
| 91 int nargout); | |
| 7338 | 92 |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
93 static octave_value numeric_conv (const Cell& val, |
| 10313 | 94 const std::string& type); |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
95 |
|
9147
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
96 void assign(const std::string& k, const octave_value& rhs) |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
97 { map.assign (k, rhs); }; |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
98 |
| 7338 | 99 octave_value subsasgn (const std::string& type, |
| 10313 | 100 const std::list<octave_value_list>& idx, |
| 101 const octave_value& rhs); | |
| 7338 | 102 |
|
8154
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
103 idx_vector index_vector (void) const; |
|
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
104 |
| 7338 | 105 dim_vector dims (void) const { return map.dims (); } |
| 106 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
107 size_t byte_size (void) const; |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
108 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
109 // This is the number of elements in each field. The total number |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
110 // of elements is numel () * nfields (). |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
111 octave_idx_type numel (void) const |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
112 { |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
113 dim_vector dv = dims (); |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
114 return dv.numel (); |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
115 } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
116 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
117 octave_idx_type nfields (void) const { return map.nfields (); } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
118 |
| 9151 | 119 size_t nparents (void) const { return parent_list.size (); } |
| 120 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
121 octave_value reshape (const dim_vector& new_dims) const |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
122 { return map.reshape (new_dims); } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
123 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
124 octave_value resize (const dim_vector& dv, bool = false) const |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
125 { octave_map tmap = map; tmap.resize (dv); return tmap; } |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
126 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
127 bool is_defined (void) const { return true; } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
128 |
| 7338 | 129 bool is_map (void) const { return false; } |
| 130 | |
| 131 bool is_object (void) const { return true; } | |
| 132 | |
|
10742
604e13a89c7f
initial code for structs rewrite
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
133 octave_map map_value (void) const { return map; } |
|
604e13a89c7f
initial code for structs rewrite
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
134 |
| 7338 | 135 string_vector map_keys (void) const; |
| 136 | |
| 9151 | 137 std::list<std::string> parent_class_name_list (void) const |
| 138 { return parent_list; } | |
| 139 | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
140 string_vector parent_class_names (void) const |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
141 { return string_vector (parent_list); } |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
142 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
143 octave_base_value *find_parent_class (const std::string&); |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
144 |
|
9767
0df32e0b2074
fix base class field assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
9581
diff
changeset
|
145 octave_base_value *unique_parent_class (const std::string&); |
|
0df32e0b2074
fix base class field assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
9581
diff
changeset
|
146 |
| 7338 | 147 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 148 | |
| 149 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 150 | |
| 151 bool print_name_tag (std::ostream& os, const std::string& name) const; | |
| 152 | |
| 153 void print_with_name (std::ostream& os, const std::string& name, | |
| 10313 | 154 bool print_padding = true); |
| 7338 | 155 |
| 9190 | 156 bool reconstruct_exemplar (void); |
| 157 | |
|
9240
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
158 static void clear_exemplar_map (void); |
|
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
159 |
|
9182
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
160 bool reconstruct_parents (void); |
|
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
161 |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
162 bool save_ascii (std::ostream& os); |
| 7338 | 163 |
| 164 bool load_ascii (std::istream& is); | |
| 165 | |
| 166 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 167 | |
| 168 bool load_binary (std::istream& is, bool swap, | |
| 10313 | 169 oct_mach_info::float_format fmt); |
| 7338 | 170 |
| 171 #if defined (HAVE_HDF5) | |
| 172 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 173 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9767
diff
changeset
|
174 bool load_hdf5 (hid_t loc_id, const char *name); |
| 7338 | 175 #endif |
| 176 | |
| 177 mxArray *as_mxArray (void) const; | |
| 178 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
179 private: |
| 7338 | 180 |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
181 octave_map map; |
| 7338 | 182 |
| 183 DECLARE_OCTAVE_ALLOCATOR | |
| 184 | |
| 185 public: | |
| 186 int type_id (void) const { return t_id; } | |
| 187 std::string type_name (void) const { return t_name; } | |
| 188 std::string class_name (void) const { return c_name; } | |
| 189 | |
| 190 static int static_type_id (void) { return t_id; } | |
| 191 static std::string static_type_name (void) { return t_name; } | |
| 192 static std::string static_class_name (void) { return "<unknown>"; } | |
| 193 static void register_type (void); | |
| 194 | |
| 195 private: | |
| 196 static int t_id; | |
| 197 | |
| 198 static const std::string t_name; | |
| 199 std::string c_name; | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
200 std::list<std::string> parent_list; |
| 7338 | 201 |
|
9581
3d0d2bda3a0f
fix previous change, avoid duplicate loads of methods in descendant classes
Jaroslav Hajek <highegg@gmail.com>
parents:
9529
diff
changeset
|
202 bool in_class_method (void); |
|
10926
f687bd17ce21
fix field assignment from private class methods
Jaroslav Hajek <highegg@gmail.com>
parents:
10768
diff
changeset
|
203 std::string get_current_method_class (void); |
| 9151 | 204 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
205 int obsolete_copies; |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
206 |
| 9151 | 207 public: |
| 208 // The list of field names and parent classes defines a class. We | |
| 209 // keep track of each class that has been created so that we know | |
| 210 class exemplar_info | |
| 211 { | |
| 212 public: | |
| 213 | |
| 214 exemplar_info (void) : field_names (), parent_class_names () { } | |
| 215 | |
| 216 exemplar_info (const octave_value& obj); | |
| 217 | |
| 218 exemplar_info (const exemplar_info& x) | |
| 219 : field_names (x.field_names), | |
| 10313 | 220 parent_class_names (x.parent_class_names) { } |
| 9151 | 221 |
| 222 exemplar_info& operator = (const exemplar_info& x) | |
| 223 { | |
| 224 if (&x != this) | |
| 10313 | 225 { |
| 226 field_names = x.field_names; | |
| 227 parent_class_names = x.parent_class_names; | |
| 228 } | |
| 9151 | 229 return *this; |
| 230 } | |
| 231 | |
| 232 octave_idx_type nfields (void) const { return field_names.length (); } | |
| 233 | |
| 234 size_t nparents (void) const { return parent_class_names.size (); } | |
| 235 | |
| 236 string_vector fields (void) const { return field_names; } | |
| 237 | |
| 238 std::list<std::string> parents (void) const { return parent_class_names; } | |
| 239 | |
| 240 bool compare (const octave_value& obj) const; | |
| 241 | |
| 242 private: | |
| 243 | |
| 244 string_vector field_names; | |
| 245 std::list<std::string> parent_class_names; | |
| 246 }; | |
| 247 | |
| 248 // A map from class names to lists of fields. | |
| 249 static std::map<std::string, exemplar_info> exemplar_map; | |
| 250 | |
| 251 typedef std::map<std::string, exemplar_info>::iterator exemplar_iterator; | |
| 252 typedef std::map<std::string, exemplar_info>::const_iterator exemplar_const_iterator; | |
| 7338 | 253 }; |
| 254 | |
| 255 #endif |