annotate liboctave/CmplxDET.h @ 7334:274d9642ac10 release-3-0-0

[project @ 2007-12-22 01:42:45 by jwe]
author jwe
date Sat, 22 Dec 2007 01:42:46 +0000
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
1 /*
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1994, 1995, 1996, 1997, 2000, 2002, 2004, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 2007 John W. Eaton
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
5
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
7
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 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: 6108
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: 6108
diff changeset
11 option) any later version.
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
12
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
16 for more details.
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
17
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 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: 6108
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: 6108
diff changeset
20 <http://www.gnu.org/licenses/>.
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
21
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
22 */
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
23
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_ComplexDET_h)
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
25 #define octave_ComplexDET_h 1
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
26
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 2847
diff changeset
27 #include <iostream>
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
28
1650
23aa282707e8 [project @ 1995-12-20 06:53:12 by jwe]
jwe
parents: 1528
diff changeset
29 #include "oct-cmplx.h"
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
30
5775
ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe]
jwe
parents: 5634
diff changeset
31 // FIXME -- we could use templates here; compare with dbleDET.h
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
32
1881
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
33 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5775
diff changeset
34 OCTAVE_API
1881
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
35 ComplexDET
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
36 {
1881
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
37 friend class ComplexMatrix;
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents: 5105
diff changeset
38 friend class SparseComplexMatrix;
532
2ca256b77602 [project @ 1994-07-20 19:56:55 by jwe]
jwe
parents: 457
diff changeset
39
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
40 public:
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
41
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
42 ComplexDET (void) : c2 (0), c10 (0), e2 (0), e10 (0), base2 (false) { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
43
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
44 ComplexDET (const ComplexDET& a)
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
45 : c2 (a.c2), c10 (a.c10), e2 (a.e2), e10 (a.e10), base2 (a.base2)
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
46 { }
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
47
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
48 ComplexDET& operator = (const ComplexDET& a)
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
49 {
1881
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
50 if (this != &a)
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
51 {
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
52 c2 = a.c2;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
53 e2 = a.e2;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
54
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
55 c10 = a.c10;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
56 e10 = a.e10;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
57
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
58 base2 = a.base2;
1881
950825cea083 [project @ 1996-02-05 18:07:21 by jwe]
jwe
parents: 1650
diff changeset
59 }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
60 return *this;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
61 }
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
62
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
63 bool value_will_overflow (void) const;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
64 bool value_will_underflow (void) const;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
65
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
66 // These two functions were originally defined in base 10, so we are
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
67 // preserving that interface here.
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
68
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
69 Complex coefficient (void) const { return coefficient10 (); }
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
70 int exponent (void) const { return exponent10 (); }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
71
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
72 Complex coefficient10 (void) const { return c10; }
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
73 int exponent10 (void) const { return e10; }
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
74
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
75 Complex coefficient2 (void) const { return c2; }
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
76 int exponent2 (void) const { return e2; }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
77
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
78 Complex value (void) const;
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
79
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
80 friend std::ostream& operator << (std::ostream& os, const ComplexDET& a);
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
81
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
82 private:
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
83
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
84 // Constructed this way, we assume base 2.
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
85
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
86 ComplexDET (const Complex& c, int e)
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
87 : c2 (c), c10 (0), e2 (e), e10 (0), base2 (true)
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
88 {
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
89 initialize10 ();
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
90 }
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
91
5634
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
92 // Original interface had only this constructor and it was assumed
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
93 // to be base 10, so we are preserving that interface here.
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
94
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
95 ComplexDET (const Complex *d)
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
96 : c2 (0), c10 (d[0]), e2 (0), e10 (static_cast<int> (d[1].real ())),
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
97 base2 (false)
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
98 {
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
99 initialize2 ();
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
100 }
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
101
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
102 void initialize2 (void);
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
103 void initialize10 (void);
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
104
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
105 Complex c2;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
106 Complex c10;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
107
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
108 int e2;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
109 int e10;
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
110
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
111 // TRUE means the original values were provided in base 2.
4b45b2bcda89 [project @ 2006-03-02 03:40:00 by jwe]
jwe
parents: 5307
diff changeset
112 bool base2;
457
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
113 };
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
114
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
115 #endif
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
116
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
117 /*
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
118 ;;; Local Variables: ***
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
119 ;;; mode: C++ ***
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
120 ;;; End: ***
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe]
jwe
parents:
diff changeset
121 */