Mercurial > octave
annotate libinterp/octave-value/ov-str-mat.h @ 24668:d4dd741b2794
new octave_value functions for formatting output
* ov.h, ov.cc, ov-base.h, ov-base.cc, and numeric/matrix-like objects:
(get_edit_display_format): New function.
(edit_display): Pass float_display_format as argument.
* pr-output.h, pr-output.cc: New variants of the octave_print_internal
functions that accept display formats. Expose functions for getting
display formats.
* variable-editor-model.cc: Maintain display format for model.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 01 Feb 2018 06:36:50 -0500 |
parents | 3ceee1910e1a |
children | 6652d3823428 |
rev | line source |
---|---|
2376 | 1 /* |
2 | |
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
3 Copyright (C) 1996-2017 John W. Eaton |
11523 | 4 Copyright (C) 2009-2010 VZLU Prague |
2376 | 5 |
6 This file is part of Octave. | |
7 | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23586
diff
changeset
|
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 |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23586
diff
changeset
|
10 the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
11 (at your option) any later version. |
2376 | 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. |
2376 | 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 |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23586
diff
changeset
|
20 <https://www.gnu.org/licenses/>. |
2376 | 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_str_mat_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_str_mat_h 1 |
2376 | 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 |
2376 | 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> |
2376 | 32 #include <string> |
33 | |
34 #include "mx-base.h" | |
35 #include "str-vec.h" | |
36 | |
37 #include "error.h" | |
4944 | 38 #include "oct-stream.h" |
3202 | 39 #include "ov.h" |
9689
34d6f005db4b
eliminate is_string argument from octave_value character array constructors
John W. Eaton <jwe@octave.org>
parents:
9688
diff
changeset
|
40 #include "ov-ch-mat.h" |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
41 #include "ov-re-mat.h" |
2376 | 42 #include "ov-typeinfo.h" |
43 | |
44 class octave_value_list; | |
45 | |
2477 | 46 // Character matrix values with special properties for use as |
47 // strings. | |
2376 | 48 |
49 class | |
6109 | 50 OCTINTERP_API |
2376 | 51 octave_char_matrix_str : public octave_char_matrix |
52 { | |
53 public: | |
54 | |
55 octave_char_matrix_str (void) | |
56 : octave_char_matrix () { } | |
57 | |
58 octave_char_matrix_str (const charMatrix& chm) | |
59 : octave_char_matrix (chm) { } | |
60 | |
4513 | 61 octave_char_matrix_str (const charNDArray& chm) |
62 : octave_char_matrix (chm) { } | |
63 | |
10351
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
64 octave_char_matrix_str (const Array<char>& chm) |
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
65 : octave_char_matrix (chm) { } |
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
66 |
3189 | 67 octave_char_matrix_str (char c) |
68 : octave_char_matrix (c) { } | |
69 | |
2376 | 70 octave_char_matrix_str (const char *s) |
71 : octave_char_matrix (s) { } | |
72 | |
3523 | 73 octave_char_matrix_str (const std::string& s) |
2376 | 74 : octave_char_matrix (s) { } |
75 | |
76 octave_char_matrix_str (const string_vector& s) | |
77 : octave_char_matrix (s) { } | |
78 | |
79 octave_char_matrix_str (const octave_char_matrix& chm) | |
80 : octave_char_matrix (chm) { } | |
81 | |
82 octave_char_matrix_str (const octave_char_matrix_str& chms) | |
83 : octave_char_matrix (chms) { } | |
84 | |
22868
87e3163f6c87
use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
85 ~octave_char_matrix_str (void) = default; |
2376 | 86 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
87 octave_base_value * clone (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
88 { return new octave_char_matrix_str (*this); } |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
89 octave_base_value * empty_clone (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
90 { return new octave_char_matrix_str (); } |
2376 | 91 |
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8168
diff
changeset
|
92 type_conv_info numeric_conversion_function (void) const; |
2376 | 93 |
5885 | 94 octave_value do_index_op (const octave_value_list& idx, |
10313 | 95 bool resize_ok = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
96 { return do_index_op_internal (idx, resize_ok); } |
2407 | 97 |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
98 octave_value squeeze (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
99 { return octave_value (charNDArray (matrix.squeeze ())); } |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
100 |
4569 | 101 octave_value reshape (const dim_vector& new_dims) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
102 { return octave_value (charNDArray (matrix.reshape (new_dims))); } |
4569 | 103 |
5533 | 104 octave_value permute (const Array<int>& vec, bool inv = false) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
105 { return octave_value (charNDArray (matrix.permute (vec, inv))); } |
5533 | 106 |
5731 | 107 octave_value resize (const dim_vector& dv, bool fill = false) const; |
5533 | 108 |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
109 octave_value diag (octave_idx_type k = 0) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
110 { return octave_value (matrix.diag (k)); } |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
111 |
2376 | 112 bool is_string (void) const { return true; } |
113 | |
23586
f6c5db0a02e7
maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents:
23446
diff
changeset
|
114 bool isnumeric (void) const { return false; } |
3221 | 115 |
4643 | 116 double double_value (bool = false) const; |
117 | |
2376 | 118 Matrix matrix_value (bool = false) const; |
119 | |
4668 | 120 NDArray array_value (bool = false) const; |
121 | |
122 Complex complex_value (bool = false) const; | |
123 | |
124 ComplexMatrix complex_matrix_value (bool = false) const; | |
125 | |
126 ComplexNDArray complex_array_value (bool = false) const; | |
127 | |
20990
fc9cca99b2de
Deprecate all_strings, replace with string_vector_value.
Rik <rik@octave.org>
parents:
20791
diff
changeset
|
128 string_vector string_vector_value (bool pad = false) const; |
2376 | 129 |
4457 | 130 std::string string_value (bool force = false) const; |
2376 | 131 |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20681
diff
changeset
|
132 std::string xstring_value (void) const { return string_value (); } |
20576
40ed9b46a800
new octave_value::string_value method with optional error message
John W. Eaton <jwe@octave.org>
parents:
19863
diff
changeset
|
133 |
10729
172253d75d94
implement cellstr extractors for char matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
134 Array<std::string> cellstr_value (void) const; |
172253d75d94
implement cellstr extractors for char matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
135 |
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7433
diff
changeset
|
136 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
137 { return octave_value (matrix.sort (dim, mode)); } |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
138 |
7433 | 139 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, |
10313 | 140 sortmode mode = ASCENDING) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
141 { return octave_value (matrix.sort (sidx, dim, mode)); } |
7433 | 142 |
3219 | 143 bool print_as_scalar (void) const { return (rows () <= 1); } |
2901 | 144 |
3523 | 145 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
2901 | 146 |
17870 | 147 void short_disp (std::ostream& os) const; |
17825
53f433bae63b
display (possibly truncated) values of strings in workspace view
John W. Eaton <jwe@octave.org>
parents:
17822
diff
changeset
|
148 |
24668
d4dd741b2794
new octave_value functions for formatting output
John W. Eaton <jwe@octave.org>
parents:
24655
diff
changeset
|
149 std::string edit_display (const float_display_format& fmt, |
d4dd741b2794
new octave_value functions for formatting output
John W. Eaton <jwe@octave.org>
parents:
24655
diff
changeset
|
150 octave_idx_type i, octave_idx_type j) const; |
24655
3ceee1910e1a
allow single character strings to be edited (bug #51848)
John W. Eaton <jwe@octave.org>
parents:
24534
diff
changeset
|
151 |
6974 | 152 bool save_ascii (std::ostream& os); |
4687 | 153 |
154 bool load_ascii (std::istream& is); | |
155 | |
156 bool save_binary (std::ostream& os, bool& save_as_floats); | |
157 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
158 bool load_binary (std::istream& is, bool swap, |
21739
c4ab2e54f100
use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
159 octave::mach_info::float_format fmt); |
4687 | 160 |
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
|
161 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); |
4687 | 162 |
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
|
163 bool load_hdf5 (octave_hdf5_id loc_id, const char *name); |
4687 | 164 |
23059
b98ebcd7f11c
move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
165 int write (octave::stream& os, int block_size, |
10313 | 166 oct_data_conv::data_type output_type, int skip, |
21739
c4ab2e54f100
use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
167 octave::mach_info::float_format flt_fmt) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
168 { return os.write (matrix, block_size, output_type, skip, flt_fmt); } |
4944 | 169 |
5400 | 170 protected: |
171 | |
172 octave_value do_index_op_internal (const octave_value_list& idx, | |
10313 | 173 bool resize_ok, char type = '"'); |
5400 | 174 |
2376 | 175 private: |
176 | |
3219 | 177 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
2376 | 178 }; |
179 | |
5279 | 180 typedef octave_char_matrix_str octave_char_matrix_dq_str; |
181 | |
182 class | |
183 octave_char_matrix_sq_str : public octave_char_matrix_str | |
184 { | |
185 public: | |
186 | |
187 octave_char_matrix_sq_str (void) | |
188 : octave_char_matrix_str () { } | |
189 | |
190 octave_char_matrix_sq_str (const charMatrix& chm) | |
191 : octave_char_matrix_str (chm) { } | |
192 | |
193 octave_char_matrix_sq_str (const charNDArray& chm) | |
194 : octave_char_matrix_str (chm) { } | |
195 | |
10351
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
196 octave_char_matrix_sq_str (const Array<char>& chm) |
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
197 : octave_char_matrix_str (chm) { } |
5150ceb4dbb4
base charMatrix and boolMatrix on Array<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
198 |
5279 | 199 octave_char_matrix_sq_str (char c) |
200 : octave_char_matrix_str (c) { } | |
201 | |
202 octave_char_matrix_sq_str (const char *s) | |
203 : octave_char_matrix_str (s) { } | |
204 | |
205 octave_char_matrix_sq_str (const std::string& s) | |
206 : octave_char_matrix_str (s) { } | |
207 | |
208 octave_char_matrix_sq_str (const string_vector& s) | |
209 : octave_char_matrix_str (s) { } | |
210 | |
211 octave_char_matrix_sq_str (const octave_char_matrix_str& chm) | |
212 : octave_char_matrix_str (chm) { } | |
213 | |
214 octave_char_matrix_sq_str (const octave_char_matrix_sq_str& chms) | |
215 : octave_char_matrix_str (chms) { } | |
216 | |
22868
87e3163f6c87
use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
217 ~octave_char_matrix_sq_str (void) = default; |
5279 | 218 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
219 octave_base_value * clone (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
220 { return new octave_char_matrix_sq_str (*this); } |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
221 octave_base_value * empty_clone (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
222 { return new octave_char_matrix_sq_str (); } |
5279 | 223 |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
224 octave_value squeeze (void) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
225 { return octave_value (charNDArray (matrix.squeeze ()), '\''); } |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
226 |
5533 | 227 octave_value reshape (const dim_vector& new_dims) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
228 { return octave_value (charNDArray (matrix.reshape (new_dims)), '\''); } |
5533 | 229 |
230 octave_value permute (const Array<int>& vec, bool inv = false) const | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
231 { return octave_value (charNDArray (matrix.permute (vec, inv)), '\''); } |
5533 | 232 |
5890 | 233 octave_value resize (const dim_vector& dv, bool = false) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
234 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
235 charNDArray retval (matrix); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
236 retval.resize (dv); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
237 return octave_value (retval, '\''); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
238 } |
5533 | 239 |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
240 octave_value diag (octave_idx_type k = 0) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
241 { return octave_value (matrix.diag (k), '\''); } |
9688
90abfd8a2895
make squeeze and diag return char for char argument
John W. Eaton <jwe@octave.org>
parents:
8950
diff
changeset
|
242 |
5279 | 243 bool is_sq_string (void) const { return true; } |
244 | |
5885 | 245 octave_value do_index_op (const octave_value_list& idx, |
10313 | 246 bool resize_ok = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
247 { return do_index_op_internal (idx, resize_ok, '\''); } |
5400 | 248 |
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7433
diff
changeset
|
249 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
250 { return octave_value (matrix.sort (dim, mode), '\''); } |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
251 |
7433 | 252 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, |
10313 | 253 sortmode mode = ASCENDING) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
254 { return octave_value (matrix.sort (sidx, dim, mode), '\''); } |
7433 | 255 |
5279 | 256 private: |
257 | |
258 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA | |
259 }; | |
260 | |
2376 | 261 #endif |