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

annotate liboctave/numeric/sparse-chol.h @ 29228:5c14f81e0937

Set API tags in files in liboctave/numeric (patch #8919). Add API tag to template class definitions. Add API tag to (un-defined) functions and member functions in headers. Export template class instantiations and template functions from .cc files.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 29 Dec 2020 17:51:23 +0100
parents	bd51beb6205e
children	7854d5752dd2

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 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 1998-2020 The Octave Project Developers
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
25149 dd774017866b allow most headers to be included alone (bug #53505) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	31 #include "CSparse.h"
dd774017866b allow most headers to be included alone (bug #53505) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	32
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	33 class RowVector;
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	34 class SparseMatrix;
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	35 class SparseComplexMatrix;
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
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	64 sparse_chol (const sparse_chol<chol_type>& a);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	65
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	66 virtual ~sparse_chol (void);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	67
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	68 sparse_chol& operator = (const sparse_chol& a);
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	69
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	70 chol_type L (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	71
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	72 chol_type R (void) const { return L ().hermitian (); }
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	73
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	74 octave_idx_type P (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	75
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	76 RowVector perm (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	77
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	78 SparseMatrix Q (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	79
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	80 bool is_positive_definite (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	81
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	82 double rcond (void) const;
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	83
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	84 chol_type inverse (void) const;
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	85
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	86 protected:
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	87
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	88 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	89
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	90 class sparse_chol_rep;
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	91
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	92 private:
21145 307096fb67e1 revamp sparse Cholesky factorization classes John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	93
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	94 sparse_chol_rep *rep;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	95 };
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	96
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	97 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	98 OCTAVE_API
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	99 chol_type
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	100 chol2inv (const chol_type& r);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	101 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	102 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22229 diff changeset	103
5506 b4cfbb0ec8c4 [project @ 2005-10-23 19:09:32 by dbateman] dbateman parents: diff changeset	104 #endif

Mercurial > octave

annotate liboctave/numeric/sparse-chol.h @ 29228:5c14f81e0937