Mercurial > octave
annotate libinterp/octave-value/ov-cell.h @ 23576:00e518162fda
maint: Deprecate is_cell and replace with iscell.
* ov.h (is_cell): Use OCTAVE_DEPRECATED macro around is_cell function.
* ov.h (iscell): New function.
* cellfun.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, graphics.cc,
graphics.in.h, ls-mat5.cc, lsode.cc, mex.cc, mxarray.in.h, oct-stream.cc,
regexp.cc, str2double.cc, strfind.cc, strfns.cc, utils.cc, ov-base.h,
ov-cell.cc, ov-cell.h, ov-class.cc, ov-classdef.cc, ov-java.cc, ov-struct.cc,
ov.cc, ovl.cc, bp-table.cc, pt-cell.h, pt-eval.cc, pt-exp.h, pt-idx.cc,
pt-tm-const.cc: Replace instances of is_cell with iscell.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 11 Jun 2017 15:35:21 -0700 |
parents | e95738a119da |
children | f6c5db0a02e7 |
rev | line source |
---|---|
3353 | 1 /* |
2 | |
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
3 Copyright (C) 1999-2017 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 | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
9 under the terms of the GNU General Public License as published by |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
10 the Free Software Foundation; either version 3 of the License, or |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
11 (at your option) any later version. |
3353 | 12 |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
13 Octave is distributed in the hope that it will be useful, but |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
14 WITHOUT ANY WARRANTY; without even the implied warranty of |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
16 GNU General Public License for more details. |
3353 | 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 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
20700
diff
changeset
|
24 #if ! defined (octave_ov_cell_h) |
17822
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
25 #define octave_ov_cell_h 1 |
3353 | 26 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20990
diff
changeset
|
27 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20990
diff
changeset
|
28 |
3353 | 29 #include <cstdlib> |
30 | |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
31 #include <iosfwd> |
3353 | 32 #include <string> |
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
33 #include <memory> |
3353 | 34 |
35 #include "mx-base.h" | |
36 #include "str-vec.h" | |
37 | |
38 #include "Cell.h" | |
39 #include "error.h" | |
3928 | 40 #include "ov-base-mat.h" |
3353 | 41 #include "ov-typeinfo.h" |
42 | |
43 class octave_value_list; | |
44 | |
45 // Cells. | |
46 | |
47 class | |
3928 | 48 octave_cell : public octave_base_matrix<Cell> |
3353 | 49 { |
50 public: | |
51 | |
52 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
|
53 : octave_base_matrix<Cell> (), cellstr_cache () { } |
3353 | 54 |
55 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
|
56 : octave_base_matrix<Cell> (c), cellstr_cache () { } |
3353 | 57 |
8825
c3445f1c8cb4
reuse cellstr cache in strcmp
Jaroslav Hajek <highegg@gmail.com>
parents:
8823
diff
changeset
|
58 octave_cell (const Array<std::string>& str) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
59 : octave_base_matrix<Cell> (Cell (str)), |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
60 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 |
22868
87e3163f6c87
use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
65 ~octave_cell (void) = default; |
3353 | 66 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23350
diff
changeset
|
67 octave_base_value * clone (void) const { return new octave_cell (*this); } |
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23350
diff
changeset
|
68 octave_base_value * empty_clone (void) const { return new octave_cell (); } |
3353 | 69 |
3928 | 70 #if 0 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23350
diff
changeset
|
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) |
17787
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 octave_value_list tmp = subsref (type, idx, 1); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
78 return tmp.length () > 0 ? tmp(0) : octave_value (); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
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, |
23481
73558a835b64
eliminate lvalue list arguments from evaluator functions
John W. Eaton <jwe@octave.org>
parents:
23446
diff
changeset
|
83 int nargout); |
4271 | 84 |
8551
906f976d35a8
further improve struct&cell indexing & indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
7651
diff
changeset
|
85 octave_value subsref (const std::string& type, |
10313 | 86 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
|
87 bool auto_add); |
906f976d35a8
further improve struct&cell indexing & indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
7651
diff
changeset
|
88 |
4247 | 89 octave_value subsasgn (const std::string& type, |
10313 | 90 const std::list<octave_value_list>& idx, |
91 const octave_value& rhs); | |
3933 | 92 |
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
93 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
|
94 |
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
95 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
|
96 |
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
97 void delete_elements (const octave_value_list& idx); |
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
98 |
4791 | 99 size_t byte_size (void) const; |
100 | |
8732 | 101 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; |
102 | |
103 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, | |
10313 | 104 sortmode mode = ASCENDING) const; |
8732 | 105 |
8823
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
106 sortmode is_sorted (sortmode mode = UNSORTED) const; |
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
107 |
8733
3ef774603887
rename all uses of sortrows_idx to sort_rows_idx
John W. Eaton <jwe@octave.org>
parents:
8732
diff
changeset
|
108 Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const; |
8732 | 109 |
8823
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
110 sortmode is_sorted_rows (sortmode mode = UNSORTED) const; |
3efa512a0957
make issorted work for cells
Jaroslav Hajek <highegg@gmail.com>
parents:
8815
diff
changeset
|
111 |
4645 | 112 bool is_matrix_type (void) const { return false; } |
113 | |
4370 | 114 bool is_numeric_type (void) const { return false; } |
115 | |
3928 | 116 bool is_defined (void) const { return true; } |
3353 | 117 |
7622
c195bd0a5c64
treat structs and cells as "constants"
John W. Eaton <jwe@octave.org>
parents:
7530
diff
changeset
|
118 bool is_constant (void) const { return true; } |
4994 | 119 |
23576
00e518162fda
maint: Deprecate is_cell and replace with iscell.
Rik <rik@octave.org>
parents:
23575
diff
changeset
|
120 bool iscell (void) const { return true; } |
3724 | 121 |
10087
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10065
diff
changeset
|
122 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
|
123 |
23575
e95738a119da
maint: Deprecate is_cellstr and replace with iscellstr.
Rik <rik@octave.org>
parents:
23534
diff
changeset
|
124 bool iscellstr (void) const; |
6116 | 125 |
8626
1dce30ab0e72
don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents:
8551
diff
changeset
|
126 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
|
127 |
3928 | 128 Cell cell_value (void) const { return matrix; } |
3353 | 129 |
3933 | 130 octave_value_list list_value (void) const; |
131 | |
5715 | 132 octave_value convert_to_str_internal (bool pad, bool, char type) const |
20990
fc9cca99b2de
Deprecate all_strings, replace with string_vector_value.
Rik <rik@octave.org>
parents:
20791
diff
changeset
|
133 { return octave_value (string_vector_value (pad), type); } |
4358 | 134 |
20990
fc9cca99b2de
Deprecate all_strings, replace with string_vector_value.
Rik <rik@octave.org>
parents:
20791
diff
changeset
|
135 string_vector string_vector_value (bool pad = false) const; |
4243 | 136 |
8732 | 137 Array<std::string> cellstr_value (void) const; |
138 | |
20681
b0b37f0d7e6d
new cellstr_value function and elimination of error_state
John W. Eaton <jwe@octave.org>
parents:
20583
diff
changeset
|
139 Array<std::string> cellstr_value (const char *fmt, ...) const; |
b0b37f0d7e6d
new cellstr_value function and elimination of error_state
John W. Eaton <jwe@octave.org>
parents:
20583
diff
changeset
|
140 |
4604 | 141 bool print_as_scalar (void) const; |
142 | |
18416
bcd71a2531d3
Support disp/display overloading in classdef
Michael Goffioul <michael.goffioul@gmail.com>
parents:
17870
diff
changeset
|
143 void print (std::ostream& os, bool pr_as_read_syntax = false); |
3933 | 144 |
145 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
146 | |
23350
0f18524973eb
Fix initial newline for disp() of cells (bug #50683).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
147 bool print_name_tag (std::ostream& os, const std::string& name) const; |
0f18524973eb
Fix initial newline for disp() of cells (bug #50683).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
148 |
17870 | 149 void short_disp (std::ostream& os) const; |
4687 | 150 |
6974 | 151 bool save_ascii (std::ostream& os); |
4687 | 152 |
153 bool load_ascii (std::istream& is); | |
154 | |
155 bool save_binary (std::ostream& os, bool& save_as_floats); | |
156 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
157 bool load_binary (std::istream& is, bool swap, |
21739
c4ab2e54f100
use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents:
21307
diff
changeset
|
158 octave::mach_info::float_format fmt); |
4687 | 159 |
19863
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19697
diff
changeset
|
160 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); |
4687 | 161 |
19863
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19697
diff
changeset
|
162 bool load_hdf5 (octave_hdf5_id loc_id, const char *name); |
4687 | 163 |
9813
8fa32b527d9a
improve & partially revert previous change
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
164 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
|
165 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23350
diff
changeset
|
166 mxArray * as_mxArray (void) const; |
5900 | 167 |
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
168 // 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
|
169 // You should not use it anywhere else. |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23350
diff
changeset
|
170 void * mex_get_data (void) const; |
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
171 |
3353 | 172 private: |
4612 | 173 |
10065
64a06079cae4
improve cellstr cache implementation
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
174 void clear_cellstr_cache (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
175 { cellstr_cache.reset (); } |
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
176 |
23534
b6498c088fca
maint: Don't write '> >' for declaration of templates that use templates.
Rik <rik@octave.org>
parents:
23481
diff
changeset
|
177 mutable std::unique_ptr<Array<std::string>> cellstr_cache; |
8815
af907aeedbf4
cache cellstr_value in ov-cell
Jaroslav Hajek <highegg@gmail.com>
parents:
8733
diff
changeset
|
178 |
3353 | 179 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
180 }; | |
181 | |
182 #endif |