Mercurial > octave
annotate src/ov-class.h @ 8920:eb63fbe60fab
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sat, 07 Mar 2009 10:41:27 -0500 |
| parents | 70f5a0375afd |
| children | d865363208d6 |
| rev | line source |
|---|---|
| 7338 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2007, 2008, 2009 John W. Eaton |
| 7338 | 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 | |
| 7444 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 7338 | 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 | |
| 7444 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 7338 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_class_h) | |
| 24 #define octave_class_h 1 | |
| 25 | |
| 26 #include <cstdlib> | |
| 27 | |
| 28 #include <iostream> | |
| 29 #include <string> | |
| 30 | |
| 31 #include "mx-base.h" | |
| 32 #include "str-vec.h" | |
| 33 | |
| 34 #include "error.h" | |
| 35 #include "oct-alloc.h" | |
| 36 #include "oct-map.h" | |
| 37 #include "ov-base.h" | |
| 38 #include "ov-typeinfo.h" | |
| 39 | |
| 40 class octave_value_list; | |
| 41 | |
| 42 class tree_walker; | |
| 43 | |
| 44 // Data structures. | |
| 45 | |
| 46 class | |
| 47 octave_class : public octave_base_value | |
| 48 { | |
| 49 public: | |
| 50 | |
| 51 octave_class (void) | |
| 52 : octave_base_value () { } | |
| 53 | |
| 54 octave_class (const Octave_map& m, const std::string& id) | |
| 55 : octave_base_value (), map (m), c_name (id) { } | |
| 56 | |
| 57 octave_class (const octave_class& s) | |
| 58 : octave_base_value (s), map (s.map), c_name (s.c_name) { } | |
| 59 | |
| 60 ~octave_class (void) { } | |
| 61 | |
| 62 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
|
63 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
64 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
|
65 { |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
66 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
|
67 } |
| 7338 | 68 |
| 69 Cell dotref (const octave_value_list& idx); | |
| 70 | |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
71 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
|
72 const std::list<octave_value_list>& idx) |
| 7338 | 73 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
74 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
|
75 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 7338 | 76 } |
| 77 | |
| 78 octave_value_list subsref (const std::string& type, | |
| 79 const std::list<octave_value_list>& idx, | |
| 80 int nargout); | |
| 81 | |
| 82 static octave_value numeric_conv (const Cell& val, | |
| 83 const std::string& type); | |
| 84 | |
| 85 octave_value subsasgn (const std::string& type, | |
| 86 const std::list<octave_value_list>& idx, | |
| 87 const octave_value& rhs); | |
| 88 | |
|
8154
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
89 idx_vector index_vector (void) const; |
|
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
90 |
| 7338 | 91 dim_vector dims (void) const { return map.dims (); } |
| 92 | |
| 93 size_t byte_size (void) const; | |
| 94 | |
| 95 // This is the number of elements in each field. The total number | |
| 96 // of elements is numel () * nfields (). | |
| 97 octave_idx_type numel (void) const | |
| 98 { | |
| 99 dim_vector dv = dims (); | |
| 100 return dv.numel (); | |
| 101 } | |
| 102 | |
| 103 octave_idx_type nfields (void) const { return map.nfields (); } | |
| 104 | |
| 105 octave_value reshape (const dim_vector& new_dims) const | |
| 106 { return map.reshape (new_dims); } | |
| 107 | |
| 108 octave_value resize (const dim_vector& dv, bool = false) const | |
| 109 { Octave_map tmap = map; tmap.resize (dv); return tmap; } | |
| 110 | |
| 111 bool is_defined (void) const { return true; } | |
| 112 | |
| 113 bool is_map (void) const { return false; } | |
| 114 | |
| 115 bool is_object (void) const { return true; } | |
| 116 | |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
117 Octave_map map_value (void) const { return map; } |
| 7338 | 118 |
| 119 string_vector map_keys (void) const; | |
| 120 | |
| 121 void print (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 122 | |
| 123 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 124 | |
| 125 bool print_name_tag (std::ostream& os, const std::string& name) const; | |
| 126 | |
| 127 void print_with_name (std::ostream& os, const std::string& name, | |
| 128 bool print_padding = true) const; | |
| 129 | |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
130 bool save_ascii (std::ostream& os); |
| 7338 | 131 |
| 132 bool load_ascii (std::istream& is); | |
| 133 | |
| 134 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 135 | |
| 136 bool load_binary (std::istream& is, bool swap, | |
| 137 oct_mach_info::float_format fmt); | |
| 138 | |
| 139 #if defined (HAVE_HDF5) | |
| 140 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 141 | |
| 142 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
| 143 #endif | |
| 144 | |
| 145 mxArray *as_mxArray (void) const; | |
| 146 | |
| 147 private: | |
| 148 | |
| 149 Octave_map map; | |
| 150 | |
| 151 DECLARE_OCTAVE_ALLOCATOR | |
| 152 | |
| 153 public: | |
| 154 int type_id (void) const { return t_id; } | |
| 155 std::string type_name (void) const { return t_name; } | |
| 156 std::string class_name (void) const { return c_name; } | |
| 157 | |
| 158 static int static_type_id (void) { return t_id; } | |
| 159 static std::string static_type_name (void) { return t_name; } | |
| 160 static std::string static_class_name (void) { return "<unknown>"; } | |
| 161 static void register_type (void); | |
| 162 | |
| 163 private: | |
| 164 static int t_id; | |
| 165 | |
| 166 static const std::string t_name; | |
| 167 std::string c_name; | |
| 168 | |
| 169 bool in_class_method (void) const; | |
| 170 }; | |
| 171 | |
| 172 #endif | |
| 173 | |
| 174 /* | |
| 175 ;;; Local Variables: *** | |
| 176 ;;; mode: C++ *** | |
| 177 ;;; End: *** | |
| 178 */ |