annotate liboctave/ArrayN.h @ 5536:f16c05db6250 ss-2-9-4

[project @ 2005-11-11 19:53:51 by jwe]
author jwe
date Fri, 11 Nov 2005 19:53:52 +0000
parents 4c8a2e4e0717
children d43a097e13d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
1 // Template array classes
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
2 /*
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
3
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
4 Copyright (C) 2000 John W. Eaton
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
5
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
7
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
11 later version.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
12
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
16 for more details.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
17
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
20 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
21 02110-1301, USA.
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
22
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
23 */
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
24
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
25 #if !defined (octave_ArrayN_h)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
26 #define octave_ArrayN_h 1
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
27
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
28 #include <iostream>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
29
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
30 #include <cassert>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
31 #include <climits>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
32 #include <cmath>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
33 #include <cstdlib>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
34
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
35 #include "Array.h"
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
36 #include "Array2.h"
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
37 #include "lo-error.h"
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
38
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
39 class idx_vector;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
40
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
41 // N-dimensional array class.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
42
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
43 template <class T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
44 class
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
45 ArrayN : public Array<T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
46 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
47 protected:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
48
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
49 ArrayN (T *d, const dim_vector& dv) : Array<T> (d, dv) { }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
50
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
51 public:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
52
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
53 // These really need to be protected (and they will be in the
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
54 // future, so don't depend on them being here!), but they can't be
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
55 // until template friends work correctly in g++.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
56
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
57 ArrayN (void) : Array<T> () { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
58
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
59 ArrayN (const dim_vector& dv) : Array<T> (dv) { }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
60
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
61 ArrayN (const dim_vector& dv, const T& val)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
62 : Array<T> (dv) { fill (val); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
63
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
64 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
65 explicit ArrayN (const Array2<U>& a) : Array<T> (a, a.dims ()) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
66
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
67 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
68 ArrayN (const ArrayN<U>& a) : Array<T> (a, a.dims ()) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
69
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
70 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
71 ArrayN (const Array<U>& a) : Array<T> (a) { }
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
72
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
73 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
74 ArrayN (const Array<U>& a, const dim_vector& dv)
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
75 : Array<T> (a, dv) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
76
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
77 ~ArrayN (void) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
78
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
79 ArrayN<T>& operator = (const ArrayN<T>& a)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
80 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
81 if (this != &a)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
82 Array<T>::operator = (a);
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
83
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
84 return *this;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
85 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
86
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
87 ArrayN<T> reshape (const dim_vector& new_dims) const
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
88 { return Array<T>::reshape (new_dims); }
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
89
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
90 ArrayN<T> permute (const Array<int>& vec, bool inv = false) const
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
91 { return Array<T>::permute (vec, inv); }
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
92
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
93 ArrayN<T> ipermute (const Array<int>& vec) const
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
94 { return Array<T>::ipermute (vec); }
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
95
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
96 void resize (const dim_vector& dv)
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4589
diff changeset
97 { this->resize_no_fill (dv); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
98
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
99 void resize (const dim_vector& dv, const T& val)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
100 { Array<T>::resize (dv, val); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
101
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
102 ArrayN<T> squeeze (void) const { return Array<T>::squeeze (); }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
103
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
104 ArrayN<T> transpose (void) const { return Array<T>::transpose (); }
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4765
diff changeset
105
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
106 ArrayN<T>& insert (const ArrayN<T>& a, const dim_vector& dv)
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
107 {
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4543
diff changeset
108 Array<T>::insert (a, dv);
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
109 return *this;
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
110 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
111
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
112 ArrayN<T>& insert (const ArrayN<T>& a, octave_idx_type r, octave_idx_type c)
4765
e941e1470d7b [project @ 2004-02-16 05:56:50 by jwe]
jwe
parents: 4645
diff changeset
113 {
e941e1470d7b [project @ 2004-02-16 05:56:50 by jwe]
jwe
parents: 4645
diff changeset
114 Array<T>::insert (a, r, c);
e941e1470d7b [project @ 2004-02-16 05:56:50 by jwe]
jwe
parents: 4645
diff changeset
115 return *this;
e941e1470d7b [project @ 2004-02-16 05:56:50 by jwe]
jwe
parents: 4645
diff changeset
116 }
e941e1470d7b [project @ 2004-02-16 05:56:50 by jwe]
jwe
parents: 4645
diff changeset
117
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
118 ArrayN<T> index (idx_vector& i, int resize_ok = 0,
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
119 const T& rfv = resize_fill_value (T ())) const
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
120 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
121 Array<T> tmp = Array<T>::index (i, resize_ok, rfv);
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
122 return ArrayN<T> (tmp, tmp.dims ());
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
123 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
124
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
125 ArrayN<T> index (idx_vector& i, idx_vector& j, int resize_ok = 0,
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
126 const T& rfv = resize_fill_value (T ())) const
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
127 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
128 Array<T> tmp = Array<T>::index (i, j, resize_ok, rfv);
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
129 return ArrayN<T> (tmp, tmp.dims ());
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
130 }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
131
4273
d9f281027014 [project @ 2003-01-03 19:58:12 by jwe]
jwe
parents: 4192
diff changeset
132 ArrayN<T> index (Array<idx_vector>& ra_idx, int resize_ok = 0,
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
133 const T& rfv = resize_fill_value (T ())) const
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
134 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
135 Array<T> tmp = Array<T>::index (ra_idx, resize_ok, rfv);
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
136 return ArrayN<T> (tmp, tmp.dims ());
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
137 }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
138 };
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
139
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
140 template <class T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
141 std::ostream&
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
142 operator << (std::ostream&, const ArrayN<T>&);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
143
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
144 #endif
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
145
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
146 /*
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
147 ;;; Local Variables: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
148 ;;; mode: C++ ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
149 ;;; End: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
150 */