Mercurial > hg > octave-lyh
annotate libinterp/octave-value/ov-cell.h @ 17482:997b700b6ad4
compass.m: Add %!error input validation tests.
* scripts/plot/compass.m: Add %!error input validation tests.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 24 Sep 2013 13:17:02 -0700 |
| parents | 1785493171ac |
| children |
| rev | line source |
|---|---|
| 3353 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
3 Copyright (C) 1999-2012 John W. Eaton |
| 11523 | 4 Copyright (C) 2009-2010 VZLU Prague |
| 3353 | 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. | |
| 3353 | 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/>. | |
| 3353 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_cell_h) | |
| 25 #define octave_cell_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> |
| 3353 | 30 #include <string> |
|
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
31 #include <memory> |
| 3353 | 32 |
| 33 #include "mx-base.h" | |
| 34 #include "oct-alloc.h" | |
| 35 #include "str-vec.h" | |
| 36 | |
| 37 #include "Cell.h" | |
| 38 #include "error.h" | |
| 3928 | 39 #include "ov-base-mat.h" |
| 3353 | 40 #include "ov-typeinfo.h" |
| 41 | |
| 42 class octave_value_list; | |
| 43 | |
| 44 class tree_walker; | |
| 45 | |
| 46 // Cells. | |
| 47 | |
| 48 class | |
| 3928 | 49 octave_cell : public octave_base_matrix<Cell> |
| 3353 | 50 { |
| 51 public: | |
| 52 | |
| 53 octave_cell (void) | |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
54 : octave_base_matrix<Cell> (), cellstr_cache () { } |
| 3353 | 55 |
| 56 octave_cell (const Cell& c) | |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
57 : octave_base_matrix<Cell> (c), cellstr_cache () { } |
| 3353 | 58 |
|
8825
c3445f1c8cb4
reuse cellstr cache in strcmp
Jaroslav Hajek <highegg@gmail.com>
parents:
8823
diff
changeset
|
59 octave_cell (const Array<std::string>& str) |
|
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
60 : octave_base_matrix<Cell> (Cell (str)), cellstr_cache (new Array<std::string> (str)) { } |
|
8825
c3445f1c8cb4
reuse cellstr cache in strcmp
Jaroslav Hajek <highegg@gmail.com>
parents:
8823
diff
changeset
|
61 |
| 3353 | 62 octave_cell (const octave_cell& c) |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
63 : octave_base_matrix<Cell> (c), cellstr_cache () { } |
| 3353 | 64 |
| 65 ~octave_cell (void) { } | |
| 66 | |
| 5759 | 67 octave_base_value *clone (void) const { return new octave_cell (*this); } |
| 68 octave_base_value *empty_clone (void) const { return new octave_cell (); } | |
| 3353 | 69 |
| 3928 | 70 #if 0 |
| 5759 | 71 octave_base_value *try_narrowing_conversion (void); |
| 3928 | 72 #endif |
| 73 | |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7622
diff
changeset
|
74 octave_value subsref (const std::string& type, |
| 10313 | 75 const std::list<octave_value_list>& idx) |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7622
diff
changeset
|
76 { |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7622
diff
changeset
|
77 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:
7622
diff
changeset
|
78 return tmp.length () > 0 ? tmp(0) : octave_value (); |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7622
diff
changeset
|
79 } |
|
7622
c195bd0a5c64
treat structs and cells as "constants"
John W. Eaton <jwe@octave.org>
parents:
7530
diff
changeset
|
80 |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7622
diff
changeset
|
81 octave_value_list subsref (const std::string& type, |
|
16091
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
82 const std::list<octave_value_list>& idx, |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
83 int nargout) |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
84 { |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
85 return subsref (type, idx, nargout, 0); |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
86 } |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
87 |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
88 octave_value_list subsref (const std::string& type, |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
89 const std::list<octave_value_list>& idx, |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
90 int nargout, |
|
1785493171ac
pass lvalue_list to more subsref calls (bug #38374)
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
91 const std::list<octave_lvalue> *lvalue_list); |
| 4271 | 92 |
|
8551
906f976d35a8
further improve struct&cell indexing & indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
7651
diff
changeset
|
93 octave_value subsref (const std::string& type, |
| 10313 | 94 const std::list<octave_value_list>& idx, |
|
8551
906f976d35a8
further improve struct&cell indexing & indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
7651
diff
changeset
|
95 bool auto_add); |
|
906f976d35a8
further improve struct&cell indexing & indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
7651
diff
changeset
|
96 |
| 4247 | 97 octave_value subsasgn (const std::string& type, |
| 10313 | 98 const std::list<octave_value_list>& idx, |
| 99 const octave_value& rhs); | |
| 3933 | 100 |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
101 void assign (const octave_value_list& idx, const Cell& rhs); |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
102 |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
103 void assign (const octave_value_list& idx, const octave_value& rhs); |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
104 |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
105 void delete_elements (const octave_value_list& idx); |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
106 |
| 4791 | 107 size_t byte_size (void) const; |
| 108 | |
| 8732 | 109 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; |
| 110 | |
| 111 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, | |
| 10313 | 112 sortmode mode = ASCENDING) const; |
| 8732 | 113 |
|
8823
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
114 sortmode is_sorted (sortmode mode = UNSORTED) const; |
|
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
115 |
|
8733
3ef774603887
rename all uses of sortrows_idx to sort_rows_idx
John W. Eaton <jwe@octave.org>
parents:
8732
diff
changeset
|
116 Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const; |
| 8732 | 117 |
|
8823
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
118 sortmode is_sorted_rows (sortmode mode = UNSORTED) const; |
|
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
119 |
| 4645 | 120 bool is_matrix_type (void) const { return false; } |
| 121 | |
| 4370 | 122 bool is_numeric_type (void) const { return false; } |
| 123 | |
| 3928 | 124 bool is_defined (void) const { return true; } |
| 3353 | 125 |
|
7622
c195bd0a5c64
treat structs and cells as "constants"
John W. Eaton <jwe@octave.org>
parents:
7530
diff
changeset
|
126 bool is_constant (void) const { return true; } |
| 4994 | 127 |
| 3724 | 128 bool is_cell (void) const { return true; } |
| 129 | |
|
10087
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10065
diff
changeset
|
130 builtin_type_t builtin_type (void) const { return btyp_cell; } |
|
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10065
diff
changeset
|
131 |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
132 bool is_cellstr (void) const; |
| 6116 | 133 |
|
8626
1dce30ab0e72
don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents:
8551
diff
changeset
|
134 bool is_true (void) const; |
|
1dce30ab0e72
don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents:
8551
diff
changeset
|
135 |
| 3928 | 136 Cell cell_value (void) const { return matrix; } |
| 3353 | 137 |
| 3933 | 138 octave_value_list list_value (void) const; |
| 139 | |
| 5715 | 140 octave_value convert_to_str_internal (bool pad, bool, char type) const |
| 141 { return octave_value (all_strings (pad), type); } | |
| 4358 | 142 |
| 5715 | 143 string_vector all_strings (bool pad = false) const; |
| 4243 | 144 |
| 8732 | 145 Array<std::string> cellstr_value (void) const; |
| 146 | |
| 4604 | 147 bool print_as_scalar (void) const; |
| 148 | |
| 3933 | 149 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 150 | |
| 151 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 152 | |
| 4687 | 153 |
| 6974 | 154 bool save_ascii (std::ostream& os); |
| 4687 | 155 |
| 156 bool load_ascii (std::istream& is); | |
| 157 | |
| 158 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 159 | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
160 bool load_binary (std::istream& is, bool swap, |
| 10313 | 161 oct_mach_info::float_format fmt); |
| 4687 | 162 |
| 163 #if defined (HAVE_HDF5) | |
| 164 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 165 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9813
diff
changeset
|
166 bool load_hdf5 (hid_t loc_id, const char *name); |
| 4687 | 167 #endif |
| 168 | |
|
9813
8fa32b527d9a
improve & partially revert previous change
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
169 octave_value map (unary_mapper_t umap) const; |
|
7530
bb0f2353cff5
new cell array ctype mappers
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
170 |
| 5900 | 171 mxArray *as_mxArray (void) const; |
| 172 | |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
173 // Unsafe. This function exists to support the MEX interface. |
|
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
174 // You should not use it anywhere else. |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
175 void *mex_get_data (void) const; |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
176 |
| 3353 | 177 private: |
| 4612 | 178 |
|
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
179 void clear_cellstr_cache (void) const |
|
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
180 { cellstr_cache.reset (); } |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
181 |
|
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
182 mutable std::auto_ptr<Array<std::string> > cellstr_cache; |
|
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
183 |
| 3353 | 184 DECLARE_OCTAVE_ALLOCATOR |
| 185 | |
| 186 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA | |
| 187 }; | |
| 188 | |
| 189 #endif |