annotate liboctave/oct-cmplx.h @ 14193:72aebe619641 stable rc-3-6-0-0

3.6.0-rc0 release candidate * configure.ac (AC_INIT): Version is now 3.6.0-rc0. (OCTAVE_RELEASE_DATE): Now 2012-01-10. (OCTAVE_API_VERSION_NUMBER): Now 47.
author John W. Eaton <jwe@octave.org>
date Tue, 10 Jan 2012 16:43:41 -0500
parents 72c96de7a403
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
1 /*
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
2
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
3 Copyright (C) 1995-2012 John W. Eaton
9603
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
4 Copyright (C) 2009 VZLU Prague, a.s.
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
5
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
7
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
11 option) any later version.
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
12
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
16 for more details.
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
17
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
20 <http://www.gnu.org/licenses/>.
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
21
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
22 */
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
23
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_oct_cmplx_h)
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
25 #define octave_oct_cmplx_h 1
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
26
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
27 #include <complex>
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
28
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 2847
diff changeset
29 typedef std::complex<double> Complex;
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
30 typedef std::complex<float> FloatComplex;
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
31
9578
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
32 // For complex-complex and complex-real comparisons, we use the following ordering:
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
33 // compare absolute values first; if they match, compare phase angles.
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
34 // This is partially inconsistent with M*b, which compares complex numbers only
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
35 // by their real parts; OTOH, it uses the same definition for max/min and sort.
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
36 // The abs/arg comparison is definitely more useful (the other one is emulated rather
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
37 // trivially), so let's be consistent and use that all over.
8751
9f7ce4bf7650 optimize min/max functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7789
diff changeset
38
9578
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
39 #define DEF_COMPLEXR_COMP(OP, OPS) \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
40 template <class T> \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
41 inline bool operator OP (const std::complex<T>& a, const std::complex<T>& b) \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
42 { \
9603
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
43 FLOAT_TRUNCATE const T ax = std::abs (a), bx = std::abs (b); \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
44 if (ax == bx) \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
45 { \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
46 FLOAT_TRUNCATE const T ay = std::arg (a), by = std::arg (b); \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
47 return ay OP by; \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
48 } \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
49 else \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
50 return ax OPS bx; \
9578
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
51 } \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
52 template <class T> \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
53 inline bool operator OP (const std::complex<T>& a, T b) \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
54 { \
9667
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
55 FLOAT_TRUNCATE const T ax = std::abs (a), bx = std::abs (b); \
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
56 if (ax == bx) \
9603
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
57 { \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
58 FLOAT_TRUNCATE const T ay = std::arg (a); \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
59 return ay OP 0; \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
60 } \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
61 else \
9667
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
62 return ax OPS bx; \
9578
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
63 } \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
64 template <class T> \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
65 inline bool operator OP (T a, const std::complex<T>& b) \
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
66 { \
9667
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
67 FLOAT_TRUNCATE const T ax = std::abs (a), bx = std::abs (b); \
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
68 if (ax == bx) \
9603
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
69 { \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
70 FLOAT_TRUNCATE const T by = std::arg (b); \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
71 return 0 OP by; \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
72 } \
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
73 else \
9667
641a788c82a4 fix complex-real comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9603
diff changeset
74 return ax OPS bx; \
9603
8bea4e89326f implement FLOAT_STORE to allow safer complex comparisons on x87
Jaroslav Hajek <highegg@gmail.com>
parents: 9594
diff changeset
75 }
9578
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
76
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
77 DEF_COMPLEXR_COMP (>, >)
7dafdb8b062f refactor comparison ops implementations
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
78 DEF_COMPLEXR_COMP (<, <)
9594
01004c3cde2c fix non-strict complex comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9578
diff changeset
79 DEF_COMPLEXR_COMP (<=, <)
01004c3cde2c fix non-strict complex comparisons
Jaroslav Hajek <highegg@gmail.com>
parents: 9578
diff changeset
80 DEF_COMPLEXR_COMP (>=, >)
8751
9f7ce4bf7650 optimize min/max functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7789
diff changeset
81
1648
65ef5beea500 [project @ 1995-12-20 06:43:29 by jwe]
jwe
parents:
diff changeset
82 #endif