annotate src/ov-base-scalar.h @ 7961:a5d1e27ee1f4 ss-3-1-51

3.1.51 snapshot
author John W. Eaton <jwe@octave.org>
date Tue, 22 Jul 2008 11:40:48 -0400
parents 443a8f5a50fd
children ec969f3b8955
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
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 2006, 2007 John W. Eaton
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
5
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
7
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
8 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
9 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
10 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
11 option) any later version.
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
12
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
17
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
18 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
19 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
20 <http://www.gnu.org/licenses/>.
3278
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
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_base_scalar_h)
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
25 #define octave_base_scalar_h 1
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
26
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
27 #include <cstdlib>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
28
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3278
diff changeset
29 #include <iostream>
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
30 #include <string>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
31
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
32 #include "lo-mappers.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
33 #include "lo-utils.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
34 #include "oct-alloc.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
35 #include "str-vec.h"
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
36 #include "MatrixType.h"
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
37
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
38 #include "ov-base.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
39 #include "ov-typeinfo.h"
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
40
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
41 // Real scalar values.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
42
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
43 template <class ST>
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
44 class
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
45 octave_base_scalar : public octave_base_value
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
46 {
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
47 public:
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
48
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
49 octave_base_scalar (void)
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
50 : octave_base_value (), typ (MatrixType ()) { }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
51
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
52 octave_base_scalar (const ST& s, const MatrixType& t = MatrixType ())
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
53 : octave_base_value (), scalar (s), typ (t) { }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
54
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
55 octave_base_scalar (const octave_base_scalar& s)
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
56 : octave_base_value (), scalar (s.scalar), typ (s.typ) { }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
57
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
58 ~octave_base_scalar (void) { }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
59
5759
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5602
diff changeset
60 octave_base_value *clone (void) const { return new octave_base_scalar (*this); }
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5602
diff changeset
61 octave_base_value *empty_clone (void) const { return new octave_base_scalar (); }
4981
0e7d04102ccf [project @ 2004-09-10 04:54:46 by jwe]
jwe
parents: 4901
diff changeset
62
4759
364bbf35dbfa [project @ 2004-02-15 00:08:06 by jwe]
jwe
parents: 4661
diff changeset
63 octave_value squeeze (void) const { return scalar; }
364bbf35dbfa [project @ 2004-02-15 00:08:06 by jwe]
jwe
parents: 4661
diff changeset
64
4247
fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe]
jwe
parents: 4219
diff changeset
65 octave_value subsref (const std::string& type,
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4192
diff changeset
66 const std::list<octave_value_list>& idx);
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3775
diff changeset
67
7651
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7620
diff changeset
68 octave_value_list subsref (const std::string& type,
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7620
diff changeset
69 const std::list<octave_value_list>& idx, int)
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7620
diff changeset
70 { return subsref (type, idx); }
4271
be631c1720ea [project @ 2003-01-03 19:36:04 by jwe]
jwe
parents: 4247
diff changeset
71
4247
fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe]
jwe
parents: 4219
diff changeset
72 octave_value subsasgn (const std::string& type,
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4192
diff changeset
73 const std::list<octave_value_list>& idx,
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3775
diff changeset
74 const octave_value& rhs);
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3775
diff changeset
75
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
76 bool is_constant (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
77
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
78 bool is_defined (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
79
4563
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe]
jwe
parents: 4559
diff changeset
80 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
81
5602
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe]
jwe
parents: 5307
diff changeset
82 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
83
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
84 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
85 { return scalar; }
e674c7111b88 [project @ 2004-04-22 18:12:31 by jwe]
jwe
parents: 4791
diff changeset
86
4791
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4759
diff changeset
87 size_t byte_size (void) const { return sizeof (ST); }
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4759
diff changeset
88
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
89 octave_value all (int = 0) const { return (scalar != ST ()); }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
90
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
91 octave_value any (int = 0) const { return (scalar != ST ()); }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
92
7620
36594d5bbe13 Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents: 7433
diff changeset
93 octave_value diag (octave_idx_type k = 0) const
36594d5bbe13 Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents: 7433
diff changeset
94 { return octave_value (matrix_value (). diag (k)); }
36594d5bbe13 Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents: 7433
diff changeset
95
7433
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
96 octave_value sort (octave_idx_type, sortmode) const
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
97 { return octave_value (scalar); }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
98 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type,
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
99 sortmode) const
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
100 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
101 sidx.resize (dim_vector (1, 1));
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
102 sidx(0) = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
103 return octave_value (scalar);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
104 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman]
dbateman
parents: 7017
diff changeset
105
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
106 MatrixType matrix_type (void) const { return typ; }
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
107 MatrixType matrix_type (const MatrixType& _typ) const
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
108 { MatrixType ret = typ; typ = _typ; return ret; }
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
109
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
110 bool is_scalar_type (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
111
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
112 bool is_numeric_type (void) const { return true; }
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
113
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents: 4875
diff changeset
114 bool is_true (void) const { return (scalar != ST ()); }
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
115
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
116 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
117
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
118 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
119
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
120 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
121
5900
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
122 // Unsafe. This function exists to support the MEX interface.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
123 // You should not use it anywhere else.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe]
jwe
parents: 5759
diff changeset
124 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
125
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
126 protected:
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
127
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
128 // The value of this scalar.
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
129 ST scalar;
6376
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
130
0eac3484e8df [project @ 2007-03-02 02:18:37 by jwe]
jwe
parents: 5900
diff changeset
131 mutable MatrixType typ;
3278
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
132 };
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
133
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
134 #endif
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
135
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
136 /*
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
137 ;;; Local Variables: ***
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
138 ;;; mode: C++ ***
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
139 ;;; End: ***
9c9f0c035309 [project @ 1999-10-12 06:03:49 by jwe]
jwe
parents:
diff changeset
140 */