octave: liboctave/numeric/svd.h annotate

annotate liboctave/numeric/svd.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	5126040e8f49

rev	line source
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	1 /*
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	2
22204 469c817eb256 svd: reduce code duplication with more use of template and macro. Carnë Draug <carandraug@octave.org> parents: 21273 diff changeset	3 Copyright (C) 2016 Carnë Draug
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 22317 diff changeset	4 Copyright (C) 1994-2016 John W. Eaton
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	5
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	7
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	8 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	9 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	10 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	11 (at your option) any later version.
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	12
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	13 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	14 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 GNU General Public License for more details.
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	17
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6108 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6108 diff changeset	20 <http://www.gnu.org/licenses/>.
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	21
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	22 */
3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	23
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	24 #if ! defined (octave_svd_h)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	25 #define octave_svd_h 1
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	26
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	27 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	28
22249 da201af35c97 maint: properly include <vector> in svd classes. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 22248 diff changeset	29 #include <vector>
22248 60986498af9e svd: use std::vector instead of Matrix when a std::vector is enough. Carnë Draug <carandraug@octave.org> parents: 22230 diff changeset	30
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22249 diff changeset	31 namespace octave
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22249 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 svd
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:
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 typedef typename T::real_diag_matrix_type DM_T;
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	42
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	43 enum class Type
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	44 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	45 std,
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	46 economy,
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	47 sigma_only
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	48 };
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	49
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	50 enum class Driver
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	51 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	52 GESVD,
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	53 GESDD
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	54 };
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	55
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	56 svd (void)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	57 : m_type (), m_driver (), left_sm (), sigma (), right_sm ()
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	58 { }
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	59
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	60 svd (const T& a, svd::Type type = svd::Type::std,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	61 svd::Driver driver = svd::Driver::GESVD);
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 svd (const svd& a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	64 : m_type (a.m_type), m_driver (a.m_driver), left_sm (a.left_sm),
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	65 sigma (a.sigma), right_sm (a.right_sm)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	66 { }
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	67
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	68 svd& operator = (const svd& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	69 {
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	70 if (this != &a)
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	71 {
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	72 m_type = a.m_type;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	73 left_sm = a.left_sm;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	74 sigma = a.sigma;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	75 right_sm = a.right_sm;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	76 m_driver = a.m_driver;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	77 }
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	78
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	79 return *this;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	80 }
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	81
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	82 ~svd (void) = default;
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	83
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	84 T left_singular_matrix (void) const;
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	85
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	86 DM_T singular_values (void) const { return sigma; }
1930 d20ab06301e8 [project @ 1996-02-11 22:30:18 by jwe] jwe parents: 1881 diff changeset	87
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	88 T right_singular_matrix (void) const;
1528 dc527156c38c [project @ 1995-10-05 01:44:18 by jwe] jwe parents: 1315 diff changeset	89
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	90 private:
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	91
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	92 typedef typename T::element_type P;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	93 typedef typename DM_T::element_type DM_P;
22204 469c817eb256 svd: reduce code duplication with more use of template and macro. Carnë Draug <carandraug@octave.org> parents: 21273 diff changeset	94
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	95 svd::Type m_type;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	96 svd::Driver m_driver;
21273 cbced1c09916 better use of templates for svd 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 T left_sm;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	99 DM_T sigma;
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	100 T right_sm;
1880 cbdbec67ad60 [project @ 1996-02-05 17:10:31 by jwe] jwe parents: 1544 diff changeset	101
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	102 void gesvd (char& jobu, char& jobv, octave_idx_type m, octave_idx_type n,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	103 P* tmp_data, octave_idx_type m1, DM_P* s_vec, P* u, P* vt,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	104 octave_idx_type nrow_vt1, std::vector<P>& work,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	105 octave_idx_type& lwork, octave_idx_type& info);
22204 469c817eb256 svd: reduce code duplication with more use of template and macro. Carnë Draug <carandraug@octave.org> parents: 21273 diff changeset	106
22329 7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	107 void gesdd (char& jobz, octave_idx_type m, octave_idx_type n,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	108 P* tmp_data, octave_idx_type m1, DM_P* s_vec, P* u, P* vt,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	109 octave_idx_type nrow_vt1, std::vector<P>& work,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	110 octave_idx_type& lwork,
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	111 octave_idx_type* iwork, octave_idx_type& info);
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	112 };
7f3c7a8bd131 maint: Indent namespaces in liboctave/numeric files. John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	113 }
22317 6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22249 diff changeset	114 }
6ca3acf5fad8 move some new numeric classes to namespace octave::math John W. Eaton <jwe@octave.org> parents: 22249 diff changeset	115
457 3d4b4f0fa5ba [project @ 1994-06-06 00:33:33 by jwe] jwe parents: diff changeset	116 #endif
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22329 diff changeset	117

Mercurial > octave

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