octave: liboctave/numeric/lu.h annotate

annotate liboctave/numeric/lu.h @ 21271:7e67c7f82fc1

better use of templates for lu factorization classes * liboctave/numeric/lu.h, liboctave/numeric/lu.cc: New files generated from base-lu.h, base-lu.cc, CmplxLU.cc, CmplxLU.h, dbleLU.cc, dbleLU.h, fCmplxLU.cc, fCmplxLU.h, floatLU.cc, and floatLU.h and converted to templates. * liboctave/numeric/module.mk: Update. * lu.cc, mx-defs.h, mx-ext.h, eigs-base.cc: Use new classes.

author	John W. Eaton <jwe@octave.org>
date	Tue, 16 Feb 2016 12:58:32 -0500
parents	liboctave/numeric/base-lu.h@1473547f50f5
children	6ca3acf5fad8

rev	line source
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	1 /*
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe 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) 1996-2015 John W. Eaton
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	4 Copyright (C) 2009 VZLU Prague
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	5
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	7
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
413f6a81868f [project @ 1996-03-03 00:40:53 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.
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	12
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	16 for more details.
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	17
413f6a81868f [project @ 1996-03-03 00:40:53 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/>.
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	21
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	22 */
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	23
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	24 #if ! defined (octave_lu_h)
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	25 #define octave_lu_h 1
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	26
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	27 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	28
8367 445d27d79f4e support permutation matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7515 diff changeset	29 #include "PermMatrix.h"
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	30
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	31 template <typename T>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 2847 diff changeset	32 class
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	33 lu
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	34 {
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	35 public:
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	36
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	37 typedef typename T::column_vector_type VT;
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	38 typedef typename T::element_type ELT_T;
8367 445d27d79f4e support permutation matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7515 diff changeset	39
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	40 lu (void)
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10521 diff changeset	41 : a_fact (), l_fact (), ipvt () { }
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	42
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	43 lu (const T& a);
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	44
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	45 lu (const lu& a)
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10521 diff changeset	46 : a_fact (a.a_fact), l_fact (a.l_fact), ipvt (a.ipvt) { }
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	47
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	48 lu (const T& l, const T& u, const PermMatrix& p);
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	49
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	50 lu& operator = (const lu& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	51 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	52 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	53 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	54 a_fact = a.a_fact;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	55 l_fact = a.l_fact;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	56 ipvt = a.ipvt;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 }
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	58
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	59 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	60 }
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	61
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	62 virtual ~lu (void) { }
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	63
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	64 bool packed (void) const;
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	65
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	66 void unpack (void);
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	67
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	68 T L (void) const;
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	69
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	70 T U (void) const;
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	71
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	72 T Y (void) const;
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	73
8367 445d27d79f4e support permutation matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7515 diff changeset	74 PermMatrix P (void) const;
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	75
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	76 ColumnVector P_vec (void) const;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	77
9715 9f27172fbd1e auto-set MatrixType from certain functions Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	78 bool regular (void) const;
9f27172fbd1e auto-set MatrixType from certain functions Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	79
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	80 void update (const VT& u, const VT& v);
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	81
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	82 void update (const T& u, const T& v);
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	83
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	84 void update_piv (const VT& u, const VT& v);
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	85
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	86 void update_piv (const T& u, const T& v);
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	87
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	88 protected:
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	89
8367 445d27d79f4e support permutation matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7515 diff changeset	90 Array<octave_idx_type> getp (void) const;
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10521 diff changeset	91
21271 7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	92 T a_fact;
7e67c7f82fc1 better use of templates for lu factorization classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	93 T l_fact;
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10521 diff changeset	94
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	95 Array<octave_idx_type> ipvt;
1991 413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	96 };
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	97
413f6a81868f [project @ 1996-03-03 00:40:53 by jwe] jwe parents: diff changeset	98 #endif

Mercurial > octave

annotate liboctave/numeric/lu.h @ 21271:7e67c7f82fc1