annotate liboctave/ArrayN.h @ 4532:01ee68d18069

[project @ 2003-10-10 00:49:54 by jwe]
author jwe
date Fri, 10 Oct 2003 00:49:55 +0000
parents 508238e65af7
children 79df15d4470c
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
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
21
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 #if !defined (octave_ArrayN_h)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
25 #define octave_ArrayN_h 1
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
26
4192
5719210fff4c [project @ 2002-11-20 16:56:47 by jwe]
jwe
parents: 4066
diff changeset
27 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION)
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
28 #pragma interface
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
29 #endif
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
30
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
31 #include <iostream>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
32
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
33 #include <cassert>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
34 #include <climits>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
35 #include <cmath>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
36 #include <cstdlib>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
37
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
38 #include "Array.h"
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
39 #include "Array2.h"
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
40 #include "lo-error.h"
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
41
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
42 class idx_vector;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
43
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
44 // N-dimensional array class.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
45
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
46 template <class T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
47 class
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
48 ArrayN : public Array<T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
49 {
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
50 protected:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
51
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
52 static int get_size (const dim_vector& dims)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
53 { return Array<T>::get_size (dims); }
4323
0990c9b77109 [project @ 2003-02-14 07:36:26 by jwe]
jwe
parents: 4273
diff changeset
54
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
55 ArrayN (T *d, const dim_vector& dims) : Array<T> (d, dims) { }
3665
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 public:
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
58
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
59 // 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
60 // 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
61 // until template friends work correctly in g++.
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
62
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
63 ArrayN (void) : Array<T> () { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
64
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
65 ArrayN (const dim_vector& dims) : Array<T> (dims) { }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
66
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
67 ArrayN (const dim_vector& dims, const T& val)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
68 : Array<T> (dims) { fill (val); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
69
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
70 ArrayN (const Array2<T>& a) : Array<T> (a, a.dims ()) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
71
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
72 ArrayN (const ArrayN<T>& a) : Array<T> (a, a.dims ()) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
73
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
74 ArrayN (const Array<T>& a) : Array<T> (a) { }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
75
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
76 ArrayN (const Array<T>& a, const dim_vector& dims) : Array<T> (a, dims) { }
4504
f6a61399bc5c [project @ 2003-09-09 17:48:00 by jwe]
jwe
parents: 4493
diff changeset
77
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
78 ~ArrayN (void) { }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
79
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
80 ArrayN<T>& operator = (const ArrayN<T>& a)
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
81 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
82 if (this != &a)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
83 Array<T>::operator = (a);
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
84
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
85 return *this;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
86 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
87
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
88 void resize (const dim_vector& dims)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
89 { Array<T>resize_no_fill (dims); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
90
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
91 void resize (const dim_vector& dims, const T& val)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
92 { Array<T>::resize (dims, val); }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
93
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
94 ArrayN<T> squeeze (void) const { return Array<T>::squeeze (); }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
95
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
96 ArrayN<T>& insert (const ArrayN<T>& a, const dim_vector& dims)
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
97 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
98 Array<T>::insert (a, dims);
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
99 return *this;
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
100 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
101
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
102 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
103 const T& rfv = resize_fill_value (T ())) const
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
104 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
105 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
106 return ArrayN<T> (tmp, tmp.dims ());
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
107 }
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
108
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
109 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
110 const T& rfv = resize_fill_value (T ())) const
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
111 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
112 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
113 return ArrayN<T> (tmp, tmp.dims ());
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
114 }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
115
4273
d9f281027014 [project @ 2003-01-03 19:58:12 by jwe]
jwe
parents: 4192
diff changeset
116 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
117 const T& rfv = resize_fill_value (T ())) const
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
118 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
119 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
120 return ArrayN<T> (tmp, tmp.dims ());
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4504
diff changeset
121 }
3665
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
122 };
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 template <class T>
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
125 std::ostream&
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
126 operator << (std::ostream&, const ArrayN<T>&);
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
127
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
128 #endif
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
129
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
130 /*
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
131 ;;; Local Variables: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
132 ;;; mode: C++ ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
133 ;;; End: ***
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe]
jwe
parents:
diff changeset
134 */