Mercurial > octave
annotate libinterp/octave-value/ov-base-scalar.h @ 28641:2c15231c3154
new typedefs for octave_value matrix and scalar types
* ov-base-mat.h (octave_base_matrix<T>::object_type): New typedef.
* ov-base-scalar.h (octave_base_scalar<T>::object_type): Likewise.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 19 Aug 2020 23:42:05 -0400 |
parents | bd51beb6205e |
children | 853e60367cb6 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 //////////////////////////////////////////////////////////////////////// |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
3 // Copyright (C) 1996-2020 The Octave Project Developers |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
4 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 // See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 // distribution or <https://octave.org/copyright/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 // This file is part of Octave. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
9 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
10 // Octave is free software: you can redistribute it and/or modify it |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
11 // under the terms of the GNU General Public License as published by |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
12 // the Free Software Foundation, either version 3 of the License, or |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
13 // (at your option) any later version. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
14 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
15 // Octave is distributed in the hope that it will be useful, but |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
16 // WITHOUT ANY WARRANTY; without even the implied warranty of |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
18 // GNU General Public License for more details. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
19 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
20 // You should have received a copy of the GNU General Public License |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
21 // along with Octave; see the file COPYING. If not, see |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
22 // <https://www.gnu.org/licenses/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 //////////////////////////////////////////////////////////////////////// |
3278 | 25 |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
26 #if ! defined (octave_ov_base_scalar_h) |
17822
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
27 #define octave_ov_base_scalar_h 1 |
3278 | 28 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21139
diff
changeset
|
29 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21139
diff
changeset
|
30 |
3278 | 31 #include <cstdlib> |
32 | |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
33 #include <iosfwd> |
3278 | 34 #include <string> |
35 | |
36 #include "lo-mappers.h" | |
37 #include "lo-utils.h" | |
38 #include "str-vec.h" | |
6376 | 39 #include "MatrixType.h" |
3278 | 40 |
41 #include "ov-base.h" | |
42 #include "ov-typeinfo.h" | |
43 | |
44 // Real scalar values. | |
45 | |
21139
538b57866b90
consistently use "typename" intead of "class" in template declarations
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
46 template <typename ST> |
3278 | 47 class |
48 octave_base_scalar : public octave_base_value | |
49 { | |
50 public: | |
51 | |
28641
2c15231c3154
new typedefs for octave_value matrix and scalar types
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
52 typedef ST scalar_type; |
2c15231c3154
new typedefs for octave_value matrix and scalar types
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
53 |
3278 | 54 octave_base_scalar (void) |
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11570
diff
changeset
|
55 : octave_base_value (), scalar () { } |
3278 | 56 |
9686
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
57 octave_base_scalar (const ST& s) |
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
58 : octave_base_value (), scalar (s) { } |
3278 | 59 |
60 octave_base_scalar (const octave_base_scalar& s) | |
9686
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
61 : octave_base_value (), scalar (s.scalar) { } |
3278 | 62 |
22868
87e3163f6c87
use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
63 ~octave_base_scalar (void) = default; |
3278 | 64 |
4759 | 65 octave_value squeeze (void) const { return scalar; } |
66 | |
8458
d254a21e0120
reimplement full as method of octave_base_value
Jaroslav Hajek <highegg@gmail.com>
parents:
8307
diff
changeset
|
67 octave_value full_value (void) const { return scalar; } |
d254a21e0120
reimplement full as method of octave_base_value
Jaroslav Hajek <highegg@gmail.com>
parents:
8307
diff
changeset
|
68 |
26916
9cd4b045fe3d
avoid some overloaded virtual warnings (bug #55741)
John W. Eaton <jwe@octave.org>
parents:
26386
diff
changeset
|
69 // We don't need to override all three forms of subsref. The using |
9cd4b045fe3d
avoid some overloaded virtual warnings (bug #55741)
John W. Eaton <jwe@octave.org>
parents:
26386
diff
changeset
|
70 // declaration will avoid warnings about partially-overloaded virtual |
9cd4b045fe3d
avoid some overloaded virtual warnings (bug #55741)
John W. Eaton <jwe@octave.org>
parents:
26386
diff
changeset
|
71 // functions. |
9cd4b045fe3d
avoid some overloaded virtual warnings (bug #55741)
John W. Eaton <jwe@octave.org>
parents:
26386
diff
changeset
|
72 using octave_base_value::subsref; |
9cd4b045fe3d
avoid some overloaded virtual warnings (bug #55741)
John W. Eaton <jwe@octave.org>
parents:
26386
diff
changeset
|
73 |
4247 | 74 octave_value subsref (const std::string& type, |
10313 | 75 const std::list<octave_value_list>& idx); |
3933 | 76 |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7620
diff
changeset
|
77 octave_value_list subsref (const std::string& type, |
10313 | 78 const std::list<octave_value_list>& idx, int) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 { return subsref (type, idx); } |
4271 | 80 |
4247 | 81 octave_value subsasgn (const std::string& type, |
10313 | 82 const std::list<octave_value_list>& idx, |
83 const octave_value& rhs); | |
3933 | 84 |
3278 | 85 bool is_constant (void) const { return true; } |
86 | |
87 bool is_defined (void) const { return true; } | |
88 | |
21573
f3f8e1d3e399
avoid mulitple definitions of static function-scope vars (bug #47372)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
89 dim_vector dims (void) const; |
4563 | 90 |
10653
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
91 octave_idx_type numel (void) const { return 1; } |
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
92 |
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
93 int ndims (void) const { return 2; } |
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
94 |
23450
855122b993da
maint: Wrap tertiary operator in parentheses "(COND ? x : y)".
Rik <rik@octave.org>
parents:
23446
diff
changeset
|
95 octave_idx_type nnz (void) const { return (scalar != ST () ? 1 : 0); } |
5602 | 96 |
10545
ffe28cdc6fe2
fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10544
diff
changeset
|
97 octave_value permute (const Array<int>&, bool = false) const; |
4875 | 98 |
10545
ffe28cdc6fe2
fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10544
diff
changeset
|
99 octave_value reshape (const dim_vector& new_dims) const; |
8307
ec969f3b8955
Add scalar reshape method
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
100 |
4791 | 101 size_t byte_size (void) const { return sizeof (ST); } |
102 | |
4901 | 103 octave_value all (int = 0) const { return (scalar != ST ()); } |
3278 | 104 |
4901 | 105 octave_value any (int = 0) const { return (scalar != ST ()); } |
3278 | 106 |
10816
7fa044155982
fix diag() with complex scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10670
diff
changeset
|
107 octave_value diag (octave_idx_type k = 0) const; |
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7433
diff
changeset
|
108 |
14557
e8e86ae3abbc
make diag (x, m, n) return a proper diagonal matrix object (bug #36099)
John W. Eaton <jwe@octave.org>
parents:
14464
diff
changeset
|
109 octave_value diag (octave_idx_type m, octave_idx_type n) const; |
e8e86ae3abbc
make diag (x, m, n) return a proper diagonal matrix object (bug #36099)
John W. Eaton <jwe@octave.org>
parents:
14464
diff
changeset
|
110 |
7433 | 111 octave_value sort (octave_idx_type, sortmode) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
112 { return octave_value (scalar); } |
7433 | 113 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type, |
10313 | 114 sortmode) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
115 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
116 sidx.resize (dim_vector (1, 1)); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
117 sidx(0) = 0; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
118 return octave_value (scalar); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
119 } |
7433 | 120 |
23588
0549061d35b9
maint: Deprecate is_sorted and replace with issorted.
Rik <rik@octave.org>
parents:
23586
diff
changeset
|
121 sortmode issorted (sortmode mode = UNSORTED) const |
26386
bdcb5c1aaf4f
ov-base-scalar.h: Fix static analyzer detected issues (bug #55347).
Rik <rik@octave.org>
parents:
26376
diff
changeset
|
122 { return mode == UNSORTED ? ASCENDING : mode; } |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
123 |
8733
3ef774603887
rename all uses of sortrows_idx to sort_rows_idx
John W. Eaton <jwe@octave.org>
parents:
8721
diff
changeset
|
124 Array<octave_idx_type> sort_rows_idx (sortmode) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
125 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
126 return Array<octave_idx_type> (dim_vector (1, 1), |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
127 static_cast<octave_idx_type> (0)); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
128 } |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
129 |
8734
767ed8cc6634
rename internal issorted and issorted_rows functions to is_sorted and is_sorted_rows
John W. Eaton <jwe@octave.org>
parents:
8733
diff
changeset
|
130 sortmode is_sorted_rows (sortmode mode = UNSORTED) const |
26386
bdcb5c1aaf4f
ov-base-scalar.h: Fix static analyzer detected issues (bug #55347).
Rik <rik@octave.org>
parents:
26376
diff
changeset
|
131 { return mode == UNSORTED ? ASCENDING : mode; } |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
132 |
9686
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
133 MatrixType matrix_type (void) const { return MatrixType::Diagonal; } |
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
134 MatrixType matrix_type (const MatrixType&) const |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
135 { return matrix_type (); } |
6376 | 136 |
3278 | 137 bool is_scalar_type (void) const { return true; } |
138 | |
23586
f6c5db0a02e7
maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents:
23502
diff
changeset
|
139 bool isnumeric (void) const { return true; } |
3278 | 140 |
8626
1dce30ab0e72
don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents:
8458
diff
changeset
|
141 bool is_true (void) const; |
3278 | 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); |
3278 | 144 |
3523 | 145 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
3278 | 146 |
3523 | 147 bool print_name_tag (std::ostream& os, const std::string& name) const; |
3278 | 148 |
17870 | 149 void short_disp (std::ostream& os) const; |
16468
0f143f68078d
use signal/slot for updating workspace instead of using event listener
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
150 |
24745
d2467914ce33
enable (or improve) display for more types in the variable editor
John W. Eaton <jwe@octave.org>
parents:
24668
diff
changeset
|
151 float_display_format get_edit_display_format (void) const; |
d2467914ce33
enable (or improve) display for more types in the variable editor
John W. Eaton <jwe@octave.org>
parents:
24668
diff
changeset
|
152 |
24668
d4dd741b2794
new octave_value functions for formatting output
John W. Eaton <jwe@octave.org>
parents:
24643
diff
changeset
|
153 std::string edit_display (const float_display_format& fmt, |
d4dd741b2794
new octave_value functions for formatting output
John W. Eaton <jwe@octave.org>
parents:
24643
diff
changeset
|
154 octave_idx_type i, octave_idx_type j) const; |
24643
78aff6f14227
more variable editor improvements; allow more variable types to be edited
John W. Eaton <jwe@octave.org>
parents:
24534
diff
changeset
|
155 |
5900 | 156 // Unsafe. This function exists to support the MEX interface. |
157 // You should not use it anywhere else. | |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
158 void * mex_get_data (void) const { return const_cast<ST *> (&scalar); } |
5900 | 159 |
10670
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
160 const ST& scalar_ref (void) const { return scalar; } |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
161 |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
162 ST& scalar_ref (void) { return scalar; } |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
163 |
18650
491b0adfec95
compatibility fixes for printf integer format specifiers
John W. Eaton <jwe@octave.org>
parents:
18416
diff
changeset
|
164 octave_value fast_elem_extract (octave_idx_type n) const; |
491b0adfec95
compatibility fixes for printf integer format specifiers
John W. Eaton <jwe@octave.org>
parents:
18416
diff
changeset
|
165 |
10670
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
166 bool fast_elem_insert_self (void *where, builtin_type_t btyp) const; |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
167 |
3278 | 168 protected: |
169 | |
170 // The value of this scalar. | |
171 ST scalar; | |
172 }; | |
173 | |
174 #endif |