Mercurial > octave
annotate src/ov-class.h @ 9522:e79470be3ecb
implement subsasgn this-arg optimization
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Thu, 13 Aug 2009 15:51:57 +0200 |
| parents | e08d72bb988e |
| children | 8e5009334661 |
| rev | line source |
|---|---|
| 7338 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2007, 2008, 2009 John W. Eaton |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
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" | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
39 #include "ov-struct.h" |
| 7338 | 40 #include "ov-typeinfo.h" |
| 41 | |
| 42 class octave_value_list; | |
| 43 | |
| 44 class tree_walker; | |
| 45 | |
| 46 // Data structures. | |
| 47 | |
| 48 class | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
49 octave_class : public octave_struct |
| 7338 | 50 { |
| 51 public: | |
| 52 | |
| 53 octave_class (void) | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
54 : octave_struct (), obsolete_copies (0) { } |
| 7338 | 55 |
| 56 octave_class (const Octave_map& m, const std::string& id) | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
57 : octave_struct (m), c_name (id), obsolete_copies (0) { } |
| 7338 | 58 |
| 59 octave_class (const octave_class& s) | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
60 : octave_struct (s), c_name (s.c_name), |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
61 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
|
62 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
63 octave_class (const Octave_map& m, const std::string& id, |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
64 const octave_value_list& parents); |
| 7338 | 65 |
| 66 ~octave_class (void) { } | |
| 67 | |
| 68 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
|
69 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
70 octave_base_value *unique_clone (void); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
71 |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
72 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
|
73 { |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
74 return new octave_class (Octave_map (map.keys ()), class_name ()); |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
75 } |
| 7338 | 76 |
| 77 Cell dotref (const octave_value_list& idx); | |
| 78 | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
79 octave_value dotasgn (const octave_value_list& idx, const octave_value& rhs); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
80 |
|
9329
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
81 Matrix size (void); |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
82 |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
83 octave_idx_type numel (const octave_value_list&); |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
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 subsref (const std::string& type, |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
86 const std::list<octave_value_list>& idx) |
| 7338 | 87 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
88 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
|
89 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 7338 | 90 } |
| 91 | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
92 octave_value subsref (const std::string& type, |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
93 const std::list<octave_value_list>& idx, |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
94 bool auto_add); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
95 |
| 7338 | 96 octave_value_list subsref (const std::string& type, |
| 97 const std::list<octave_value_list>& idx, | |
| 98 int nargout); | |
| 99 | |
|
9147
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
100 void assign(const std::string& k, const octave_value& rhs) |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
101 { map.assign (k, rhs); }; |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
102 |
| 7338 | 103 octave_value subsasgn (const std::string& type, |
| 104 const std::list<octave_value_list>& idx, | |
| 105 const octave_value& rhs); | |
| 106 | |
|
8154
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
107 idx_vector index_vector (void) const; |
|
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
108 |
| 7338 | 109 dim_vector dims (void) const { return map.dims (); } |
| 110 | |
| 9151 | 111 size_t nparents (void) const { return parent_list.size (); } |
| 112 | |
| 7338 | 113 bool is_map (void) const { return false; } |
| 114 | |
| 115 bool is_object (void) const { return true; } | |
| 116 | |
| 117 string_vector map_keys (void) const; | |
| 118 | |
| 9151 | 119 std::list<std::string> parent_class_name_list (void) const |
| 120 { return parent_list; } | |
| 121 | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
122 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
|
123 { 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
|
124 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
125 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
|
126 |
| 7338 | 127 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 128 | |
| 129 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 130 | |
| 131 bool print_name_tag (std::ostream& os, const std::string& name) const; | |
| 132 | |
| 133 void print_with_name (std::ostream& os, const std::string& name, | |
| 9521 | 134 bool print_padding = true); |
| 7338 | 135 |
| 9190 | 136 bool reconstruct_exemplar (void); |
| 137 | |
|
9240
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
138 static void clear_exemplar_map (void); |
|
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
139 |
|
9182
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
140 bool reconstruct_parents (void); |
|
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
141 |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
142 bool save_ascii (std::ostream& os); |
| 7338 | 143 |
| 144 bool load_ascii (std::istream& is); | |
| 145 | |
| 146 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 147 | |
| 148 bool load_binary (std::istream& is, bool swap, | |
| 149 oct_mach_info::float_format fmt); | |
| 150 | |
| 151 #if defined (HAVE_HDF5) | |
| 152 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 153 | |
| 154 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
| 155 #endif | |
| 156 | |
| 157 mxArray *as_mxArray (void) const; | |
| 158 | |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
159 protected: |
| 7338 | 160 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
161 void gripe_failed_assignment (void); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
162 |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
163 private: |
| 7338 | 164 |
| 165 DECLARE_OCTAVE_ALLOCATOR | |
| 166 | |
| 167 public: | |
| 168 int type_id (void) const { return t_id; } | |
| 169 std::string type_name (void) const { return t_name; } | |
| 170 std::string class_name (void) const { return c_name; } | |
| 171 | |
| 172 static int static_type_id (void) { return t_id; } | |
| 173 static std::string static_type_name (void) { return t_name; } | |
| 174 static std::string static_class_name (void) { return "<unknown>"; } | |
| 175 static void register_type (void); | |
| 176 | |
| 177 private: | |
| 178 static int t_id; | |
| 179 | |
| 180 static const std::string t_name; | |
| 181 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
|
182 std::list<std::string> parent_list; |
| 7338 | 183 |
| 184 bool in_class_method (void) const; | |
| 9151 | 185 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
186 int obsolete_copies; |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
187 |
| 9151 | 188 public: |
| 189 // The list of field names and parent classes defines a class. We | |
| 190 // keep track of each class that has been created so that we know | |
| 191 class exemplar_info | |
| 192 { | |
| 193 public: | |
| 194 | |
| 195 exemplar_info (void) : field_names (), parent_class_names () { } | |
| 196 | |
| 197 exemplar_info (const octave_value& obj); | |
| 198 | |
| 199 exemplar_info (const exemplar_info& x) | |
| 200 : field_names (x.field_names), | |
| 201 parent_class_names (x.parent_class_names) { } | |
| 202 | |
| 203 exemplar_info& operator = (const exemplar_info& x) | |
| 204 { | |
| 205 if (&x != this) | |
| 206 { | |
| 207 field_names = x.field_names; | |
| 208 parent_class_names = x.parent_class_names; | |
| 209 } | |
| 210 return *this; | |
| 211 } | |
| 212 | |
| 213 octave_idx_type nfields (void) const { return field_names.length (); } | |
| 214 | |
| 215 size_t nparents (void) const { return parent_class_names.size (); } | |
| 216 | |
| 217 string_vector fields (void) const { return field_names; } | |
| 218 | |
| 219 std::list<std::string> parents (void) const { return parent_class_names; } | |
| 220 | |
| 221 bool compare (const octave_value& obj) const; | |
| 222 | |
| 223 private: | |
| 224 | |
| 225 string_vector field_names; | |
| 226 std::list<std::string> parent_class_names; | |
| 227 }; | |
| 228 | |
| 229 // A map from class names to lists of fields. | |
| 230 static std::map<std::string, exemplar_info> exemplar_map; | |
| 231 | |
| 232 typedef std::map<std::string, exemplar_info>::iterator exemplar_iterator; | |
| 233 typedef std::map<std::string, exemplar_info>::const_iterator exemplar_const_iterator; | |
| 7338 | 234 }; |
| 235 | |
| 236 #endif | |
| 237 | |
| 238 /* | |
| 239 ;;; Local Variables: *** | |
| 240 ;;; mode: C++ *** | |
| 241 ;;; End: *** | |
| 242 */ |