octave: liboctave/numeric/sparse-lu.h annotate

annotate liboctave/numeric/sparse-lu.h @ 21174:a223cce1daa4

strip trailing space from source files we maintain * gl2ps-renderer.cc, gl2ps-renderer.h, pt-eval.cc CmplxCHOL.cc, sparse-lu.h, datetick.m, index.tst: Strip trailing whitespace.

author	John W. Eaton <jwe@octave.org>
date	Mon, 01 Feb 2016 08:53:01 -0500
parents	ea9c05014809
children	a10f60e13243

rev	line source
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	1 /*
57077d0ddc8e [project @ 2005-02-25 19:55:24 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) 2004-2015 David Bateman
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11505 diff changeset	4 Copyright (C) 1998-2004 Andy Adler
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5322 diff changeset	5
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5322 diff changeset	6 This file is part of Octave.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	7
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
57077d0ddc8e [project @ 2005-02-25 19:55:24 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: 5322 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: 5322 diff changeset	11 option) any later version.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	12
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	16 for more details.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	17
57077d0ddc8e [project @ 2005-02-25 19:55:24 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: 5322 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: 5322 diff changeset	20 <http://www.gnu.org/licenses/>.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	21
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	22 */
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	23
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	24
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	25 #if ! defined (octave_sparse_lu_h)
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	26 #define octave_sparse_lu_h 1
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	27
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	28 #include "MArray.h"
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	29 #include "dSparse.h"
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	30
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	31 template <typename lu_type>
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32 class
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	33 sparse_lu
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	34 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	35 public:
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	36
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	37 typedef typename lu_type::element_type lu_elt_type;
21174 a223cce1daa4 strip trailing space from source files we maintain John W. Eaton <jwe@octave.org> parents: 21146 diff changeset	38
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	39 sparse_lu (void)
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10312 diff changeset	40 : Lfact (), Ufact (), Rfact (), cond (0), P (), Q () { }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	42 sparse_lu (const lu_type& a, const Matrix& piv_thres = Matrix (),
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	43 bool scale = false);
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	44
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	45 sparse_lu (const lu_type& a, const ColumnVector& Qinit,
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	46 const Matrix& piv_thres, bool scale = false,
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	47 bool FixedQ = false, double droptol = -1.0,
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	48 bool milu = false, bool udiag = false);
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	49
ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	50 sparse_lu (const sparse_lu& a)
11505 9a308e96194e more data member initialization fixes John W. Eaton <jwe@octave.org> parents: 10312 diff changeset	51 : Lfact (a.Lfact), Ufact (a.Ufact), Rfact (), cond (a.cond),
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	52 P (a.P), Q (a.Q)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	53 { }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	54
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	55 sparse_lu& operator = (const sparse_lu& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	56 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	58 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	59 Lfact = a.Lfact;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	60 Ufact = a.Ufact;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	61 cond = a.cond;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	62 P = a.P;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	63 Q = a.Q;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	64 }
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	65
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	66 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	67 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	68
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	69 virtual ~sparse_lu (void) { }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	70
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	71 lu_type L (void) const { return Lfact; }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	72
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	73 lu_type U (void) const { return Ufact; }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	74
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	75 SparseMatrix R (void) const { return Rfact; }
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	76
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	77 lu_type Y (void) const;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	78
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	79 SparseMatrix Pc (void) const;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	80
21146 ea9c05014809 revamp sparse LU factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	81 SparseMatrix Pr (void) const;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	82
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	83 ColumnVector Pc_vec (void) const;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	84
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	85 ColumnVector Pr_vec (void) const;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	86
8969 3ecbc236e2e0 Have sparse LU return permutation matrices rather than sparse matrices. Jason Riedy <jason@acm.org> parents: 8920 diff changeset	87 PermMatrix Pc_mat (void) const;
3ecbc236e2e0 Have sparse LU return permutation matrices rather than sparse matrices. Jason Riedy <jason@acm.org> parents: 8920 diff changeset	88
3ecbc236e2e0 Have sparse LU return permutation matrices rather than sparse matrices. Jason Riedy <jason@acm.org> parents: 8920 diff changeset	89 PermMatrix Pr_mat (void) const;
3ecbc236e2e0 Have sparse LU return permutation matrices rather than sparse matrices. Jason Riedy <jason@acm.org> parents: 8920 diff changeset	90
5322 22994a5730f9 [project @ 2005-04-29 13:04:24 by dbateman] dbateman parents: 5307 diff changeset	91 const octave_idx_type * row_perm (void) const { return P.fortran_vec (); }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	92
5322 22994a5730f9 [project @ 2005-04-29 13:04:24 by dbateman] dbateman parents: 5307 diff changeset	93 const octave_idx_type * col_perm (void) const { return Q.fortran_vec (); }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	94
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	95 double rcond (void) const { return cond; }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	96
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	97 protected:
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	98
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	99 lu_type Lfact;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	100 lu_type Ufact;
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	101 SparseMatrix Rfact;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	102
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	103 double cond;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	104
5322 22994a5730f9 [project @ 2005-04-29 13:04:24 by dbateman] dbateman parents: 5307 diff changeset	105 MArray<octave_idx_type> P;
22994a5730f9 [project @ 2005-04-29 13:04:24 by dbateman] dbateman parents: 5307 diff changeset	106 MArray<octave_idx_type> Q;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	107 };
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	108
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	109 #endif

Mercurial > octave

annotate liboctave/numeric/sparse-lu.h @ 21174:a223cce1daa4