octave: liboctave/numeric/qr.h annotate

annotate liboctave/numeric/qr.h @ 22868:87e3163f6c87

use c++11 "= default" syntax for declaration of trivial destructors * make_int.cc, Canvas.h, GenericEventNotify.h, TextEdit.h, gl-select.h, QTerminal.h, files-dock-widget.h, history-dock-widget.h, octave-cmd.h, octave-dock-widget.h, octave-interpreter.h, thread-manager.h, welcome-wizard.h, workspace-model.h, workspace-view.h, base-text-renderer.h, comment-list.h, debug.h, dynamic-ld.cc, dynamic-ld.h, ft-text-renderer.cc, gl-render.h, gl2ps-print.cc, graphics.in.h, hook-fcn.h, input.h, load-path.h, mxarray.in.h, oct-errno.h, oct-fstrm.h, oct-handle.h, oct-iostrm.h, oct-lvalue.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h, pr-output.cc, procstream.h, sighandlers.cc, symtab.h, text-renderer.h, txt-eng.h, variables.cc, workspace-element.h, __init_fltk__.cc, __init_gnuplot__.cc, ov-base-diag.h, ov-base-int.h, ov-base-scalar.h, ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h, ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-colon.h, ov-complex.cc, ov-complex.h, ov-cs-list.h, ov-cx-diag.h, ov-cx-mat.h, ov-cx-sparse.h, ov-fcn-handle.h, ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h, ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h, ov-intx.h, ov-lazy-idx.h, ov-re-diag.h, ov-re-mat.h, ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h, ov-typeinfo.h, ov-usr-fcn.h, ovl.h, octave.h, lex.h, parse.h, pt-binop.h, pt-bp.h, pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-const.h, pt-decl.h, pt-eval.h, pt-exp.h, pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-jump.h, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-unop.h, pt-walk.h, pt.h, DiagArray2.h, MArray.h, MDiagArray2.h, MSparse.h, idx-vector.h, quit.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h, DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, EIG.h, LSODE.h, ODE.h, ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, aepbalance.h, base-dae.h, base-de.h, base-min.h, fEIG.h, gepbalance.h, gsvd.h, hess.h, lu.h, oct-rand.h, oct-spparms.h, qr.h, qrp.h, schur.h, sparse-lu.h, svd.h, child-list.h, file-stat.h, oct-passwd.h, oct-time.h, oct-uname.h, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, glob-match.h, lo-array-errwarn.h, lo-regexp.h, oct-mutex.h, pathsearch.h, str-vec.h, url-transfer.h:

author	John W. Eaton <jwe@octave.org>
date	Tue, 06 Dec 2016 10:59:29 -0500
parents	3a2b891d0b33
children	ef4d915df748

rev	line source
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	1 /*
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	2
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 22317 diff changeset	3 Copyright (C) 1994-2016 John W. Eaton
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	4 Copyright (C) 2008-2009 Jaroslav Hajek
eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	5 Copyright (C) 2009 VZLU Prague
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	6
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	7 This file is part of Octave.
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	8
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	9 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	10 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	11 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 (at your option) any later version.
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	13
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	15 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 GNU General Public License for more details.
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	18
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	19 You should have received a copy of the GNU General Public License
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	20 along with Octave; see the file COPYING. If not, see
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	21 <http://www.gnu.org/licenses/>.
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	22
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	23 */
7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	24
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	25 #if ! defined (octave_qr_h)
eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	26 #define octave_qr_h 1
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	27
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21191 diff changeset	28 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21191 diff changeset	29
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	30 #include "Array.h"
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	31
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21279 diff changeset	32 namespace octave
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21279 diff changeset	33 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	34 namespace math
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	35 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	36 template <typename T>
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	37 class
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	38 qr
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	39 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	40 public:
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	41
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	42 typedef typename T::element_type ELT_T;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	43 typedef typename T::row_vector_type RV_T;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	44 typedef typename T::column_vector_type CV_T;
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	45
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	46 enum type
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	47 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	48 std,
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	49 raw,
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	50 economy
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	51 };
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	52
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	53 qr (void) : q (), r () { }
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	54
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	55 qr (const T& a, type qr_type = qr::std)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	56 : q (), r ()
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	58 init (a, qr_type);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	59 }
21177 a10f60e13243 style fixes in liboctave/numeric directory John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	60
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	61 qr (const T& q, const T& r);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	62
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	63 qr (const qr& a) : q (a.q), r (a.r) { }
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	64
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	65 qr& operator = (const qr& 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 if (this != &a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	68 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	69 q = a.q;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	70 r = a.r;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	71 }
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	72
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	73 return *this;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	74 }
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	75
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	76 virtual ~qr (void) = default;
9715 9f27172fbd1e auto-set MatrixType from certain functions Jaroslav Hajek <highegg@gmail.com> parents: 9713 diff changeset	77
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	78 T Q (void) const { return q; }
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	79
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	80 T R (void) const { return r; }
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	81
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	82 type get_type (void) const;
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	83
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	84 bool regular (void) const;
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	85
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	86 void init (const T& a, type qr_type);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	87
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	88 void update (const CV_T& u, const CV_T& v);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	89
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	90 void update (const T& u, const T& v);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	91
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	92 void insert_col (const CV_T& u, octave_idx_type j);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	93
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	94 void insert_col (const T& u, const Array<octave_idx_type>& j);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	95
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	96 void delete_col (octave_idx_type j);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	97
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	98 void delete_col (const Array<octave_idx_type>& j);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	99
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	100 void insert_row (const RV_T& u, octave_idx_type j);
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	101
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	102 void delete_row (octave_idx_type j);
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	103
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	104 void shift_cols (octave_idx_type i, octave_idx_type j);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	105
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	106 protected:
21279 eb1524b07fe3 better use of templates for qr classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	107
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	108 T q;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	109 T r;
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	110
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	111 void form (octave_idx_type n, T& afact, ELT_T *tau, type qr_type);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	112 };
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	113
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	114 extern void warn_qrupdate_once (void);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	115 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21279 diff changeset	116 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 21279 diff changeset	117
9713 7918eb15040c refactor the QR classes onto a templated base Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	118 #endif
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	119

Mercurial > octave

annotate liboctave/numeric/qr.h @ 22868:87e3163f6c87