annotate liboctave/CNDArray.h @ 4758:a308566c8b42

[project @ 2004-02-13 23:01:34 by jwe]
author jwe
date Fri, 13 Feb 2004 23:01:34 +0000
parents e95c86d48732
children bec345670e56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
1 /*
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
2
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 2003 John W. Eaton
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
4
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
6
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
10 later version.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
11
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
15 for more details.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
16
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
20
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
21 */
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
22
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_ComplexNDArray_h)
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
24 #define octave_ComplexNDArray_h 1
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
25
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
26 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION)
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
27 #pragma interface
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
28 #endif
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
29
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
30 #include "MArrayN.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
31 #include "CMatrix.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
32
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
33 #include "mx-defs.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
34 #include "mx-op-defs.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
35
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
36 #include "data-conv.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
37 #include "mach-info.h"
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
38
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
39 class
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
40 ComplexNDArray : public MArrayN<Complex>
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
41 {
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
42 public:
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
43
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
44 ComplexNDArray (void) : MArrayN<Complex> () { }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
45
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
46 ComplexNDArray (const dim_vector& dv) : MArrayN<Complex> (dv) { }
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
47
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
48 ComplexNDArray (const dim_vector& dv, const Complex& val)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
49 : MArrayN<Complex> (dv, val) { }
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
50
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
51 ComplexNDArray (const ComplexNDArray& a) : MArrayN<Complex> (a) { }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
52
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
53 ComplexNDArray (const ComplexMatrix& a) : MArrayN<Complex> (a) { }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
54
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
55 ComplexNDArray (const MArrayN<Complex>& a) : MArrayN<Complex> (a) { }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
56
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
57 ComplexNDArray (const ArrayN<Complex>& a) : MArrayN<Complex> (a) { }
8373b9b41eee [project @ 2003-09-19 21:47:10 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 ComplexNDArray (const NDArray& 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 ComplexNDArray (const boolNDArray& a);
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
62
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
63 explicit ComplexNDArray (const charNDArray& a);
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
64
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
65 ComplexNDArray& operator = (const ComplexNDArray& a)
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
66 {
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
67 MArrayN<Complex>::operator = (a);
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
68 return *this;
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
69 }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
70
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
71 // unary operations
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
72
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
73 boolNDArray operator ! (void) const;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
74
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
75 // XXX FIXME XXX -- this is not quite the right thing.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
76
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
77 bool any_element_is_inf_or_nan (void) const;
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
78 bool all_elements_are_real (void) const;
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
79 bool all_integers (double& max_val, double& min_val) const;
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
80 bool too_large_for_float (void) const;
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
81
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
82 boolNDArray all (int dim = -1) const;
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
83 boolNDArray any (int dim = -1) const;
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
84
4584
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
85 ComplexNDArray cumprod (int dim = -1) const;
f7697d703481 [project @ 2003-10-31 19:47:35 by jwe]
jwe
parents: 4569
diff changeset
86 ComplexNDArray cumsum (int dim = -1) const;
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
87 ComplexNDArray prod (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
88 ComplexNDArray sum (int dim = -1) const;
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
89 ComplexNDArray sumsq (int dim = -1) const;
4758
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe]
jwe
parents: 4687
diff changeset
90 bool cat (ComplexNDArray& cat_array, int dim, int add_dim) const;
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
91
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
92 NDArray abs (void) const;
4569
01e4957409a4 [project @ 2003-10-30 05:48:17 by jwe]
jwe
parents: 4556
diff changeset
93
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
94 ComplexMatrix matrix_value (void) const;
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
95
4532
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
96 ComplexNDArray squeeze (void) const { return ArrayN<Complex>::squeeze (); }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
97
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
98 static void increment_index (Array<int>& ra_idx,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
99 const dim_vector& dimensions,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
100 int start_dimension = 0);
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe]
jwe
parents: 4514
diff changeset
101
4556
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
102 static int compute_index (Array<int>& ra_idx,
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
103 const dim_vector& dimensions);
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe]
jwe
parents: 4543
diff changeset
104
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
105 // i/o
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
106
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
107 friend std::ostream& operator << (std::ostream& os, const ComplexNDArray& a);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4634
diff changeset
108 friend std::istream& operator >> (std::istream& is, ComplexNDArray& a);
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
109
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
110 static Complex resize_fill_value (void) { return Complex (0.0, 0.0); }
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
111
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
112 // bool all_elements_are_real (void) const;
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
113 // bool all_integers (double& max_val, double& min_val) const;
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
114
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
115 private:
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
116
4634
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe]
jwe
parents: 4587
diff changeset
117 ComplexNDArray (Complex *d, const dim_vector& dv)
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4584
diff changeset
118 : MArrayN<Complex> (d, dv) { }
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
119 };
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
120
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
121 NDS_CMP_OP_DECLS (ComplexNDArray, Complex)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
122 NDS_BOOL_OP_DECLS (ComplexNDArray, Complex)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
123
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
124 SND_CMP_OP_DECLS (Complex, ComplexNDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
125 SND_BOOL_OP_DECLS (Complex, ComplexNDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
126
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
127 NDND_CMP_OP_DECLS (ComplexNDArray, ComplexNDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
128 NDND_BOOL_OP_DECLS (ComplexNDArray, ComplexNDArray)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4532
diff changeset
129
4514
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
130 MARRAY_FORWARD_DEFS (MArrayN, ComplexNDArray, Complex)
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
131
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
132 #endif
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
133
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
134 /*
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
135 ;;; Local Variables: ***
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
136 ;;; mode: C++ ***
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
137 ;;; End: ***
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe]
jwe
parents:
diff changeset
138 */