octave: liboctave/numeric/chol.h annotate

annotate liboctave/numeric/chol.h @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	5c14f81e0937 0a5b15007766

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) 1994-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 ////////////////////////////////////////////////////////////////////////
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	25
21269 3c8a3d35661a better use of templates for Cholesky factorization John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	26 #if ! defined (octave_chol_h)
3c8a3d35661a better use of templates for Cholesky factorization John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	27 #define octave_chol_h 1
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	30
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21269 diff changeset	31 namespace octave
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21269 diff changeset	32 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	33 namespace math
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	34 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	35 template <typename T>
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	36 class
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	37 chol
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	38 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	39 public:
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	40
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	41 typedef typename T::column_vector_type VT;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	42 typedef typename T::real_elt_type COND_T;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	43
26385 c309bceb6774 chol.h: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	44 chol (void) : chol_mat (), xrcond (0), is_upper (true) { }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	45
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	46 chol (const T& a, bool upper = true, bool calc_cond = false)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	47 : chol_mat (), xrcond (0)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	48 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	49 init (a, upper, calc_cond);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	50 }
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	51
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	52 chol (const T& a, octave_idx_type& info, bool upper = true,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	53 bool calc_cond = false)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	54 : chol_mat (), xrcond (0)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	55 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	56 info = init (a, upper, calc_cond);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 }
21269 3c8a3d35661a better use of templates for Cholesky factorization John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	58
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	59 chol (const chol& a)
26385 c309bceb6774 chol.h: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	60 : chol_mat (a.chol_mat), xrcond (a.xrcond), is_upper (a.is_upper) { }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	61
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	62 chol& operator = (const chol& a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	63 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	64 if (this != &a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	65 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	66 chol_mat = a.chol_mat;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	67 xrcond = a.xrcond;
26385 c309bceb6774 chol.h: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	68 is_upper = a.is_upper;
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	69 }
6486 e978a9233cf6 [project @ 2007-04-04 15:16:46 by jwe] jwe parents: 6108 diff changeset	70
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	71 return *this;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	72 }
5340 15843d76156d [project @ 2005-05-06 16:26:58 by jwe] jwe parents: 5307 diff changeset	73
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	74 T chol_matrix (void) const { return chol_mat; }
7554 40574114c514 implement Cholesky factorization updating Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	75
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	76 COND_T rcond (void) const { return xrcond; }
7554 40574114c514 implement Cholesky factorization updating Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	77
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	78 // Compute the inverse of a matrix using the Cholesky factorization.
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	79 T inverse (void) const;
7554 40574114c514 implement Cholesky factorization updating Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	80
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	81 void set (const T& R);
7700 efccca5f2ad7 more QR & Cholesky updating functions Jaroslav Hajek <highegg@gmail.com> parents: 7554 diff changeset	82
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	83 void update (const VT& u);
7700 efccca5f2ad7 more QR & Cholesky updating functions Jaroslav Hajek <highegg@gmail.com> parents: 7554 diff changeset	84
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	85 octave_idx_type downdate (const VT& u);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	86
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	87 octave_idx_type insert_sym (const VT& u, octave_idx_type j);
7700 efccca5f2ad7 more QR & Cholesky updating functions Jaroslav Hajek <highegg@gmail.com> parents: 7554 diff changeset	88
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	89 void delete_sym (octave_idx_type j);
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	90
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	91 void shift_sym (octave_idx_type i, octave_idx_type j);
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	92
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	93 private:
6486 e978a9233cf6 [project @ 2007-04-04 15:16:46 by jwe] jwe parents: 6108 diff changeset	94
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	95 T chol_mat;
20462 5ce959c55cc0 Propagate 'lower' in chol(a, 'lower') to underlying library function. PrasannaKumar Muralidharan <prasannatsmkumar@gmail.com> parents: 19697 diff changeset	96
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	97 COND_T xrcond;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	98
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	99 bool is_upper;
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	100
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	101 octave_idx_type init (const T& a, bool upper, bool calc_cond);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	102 };
5340 15843d76156d [project @ 2005-05-06 16:26:58 by jwe] jwe parents: 5307 diff changeset	103
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	104 template <typename T>
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	105 T
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	106 chol2inv (const T& r);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	107 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21269 diff changeset	108 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21269 diff changeset	109
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	110 #endif

Mercurial > octave

annotate liboctave/numeric/chol.h @ 27923:bd51beb6205e