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

annotate liboctave/numeric/sparse-chol.h @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	6f07492c9c20
children	e88a07dec498

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30508 diff changeset	3 // Copyright (C) 1998-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	25
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	26 #if ! defined (octave_sparse_chol_h)
307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	27 #define octave_sparse_chol_h 1
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21186 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21186 diff changeset	30
29564 bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	31 #include <memory>
bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	32
30508 6f07492c9c20 Provide header file with forward declarations of matrix types (bug #59820). Markus Mützel <markus.muetzel@gmx.de> parents: 30126 diff changeset	33 #include "mx-fwd.h"
25149 dd774017866b allow most headers to be included alone (bug #53505) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	34
30508 6f07492c9c20 Provide header file with forward declarations of matrix types (bug #59820). Markus Mützel <markus.muetzel@gmx.de> parents: 30126 diff changeset	35 #include "CSparse.h"
5512 7c8767d0ffc0 [project @ 2005-10-27 02:20:17 by jwe] jwe parents: 5511 diff changeset	36
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	37 namespace octave
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	38 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	39 namespace math
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	40 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	41 // If the sparse matrix classes become templated on the element type
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	42 // (i.e., sparse_matrix<double>), then it might be best to make the
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	43 // template parameter of this class also be the element type instead
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	44 // of the matrix type.
21177 a10f60e13243 style fixes in liboctave/numeric directory John W. Eaton <jwe@octave.org> parents: 21145 diff changeset	45
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	46 template <typename chol_type>
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	47 class
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	48 OCTAVE_API
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	49 sparse_chol
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	50 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	51 public:
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	52
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	53 sparse_chol (void);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	54
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	55 sparse_chol (const chol_type& a, bool natural, bool force);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	56
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	57 sparse_chol (const chol_type& a, octave_idx_type& info,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	58 bool natural, bool force);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	59
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	60 sparse_chol (const chol_type& a, octave_idx_type& info, bool natural);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	61
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	62 sparse_chol (const chol_type& a, octave_idx_type& info);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	63
29564 bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	64 sparse_chol (const sparse_chol<chol_type>& a) = default;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	65
29564 bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	66 virtual ~sparse_chol (void) = default;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	67
29564 bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	68 sparse_chol<chol_type>&
bffdb54e78da use shared_ptr to manage memory for sparse chol and qr classes John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	69 operator = (const sparse_chol<chol_type>& a) = default;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	70
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	71 chol_type L (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	72
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	73 chol_type R (void) const { return L ().hermitian (); }
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	74
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	75 octave_idx_type P (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	76
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	77 RowVector perm (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	78
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	79 SparseMatrix Q (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	80
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	81 bool is_positive_definite (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	82
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	83 double rcond (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	84
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	85 chol_type inverse (void) const;
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	86
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	87 protected:
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	88
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	89 typedef typename chol_type::element_type chol_elt;
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	90
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	91 class sparse_chol_rep;
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	92
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	93 private:
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	94
30126 bb9da37c0a8b maint: use "m_" prefix for member variables in class sparse_chol. Rik <rik@octave.org> parents: 29564 diff changeset	95 std::shared_ptr<sparse_chol_rep> m_rep;
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	96 };
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	97
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	98 template <typename chol_type>
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	99 OCTAVE_API
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	100 chol_type
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	101 chol2inv (const chol_type& r);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	102 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	103 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	104
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	105 #endif

Mercurial > octave

annotate liboctave/numeric/sparse-chol.h @ 30564:796f54d4ddbf stable