annotate liboctave/dNDArray.h @ 4806:d3bd9c04147f

[project @ 2004-03-02 05:12:32 by jwe]
author jwe
date Tue, 02 Mar 2004 05:12:33 +0000
parents ccfbd6047a54
children 9f7ef92b50b0
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 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION)
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
27 #pragma interface
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
28 #endif
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 "MArrayN.h"
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
31 #include "dMatrix.h"
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
32
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
33 #include "mx-defs.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
34 #include "mx-op-defs.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
35
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
36 #include "data-conv.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
37 #include "mach-info.h"
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
38
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
39 class
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
40 NDArray : public MArrayN<double>
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
41 {
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
42 public:
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
43
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
44 NDArray (void) : MArrayN<double> () { }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
45
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
46 NDArray (const dim_vector& dv) : MArrayN<double> (dv) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
47
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
48 NDArray (const dim_vector& dv, double val)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
49 : MArrayN<double> (dv, val) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
50
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
51 NDArray (const NDArray& a) : MArrayN<double> (a) { }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
52
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
53 NDArray (const Matrix& a) : MArrayN<double> (a) { }
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
54
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
55 NDArray (const MArrayN<double>& a) : MArrayN<double> (a) { }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
56
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
57 NDArray (const ArrayN<double>& a) : MArrayN<double> (a) { }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
58
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
59 explicit NDArray (const boolNDArray& a);
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
60
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
61 explicit NDArray (const charNDArray& a);
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
62
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
63 NDArray& operator = (const NDArray& a)
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
64 {
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
65 MArrayN<double>::operator = (a);
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
66 return *this;
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
67 }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
68
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
69 // unary operations
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
70
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
71 boolNDArray operator ! (void) const;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
72
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
73 bool any_element_is_negative (bool = false) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
74 bool any_element_is_inf_or_nan (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
75 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
76 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
77 bool too_large_for_float (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
78
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
79 // 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
80
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
81 boolNDArray all (int dim = -1) const;
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
82 boolNDArray any (int dim = -1) const;
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
83
4584
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
84 NDArray cumprod (int dim = -1) const;
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
85 NDArray cumsum (int dim = -1) const;
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
86 NDArray prod (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
87 NDArray sum (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
88 NDArray sumsq (int dim = -1) const;
4806
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe]
jwe
parents: 4773
diff changeset
89 int cat (const NDArray& ra_arg, int dim, int iidx, int move);
4758
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe]
jwe
parents: 4687
diff changeset
90
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
91 NDArray abs (void) const;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
92
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
93 ComplexNDArray fourier (int dim = 1) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
94 ComplexNDArray ifourier (int dim = 1) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
95
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
96 ComplexNDArray fourier2d (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
97 ComplexNDArray ifourier2d (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
98
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
99 ComplexNDArray fourierNd (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
100 ComplexNDArray ifourierNd (void) const;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4762
diff changeset
101
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
102 friend NDArray real (const ComplexNDArray& a);
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
103 friend NDArray imag (const ComplexNDArray& a);
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
104
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
105 Matrix matrix_value (void) const;
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
106
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
107 NDArray squeeze (void) const { return ArrayN<double>::squeeze (); }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
108
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
109 static void increment_index (Array<int>& ra_idx,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
110 const dim_vector& dimensions,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
111 int start_dimension = 0);
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4513
diff changeset
112
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
113 static int compute_index (Array<int>& ra_idx,
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
114 const dim_vector& dimensions);
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
115
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
116 // i/o
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
117
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
118 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
119 friend std::istream& operator >> (std::istream& is, NDArray& a);
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
120
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
121 static double resize_fill_value (void) { return 0; }
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
122
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
123 private:
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
124
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
125 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
126 };
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
127
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
128 NDS_CMP_OP_DECLS (NDArray, double)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
129 NDS_BOOL_OP_DECLS (NDArray, double)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
130
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
131 SND_CMP_OP_DECLS (double, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
132 SND_BOOL_OP_DECLS (double, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
133
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
134 NDND_CMP_OP_DECLS (NDArray, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
135 NDND_BOOL_OP_DECLS (NDArray, NDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
136
4511
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
137 MARRAY_FORWARD_DEFS (MArrayN, NDArray, double)
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
138
24af46b4ce84 [project @ 2003-09-12 16:46:04 by jwe]
jwe
parents:
diff changeset
139 #endif
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
140
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
141 /*
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
142 ;;; Local Variables: ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
143 ;;; mode: C++ ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
144 ;;; End: ***
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4511
diff changeset
145 */