Mercurial > hg > octave-nkf
annotate src/ov-base-scalar.h @ 14686:847ed7f603cf stable
Added tag rc-3-6-2-2 for changeset 4460c4fb20e6
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 24 May 2012 15:36:06 -0400 |
parents | 21ac4b576003 |
children | e8e86ae3abbc |
rev | line source |
---|---|
3278 | 1 /* |
2 | |
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
12647
diff
changeset
|
3 Copyright (C) 1996-2012 John W. Eaton |
3278 | 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 | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
3278 | 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 | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
3278 | 20 |
21 */ | |
22 | |
23 #if !defined (octave_base_scalar_h) | |
24 #define octave_base_scalar_h 1 | |
25 | |
26 #include <cstdlib> | |
27 | |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
28 #include <iosfwd> |
3278 | 29 #include <string> |
30 | |
31 #include "lo-mappers.h" | |
32 #include "lo-utils.h" | |
33 #include "oct-alloc.h" | |
34 #include "str-vec.h" | |
6376 | 35 #include "MatrixType.h" |
3278 | 36 |
37 #include "ov-base.h" | |
38 #include "ov-typeinfo.h" | |
39 | |
40 // Real scalar values. | |
41 | |
42 template <class ST> | |
43 class | |
44 octave_base_scalar : public octave_base_value | |
45 { | |
46 public: | |
47 | |
48 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
|
49 : octave_base_value (), scalar () { } |
3278 | 50 |
9686
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
51 octave_base_scalar (const ST& s) |
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
52 : octave_base_value (), scalar (s) { } |
3278 | 53 |
54 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
|
55 : octave_base_value (), scalar (s.scalar) { } |
3278 | 56 |
57 ~octave_base_scalar (void) { } | |
58 | |
4759 | 59 octave_value squeeze (void) const { return scalar; } |
60 | |
8458
d254a21e0120
reimplement full as method of octave_base_value
Jaroslav Hajek <highegg@gmail.com>
parents:
8307
diff
changeset
|
61 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
|
62 |
4247 | 63 octave_value subsref (const std::string& type, |
10313 | 64 const std::list<octave_value_list>& idx); |
3933 | 65 |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7620
diff
changeset
|
66 octave_value_list subsref (const std::string& type, |
10313 | 67 const std::list<octave_value_list>& idx, int) |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7620
diff
changeset
|
68 { return subsref (type, idx); } |
4271 | 69 |
4247 | 70 octave_value subsasgn (const std::string& type, |
10313 | 71 const std::list<octave_value_list>& idx, |
72 const octave_value& rhs); | |
3933 | 73 |
14464
21ac4b576003
fix scalar indexing in anonymous function bug (bug #34765)
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
74 octave_value_list do_multi_index_op (int, const octave_value_list& idx) |
21ac4b576003
fix scalar indexing in anonymous function bug (bug #34765)
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
75 { return do_index_op (idx); } |
21ac4b576003
fix scalar indexing in anonymous function bug (bug #34765)
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
76 |
3278 | 77 bool is_constant (void) const { return true; } |
78 | |
79 bool is_defined (void) const { return true; } | |
80 | |
4563 | 81 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; } |
82 | |
10653
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
83 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
|
84 |
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
85 int ndims (void) const { return 2; } |
ec5fa46e0e45
override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
10545
diff
changeset
|
86 |
5602 | 87 octave_idx_type nnz (void) const { return (scalar != ST ()) ? 1 : 0; } |
88 | |
10545
ffe28cdc6fe2
fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10544
diff
changeset
|
89 octave_value permute (const Array<int>&, bool = false) const; |
4875 | 90 |
10545
ffe28cdc6fe2
fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10544
diff
changeset
|
91 octave_value reshape (const dim_vector& new_dims) const; |
8307
ec969f3b8955
Add scalar reshape method
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
92 |
4791 | 93 size_t byte_size (void) const { return sizeof (ST); } |
94 | |
4901 | 95 octave_value all (int = 0) const { return (scalar != ST ()); } |
3278 | 96 |
4901 | 97 octave_value any (int = 0) const { return (scalar != ST ()); } |
3278 | 98 |
10816
7fa044155982
fix diag() with complex scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
10670
diff
changeset
|
99 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
|
100 |
7433 | 101 octave_value sort (octave_idx_type, sortmode) const |
102 { return octave_value (scalar); } | |
103 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type, | |
10313 | 104 sortmode) const |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
105 { |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
106 sidx.resize (dim_vector (1, 1)); |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
107 sidx(0) = 0; |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
108 return octave_value (scalar); |
7433 | 109 } |
110 | |
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
|
111 sortmode is_sorted (sortmode mode = UNSORTED) const |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
112 { return mode ? mode : ASCENDING; } |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
113 |
8733
3ef774603887
rename all uses of sortrows_idx to sort_rows_idx
John W. Eaton <jwe@octave.org>
parents:
8721
diff
changeset
|
114 Array<octave_idx_type> sort_rows_idx (sortmode) const |
12647
e38fb1910563
Allow sortrows to work on arrays with one row (bug #33197)
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
115 { |
e38fb1910563
Allow sortrows to work on arrays with one row (bug #33197)
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
116 return Array<octave_idx_type> (dim_vector (1, 1), |
e38fb1910563
Allow sortrows to work on arrays with one row (bug #33197)
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
117 static_cast<octave_idx_type> (0)); |
e38fb1910563
Allow sortrows to work on arrays with one row (bug #33197)
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
118 } |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
119 |
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
|
120 sortmode is_sorted_rows (sortmode mode = UNSORTED) const |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
121 { return mode ? mode : ASCENDING; } |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8626
diff
changeset
|
122 |
9686
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
123 MatrixType matrix_type (void) const { return MatrixType::Diagonal; } |
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
124 MatrixType matrix_type (const MatrixType&) const |
5e433877634f
don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
125 { return matrix_type (); } |
6376 | 126 |
3278 | 127 bool is_scalar_type (void) const { return true; } |
128 | |
129 bool is_numeric_type (void) const { return true; } | |
130 | |
8626
1dce30ab0e72
don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents:
8458
diff
changeset
|
131 bool is_true (void) const; |
3278 | 132 |
3523 | 133 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
3278 | 134 |
3523 | 135 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
3278 | 136 |
3523 | 137 bool print_name_tag (std::ostream& os, const std::string& name) const; |
3278 | 138 |
5900 | 139 // Unsafe. This function exists to support the MEX interface. |
140 // You should not use it anywhere else. | |
141 void *mex_get_data (void) const { return const_cast<ST *> (&scalar); } | |
142 | |
10670
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
143 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
|
144 |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
145 ST& scalar_ref (void) { return scalar; } |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
146 |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10653
diff
changeset
|
147 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
|
148 |
3278 | 149 protected: |
150 | |
151 // The value of this scalar. | |
152 ST scalar; | |
153 }; | |
154 | |
155 #endif |