annotate liboctave/numeric/DET.h @ 21139:538b57866b90

consistently use "typename" intead of "class" in template declarations * Object.h, QtHandlesUtils.cc, QtHandlesUtils.h, ToolBarButton.cc, ToolBarButton.h, Cell.h, __lin_interpn__.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, data.cc, filter.cc, gcd.cc, graphics.cc, help.cc, kron.cc, lookup.cc, ls-mat5.cc, ls-oct-text.h, lu.cc, max.cc, mgorth.cc, oct-map.cc, oct-map.h, oct-stream.cc, oct-stream.h, octave-link.h, pr-output.cc, profiler.h, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sqrtm.cc, symtab.h, tril.cc, typecast.cc, variables.cc, xdiv.cc, zfstream.h, __init_fltk__.cc, __magick_read__.cc, chol.cc, qr.cc, ov-base-diag.cc, ov-base-diag.h, ov-base-int.cc, ov-base-int.h, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-scalar.h, ov-base-sparse.cc, ov-base-sparse.h, ov-base.h, ov-classdef.cc, ov-int-traits.h, ov-java.h, ov-usr-fcn.h, ov.cc, ov.h, op-dms-template.cc, oct-parse.in.yy, parse.h, pt-mat.cc, Array-b.cc, Array.cc, Array.h, CDiagMatrix.h, CMatrix.h, CNDArray.h, DiagArray2.cc, DiagArray2.h, MArray.cc, MArray.h, MDiagArray2.cc, MDiagArray2.h, MSparse.cc, MSparse.h, MatrixType.cc, Sparse.cc, Sparse.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, fCDiagMatrix.h, fCMatrix.h, fCNDArray.h, fDiagMatrix.h, fMatrix.h, fNDArray.h, idx-vector.cc, idx-vector.h, intNDArray.cc, intNDArray.h, DET.h, base-aepbal.h, base-lu.cc, base-lu.h, base-qr.cc, base-qr.h, bsxfun-defs.cc, eigs-base.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, oct-convn.cc, oct-fftw.cc, oct-norm.cc, sparse-base-chol.cc, sparse-base-chol.h, sparse-base-lu.cc, sparse-base-lu.h, sparse-dmsolve.cc, mx-inlines.cc, action-container.h, base-list.h, lo-traits.h, lo-utils.h, oct-base64.h, oct-binmap.h, oct-cmplx.h, oct-inttypes.cc, oct-inttypes.h, oct-locbuf.h, oct-refcount.h, oct-sort.cc, oct-sort.h: Use "typename" instead of "class" in template declarations.
author John W. Eaton <jwe@octave.org>
date Sun, 24 Jan 2016 13:50:04 -0500
parents f7084eae3318
children 1473547f50f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 /*
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17769
diff changeset
3 Copyright (C) 2008-2015 Jaroslav Hajek
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
4
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5 This file is part of Octave.
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
6
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
10 option) any later version.
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
11
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
15 for more details.
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
16
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
20
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21 */
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
23 #if ! defined (octave_DET_h)
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24 #define octave_DET_h 1
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 #include <cmath>
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27 #include "oct-cmplx.h"
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 #include "lo-mappers.h"
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
29
21139
538b57866b90 consistently use "typename" intead of "class" in template declarations
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
30 template <typename T>
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
31 class
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32 base_det
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 {
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 public:
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35
11505
9a308e96194e more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
36 base_det (T c = 1, int e = 0)
9a308e96194e more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
37 : c2 (), e2 ()
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
38 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
39 c2 = xlog2 (c, e2);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
40 e2 += e;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
41 }
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
43 base_det (T c, double e, double b)
11505
9a308e96194e more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
44 : c2 (), e2 ()
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
45 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
46 e *= xlog2 (b);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
47 e2 = e;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
48 c *= xexp2 (e - e2);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
49 int f;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
50 c2 = xlog2 (c, f);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
51 e2 += f;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
52 }
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
53
11505
9a308e96194e more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
54 base_det (const base_det& a) : c2 (a.c2), e2 (a.e2) { }
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 base_det& operator = (const base_det& a)
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
57 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
58 c2 = a.c2;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
59 e2 = a.e2;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
60 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
61 }
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
62
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63 T coef (void) const { return c2; }
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
64 int exp (void) const { return e2; }
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 T value () const { return c2 * static_cast<T> (std::ldexp (1.0, e2)); }
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
67 operator T () const { return value (); }
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
68
8336
9813c07ca946 make det take advantage of matrix type
Jaroslav Hajek <highegg@gmail.com>
parents: 8335
diff changeset
69 base_det square () const { return base_det (c2*c2, e2+e2); }
9813c07ca946 make det take advantage of matrix type
Jaroslav Hajek <highegg@gmail.com>
parents: 8335
diff changeset
70
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
71 void operator *= (T t)
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
72 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
73 int e;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
74 c2 *= xlog2 (t, e);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
75 e2 += e;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
76 }
8335
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
77
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
78 private:
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
79
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
80 T c2;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
81 int e2;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
82 };
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
83
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
84 // Provide the old types by typedefs.
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
85 typedef base_det<double> DET;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
86 typedef base_det<float> FloatDET;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
87 typedef base_det<Complex> ComplexDET;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
88 typedef base_det<FloatComplex> FloatComplexDET;
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
89
64cf956a109c templatize & fix DET
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
90 #endif