Mercurial > octave
view libinterp/corefcn/hess.cc @ 21139:538b57866b90
consistently use "typename" intead of "class" in template declarations
* Object.h, QtHandlesUtils.cc, QtHandlesUtils.h, ToolBarButton.cc,
ToolBarButton.h, Cell.h, __lin_interpn__.cc, bitfcns.cc, bsxfun.cc,
cellfun.cc, data.cc, filter.cc, gcd.cc, graphics.cc, help.cc, kron.cc,
lookup.cc, ls-mat5.cc, ls-oct-text.h, lu.cc, max.cc, mgorth.cc,
oct-map.cc, oct-map.h, oct-stream.cc, oct-stream.h, octave-link.h,
pr-output.cc, profiler.h, schur.cc, sparse-xdiv.cc, sparse-xpow.cc,
sqrtm.cc, symtab.h, tril.cc, typecast.cc, variables.cc, xdiv.cc,
zfstream.h, __init_fltk__.cc, __magick_read__.cc, chol.cc, qr.cc,
ov-base-diag.cc, ov-base-diag.h, ov-base-int.cc, ov-base-int.h,
ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-scalar.h,
ov-base-sparse.cc, ov-base-sparse.h, ov-base.h, ov-classdef.cc,
ov-int-traits.h, ov-java.h, ov-usr-fcn.h, ov.cc, ov.h,
op-dms-template.cc, oct-parse.in.yy, parse.h, pt-mat.cc, Array-b.cc,
Array.cc, Array.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
DiagArray2.cc, DiagArray2.h, MArray.cc, MArray.h, MDiagArray2.cc,
MDiagArray2.h, MSparse.cc, MSparse.h, MatrixType.cc, Sparse.cc,
Sparse.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, fCDiagMatrix.h,
fCMatrix.h, fCNDArray.h, fDiagMatrix.h, fMatrix.h, fNDArray.h,
idx-vector.cc, idx-vector.h, intNDArray.cc, intNDArray.h, DET.h,
base-aepbal.h, base-lu.cc, base-lu.h, base-qr.cc, base-qr.h,
bsxfun-defs.cc, eigs-base.cc, lo-mappers.h, lo-specfun.cc,
lo-specfun.h, oct-convn.cc, oct-fftw.cc, oct-norm.cc,
sparse-base-chol.cc, sparse-base-chol.h, sparse-base-lu.cc,
sparse-base-lu.h, sparse-dmsolve.cc, mx-inlines.cc,
action-container.h, base-list.h, lo-traits.h, lo-utils.h,
oct-base64.h, oct-binmap.h, oct-cmplx.h, oct-inttypes.cc,
oct-inttypes.h, oct-locbuf.h, oct-refcount.h, oct-sort.cc, oct-sort.h:
Use "typename" instead of "class" in template declarations.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sun, 24 Jan 2016 13:50:04 -0500 |
parents | 228b65504557 |
children | fcac5dbbf9ed |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "CmplxHESS.h" #include "dbleHESS.h" #include "fCmplxHESS.h" #include "floatHESS.h" #include "defun.h" #include "error.h" #include "errwarn.h" #include "ovl.h" #include "utils.h" DEFUN (hess, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{H} =} hess (@var{A})\n\ @deftypefnx {} {[@var{P}, @var{H}] =} hess (@var{A})\n\ @cindex Hessenberg decomposition\n\ Compute the Hessenberg decomposition of the matrix @var{A}.\n\ \n\ The Hessenberg decomposition is\n\ @tex\n\ $$\n\ A = PHP^T\n\ $$\n\ where $P$ is a square unitary matrix ($P^TP = I$), and $H$\n\ is upper Hessenberg ($H_{i,j} = 0, \\forall i > j+1$).\n\ @end tex\n\ @ifnottex\n\ @code{@var{P} * @var{H} * @var{P}' = @var{A}} where @var{P} is a square\n\ unitary matrix (@code{@var{P}' * @var{P} = I}, using complex-conjugate\n\ transposition) and @var{H} is upper Hessenberg\n\ (@code{@var{H}(i, j) = 0 forall i > j+1)}.\n\ @end ifnottex\n\ \n\ The Hessenberg decomposition is usually used as the first step in an\n\ eigenvalue computation, but has other applications as well\n\ (see @nospell{Golub, Nash, and Van Loan},\n\ IEEE Transactions on Automatic Control, 1979).\n\ @seealso{eig, chol, lu, qr, qz, schur, svd}\n\ @end deftypefn") { if (args.length () != 1) print_usage (); octave_value arg = args(0); octave_idx_type nr = arg.rows (); octave_idx_type nc = arg.columns (); int arg_is_empty = empty_arg ("hess", nr, nc); if (arg_is_empty < 0) return ovl (); else if (arg_is_empty > 0) return octave_value_list (2, Matrix ()); if (nr != nc) err_square_matrix_required ("hess", "A"); octave_value_list retval; if (arg.is_single_type ()) { if (arg.is_real_type ()) { FloatMatrix tmp = arg.float_matrix_value (); FloatHESS result (tmp); if (nargout <= 1) retval = ovl (result.hess_matrix ()); else retval = ovl (result.unitary_hess_matrix (), result.hess_matrix ()); } else if (arg.is_complex_type ()) { FloatComplexMatrix ctmp = arg.float_complex_matrix_value (); FloatComplexHESS result (ctmp); if (nargout <= 1) retval = ovl (result.hess_matrix ()); else retval = ovl (result.unitary_hess_matrix (), result.hess_matrix ()); } } else { if (arg.is_real_type ()) { Matrix tmp = arg.matrix_value (); HESS result (tmp); if (nargout <= 1) retval = ovl (result.hess_matrix ()); else retval = ovl (result.unitary_hess_matrix (), result.hess_matrix ()); } else if (arg.is_complex_type ()) { ComplexMatrix ctmp = arg.complex_matrix_value (); ComplexHESS result (ctmp); if (nargout <= 1) retval = ovl (result.hess_matrix ()); else retval = ovl (result.unitary_hess_matrix (), result.hess_matrix ()); } else err_wrong_type_arg ("hess", arg); } return retval; } /* %!test %! a = [1, 2, 3; 5, 4, 6; 8, 7, 9]; %! [p, h] = hess (a); %! assert (p * h * p', a, sqrt (eps)); %!test %! a = single ([1, 2, 3; 5, 4, 6; 8, 7, 9]); %! [p, h] = hess (a); %! assert (p * h * p', a, sqrt (eps ("single"))); %!error hess () %!error hess ([1, 2; 3, 4], 2) %!error <must be a square matrix> hess ([1, 2; 3, 4; 5, 6]) */