annotate src/ov-base-scalar.h @ 14393:ba4d6343524b stable release-3-6-1

Version 3.6.1 released. * configure.ac (AC_INIT): Version is now 3.6.1. (OCTAVE_RELEASE_DATE): Release date is now 2012-02-22.
author John W. Eaton <jwe@octave.org>
date Wed, 22 Feb 2012 14:39:41 -0500
parents 72c96de7a403
children 21ac4b576003
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
1 /*
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
4
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
6
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6376
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6376
diff changeset
10 option) any later version.
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
11
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
15 for more details.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
16
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6376
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6376
diff changeset
19 <http://www.gnu.org/licenses/>.
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
20
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
21 */
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
22
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_base_scalar_h)
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
24 #define octave_base_scalar_h 1
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
25
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
26 #include <cstdlib>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
29 #include <string>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
30
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
31 #include "lo-mappers.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
32 #include "lo-utils.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
33 #include "oct-alloc.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
34 #include "str-vec.h"
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
35 #include "MatrixType.h"
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
36
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
37 #include "ov-base.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
38 #include "ov-typeinfo.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
39
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
40 // Real scalar values.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
41
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
42 template <class ST>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
43 class
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
44 octave_base_scalar : public octave_base_value
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
45 {
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
46 public:
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
47
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
53
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
56
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
57 ~octave_base_scalar (void) { }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
58
4759
364bbf35dbfa [project @ 2004-02-15 00:08:06 by jwe]
jwe
parents: 4661
diff changeset
59 octave_value squeeze (void) const { return scalar; }
364bbf35dbfa [project @ 2004-02-15 00:08:06 by jwe]
jwe
parents: 4661
diff changeset
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
fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe]
jwe
parents: 4219
diff changeset
63 octave_value subsref (const std::string& type,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
64 const std::list<octave_value_list>& idx);
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3775
diff changeset
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
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
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
be631c1720ea [project @ 2003-01-03 19:36:04 by jwe]
jwe
parents: 4247
diff changeset
69
4247
fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe]
jwe
parents: 4219
diff changeset
70 octave_value subsasgn (const std::string& type,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
71 const std::list<octave_value_list>& idx,
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
72 const octave_value& rhs);
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3775
diff changeset
73
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
74 bool is_constant (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
75
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
76 bool is_defined (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
77
4563
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe]
jwe
parents: 4559
diff changeset
78 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; }
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe]
jwe
parents: 4559
diff changeset
79
10653
ec5fa46e0e45 override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents: 10545
diff changeset
80 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
81
ec5fa46e0e45 override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents: 10545
diff changeset
82 int ndims (void) const { return 2; }
ec5fa46e0e45 override ndims and numel for scalars and matrices
Jaroslav Hajek <highegg@gmail.com>
parents: 10545
diff changeset
83
5602
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe]
jwe
parents: 5307
diff changeset
84 octave_idx_type nnz (void) const { return (scalar != ST ()) ? 1 : 0; }
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe]
jwe
parents: 5307
diff changeset
85
10545
ffe28cdc6fe2 fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 10544
diff changeset
86 octave_value permute (const Array<int>&, bool = false) const;
4875
e674c7111b88 [project @ 2004-04-22 18:12:31 by jwe]
jwe
parents: 4791
diff changeset
87
10545
ffe28cdc6fe2 fix reshape() and permute() for scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 10544
diff changeset
88 octave_value reshape (const dim_vector& new_dims) const;
8307
ec969f3b8955 Add scalar reshape method
David Bateman <dbateman@free.fr>
parents: 7651
diff changeset
89
4791
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4759
diff changeset
90 size_t byte_size (void) const { return sizeof (ST); }
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4759
diff changeset
91
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
92 octave_value all (int = 0) const { return (scalar != ST ()); }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
93
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
94 octave_value any (int = 0) const { return (scalar != ST ()); }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
95
10816
7fa044155982 fix diag() with complex scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 10670
diff changeset
96 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
97
7433
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
98 octave_value sort (octave_idx_type, sortmode) const
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
99 { return octave_value (scalar); }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
100 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
101 sortmode) const
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11584
diff changeset
102 {
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11584
diff changeset
103 sidx.resize (dim_vector (1, 1));
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11584
diff changeset
104 sidx(0) = 0;
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11584
diff changeset
105 return octave_value (scalar);
7433
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
106 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
107
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
108 sortmode is_sorted (sortmode mode = UNSORTED) const
8721
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8626
diff changeset
109 { return mode ? mode : ASCENDING; }
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8626
diff changeset
110
8733
3ef774603887 rename all uses of sortrows_idx to sort_rows_idx
John W. Eaton <jwe@octave.org>
parents: 8721
diff changeset
111 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
112 {
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197)
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
113 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
114 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
115 }
8721
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8626
diff changeset
116
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
117 sortmode is_sorted_rows (sortmode mode = UNSORTED) const
8721
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8626
diff changeset
118 { return mode ? mode : ASCENDING; }
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8626
diff changeset
119
9686
5e433877634f don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 8950
diff changeset
120 MatrixType matrix_type (void) const { return MatrixType::Diagonal; }
5e433877634f don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 8950
diff changeset
121 MatrixType matrix_type (const MatrixType&) const
5e433877634f don't store MatrixType with scalars
Jaroslav Hajek <highegg@gmail.com>
parents: 8950
diff changeset
122 { return matrix_type (); }
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
123
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
124 bool is_scalar_type (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
125
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
126 bool is_numeric_type (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
127
8626
1dce30ab0e72 don't convert NaN to logical in bool expressions
John W. Eaton <jwe@octave.org>
parents: 8458
diff changeset
128 bool is_true (void) const;
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
129
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
130 void print (std::ostream& os, bool pr_as_read_syntax = false) const;
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
131
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
132 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
133
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
134 bool print_name_tag (std::ostream& os, const std::string& name) const;
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
135
5900
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
136 // Unsafe. This function exists to support the MEX interface.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
137 // You should not use it anywhere else.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
138 void *mex_get_data (void) const { return const_cast<ST *> (&scalar); }
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
139
10670
654fbde5dceb make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents: 10653
diff changeset
140 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
141
654fbde5dceb make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents: 10653
diff changeset
142 ST& scalar_ref (void) { return scalar; }
654fbde5dceb make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents: 10653
diff changeset
143
654fbde5dceb make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents: 10653
diff changeset
144 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
145
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
146 protected:
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
147
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
148 // The value of this scalar.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
149 ST scalar;
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
150 };
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
151
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
152 #endif