annotate liboctave/dNDArray.h @ 5249:5c2f58301790 ss-2-9-1

[project @ 2005-03-27 12:06:59 by jwe]
author jwe
date Sun, 27 Mar 2005 12:06:59 +0000
parents e35b034d3523
children 23b37da9fd5b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
1 /*
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
2
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
4
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
6
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
10 later version.
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
11
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
15 for more details.
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
16
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
20
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
21 */
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
22
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
23 #if !defined (octave_NDArray_h)
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
24 #define octave_NDArray_h 1
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
25
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
26 #include "MArrayN.h"
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
27 #include "dMatrix.h"
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4844
diff changeset
28 #include "intNDArray.h"
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
29
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
30 #include "mx-defs.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
31 #include "mx-op-defs.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
32
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
33 class
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
34 NDArray : public MArrayN<double>
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
35 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
36 public:
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
37
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
38 NDArray (void) : MArrayN<double> () { }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
39
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
40 NDArray (const dim_vector& dv) : MArrayN<double> (dv) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
41
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
42 NDArray (const dim_vector& dv, double val)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
43 : MArrayN<double> (dv, val) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
44
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
45 NDArray (const NDArray& a) : MArrayN<double> (a) { }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
46
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
47 NDArray (const Matrix& a) : MArrayN<double> (a) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
48
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
49 NDArray (const MArrayN<double>& a) : MArrayN<double> (a) { }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
50
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4844
diff changeset
51 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4844
diff changeset
52 explicit NDArray (const intNDArray<U>& a) : MArrayN<double> (a) { }
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
53
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
54 NDArray& operator = (const NDArray& a)
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
55 {
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
56 MArrayN<double>::operator = (a);
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
57 return *this;
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
58 }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
59
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
60 // unary operations
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
61
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
62 boolNDArray operator ! (void) const;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
63
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
64 bool any_element_is_negative (bool = false) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
65 bool any_element_is_inf_or_nan (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
66 bool all_elements_are_int_or_inf_or_nan (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
67 bool all_integers (double& max_val, double& min_val) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
68 bool too_large_for_float (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
69
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
70 // XXX FIXME XXX -- this is not quite the right thing.
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
71
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
72 boolNDArray all (int dim = -1) const;
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
73 boolNDArray any (int dim = -1) const;
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
74
4584
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
75 NDArray cumprod (int dim = -1) const;
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
76 NDArray cumsum (int dim = -1) const;
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
77 NDArray prod (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
78 NDArray sum (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
79 NDArray sumsq (int dim = -1) const;
5073
e71be9c548f2 [project @ 2004-11-09 18:31:25 by jwe]
jwe
parents: 4944
diff changeset
80 NDArray concat (const NDArray& rb, const Array<int>& ra_idx);
e71be9c548f2 [project @ 2004-11-09 18:31:25 by jwe]
jwe
parents: 4944
diff changeset
81 ComplexNDArray concat (const ComplexNDArray& rb, const Array<int>& ra_idx);
e71be9c548f2 [project @ 2004-11-09 18:31:25 by jwe]
jwe
parents: 4944
diff changeset
82 charNDArray concat (const charNDArray& rb, const Array<int>& ra_idx);
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
83
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
84 NDArray max (int dim = 0) const;
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
85 NDArray max (ArrayN<int>& index, int dim = 0) const;
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
86 NDArray min (int dim = 0) const;
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
87 NDArray min (ArrayN<int>& index, int dim = 0) const;
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
88
4915
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4902
diff changeset
89 NDArray& insert (const NDArray& a, int r, int c);
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4902
diff changeset
90 NDArray& insert (const NDArray& a, const Array<int>& ra_idx);
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4902
diff changeset
91
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
92 NDArray abs (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
93
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
94 ComplexNDArray fourier (int dim = 1) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
95 ComplexNDArray ifourier (int dim = 1) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
96
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
97 ComplexNDArray fourier2d (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
98 ComplexNDArray ifourier2d (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
99
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
100 ComplexNDArray fourierNd (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
101 ComplexNDArray ifourierNd (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
102
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
103 friend NDArray real (const ComplexNDArray& a);
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
104 friend NDArray imag (const ComplexNDArray& a);
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
105
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
106 Matrix matrix_value (void) const;
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
107
4902
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe]
jwe
parents: 4844
diff changeset
108 NDArray squeeze (void) const { return MArrayN<double>::squeeze (); }
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
109
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
110 static void increment_index (Array<int>& ra_idx,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
111 const dim_vector& dimensions,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
112 int start_dimension = 0);
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
113
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
114 static int compute_index (Array<int>& ra_idx,
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
115 const dim_vector& dimensions);
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
116
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
117 // i/o
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
118
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
119 friend std::ostream& operator << (std::ostream& os, const NDArray& a);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
120 friend std::istream& operator >> (std::istream& is, NDArray& a);
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
121
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
122 static double resize_fill_value (void) { return 0; }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
123
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
124 private:
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
125
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
126 NDArray (double *d, const dim_vector& dv) : MArrayN<double> (d, dv) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
127 };
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
128
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
129 extern NDArray min (double d, const NDArray& m);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
130 extern NDArray min (const NDArray& m, double d);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
131 extern NDArray min (const NDArray& a, const NDArray& b);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
132
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
133 extern NDArray max (double d, const NDArray& m);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
134 extern NDArray max (const NDArray& m, double d);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
135 extern NDArray max (const NDArray& a, const NDArray& b);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4806
diff changeset
136
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
137 NDS_CMP_OP_DECLS (NDArray, double)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
138 NDS_BOOL_OP_DECLS (NDArray, double)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
139
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
140 SND_CMP_OP_DECLS (double, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
141 SND_BOOL_OP_DECLS (double, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
142
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
143 NDND_CMP_OP_DECLS (NDArray, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
144 NDND_BOOL_OP_DECLS (NDArray, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
145
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
146 MARRAY_FORWARD_DEFS (MArrayN, NDArray, double)
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
147
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
148 #endif
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
149
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
150 /*
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
151 ;;; Local Variables: ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
152 ;;; mode: C++ ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
153 ;;; End: ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
154 */