octave: liboctave/numeric/hess.h annotate

annotate liboctave/numeric/hess.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) 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
21267 f5b8c3aca5f8 make better use of templates for Hessenberg decomposition John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	26 #if ! defined (octave_hess_h)
f5b8c3aca5f8 make better use of templates for Hessenberg decomposition John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	27 #define octave_hess_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
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	31 #include <iosfwd>
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	32
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21267 diff changeset	33 namespace octave
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21267 diff changeset	34 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	35 namespace math
21267 f5b8c3aca5f8 make better use of templates for Hessenberg decomposition John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	36 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	37 template <typename T>
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	38 class
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	39 hess
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 public:
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	42
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	43 hess (void)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	44 : hess_mat (), unitary_hess_mat ()
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	45 { }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	46
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	47 hess (const T& a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	48 : hess_mat (), unitary_hess_mat ()
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	49 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	50 init (a);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	51 }
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	52
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	53 hess (const T& a, octave_idx_type& info)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	54 : hess_mat (), unitary_hess_mat ()
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);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 }
21267 f5b8c3aca5f8 make better use of templates for Hessenberg decomposition 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 hess (const hess& a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	60 : hess_mat (a.hess_mat), unitary_hess_mat (a.unitary_hess_mat)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	61 { }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	62
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	63 hess& operator = (const hess& a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	64 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	65 if (this != &a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	66 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	67 hess_mat = a.hess_mat;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	68 unitary_hess_mat = a.unitary_hess_mat;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	69 }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 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 }
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	73
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	74 ~hess (void) = default;
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	75
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	76 T hess_matrix (void) const { return hess_mat; }
1881 950825cea083 [project @ 1996-02-05 18:07:21 by jwe] jwe parents: 1529 diff changeset	77
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	78 T unitary_hess_matrix (void) const { return unitary_hess_mat; }
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	79
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	80 private:
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	81
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	82 T hess_mat;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	83 T unitary_hess_mat;
21267 f5b8c3aca5f8 make better use of templates for Hessenberg decomposition John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	84
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	85 OCTAVE_API octave_idx_type init (const T& a);
22329 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
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	88 template <typename T>
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	89 extern OCTAVE_API std::ostream&
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	90 operator << (std::ostream& os, const hess<T>& a);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	91 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21267 diff changeset	92 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21267 diff changeset	93
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	94 #endif

Mercurial > octave

annotate liboctave/numeric/hess.h @ 29228:5c14f81e0937