Mercurial > octave
view libinterp/corefcn/balance.cc @ 21200:fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
* builtins.h, Cell.cc, __contourc__.cc, __dispatch__.cc, __dsearchn__.cc,
__ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __pchip_deriv__.cc, __qp__.cc,
balance.cc, besselj.cc, betainc.cc, bitfcns.cc, bsxfun.cc,
c-file-ptr-stream.cc, c-file-ptr-stream.h, cellfun.cc, colloc.cc,
comment-list.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc,
defaults.cc, defaults.in.h, defun-dld.h, defun.cc, defun.h, det.cc, dirfns.cc,
display.cc, dlmread.cc, dot.cc, dynamic-ld.cc, eig.cc, ellipj.cc, error.cc,
errwarn.cc, event-queue.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc,
find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc,
givens.cc, gl-render.cc, gl2ps-print.cc, graphics.cc, graphics.in.h, gripes.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, jit-ir.cc,
jit-typeinfo.cc, jit-util.cc, jit-util.h, kron.cc, load-path.cc, load-save.cc,
lookup.cc, ls-ascii-helper.cc, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc,
ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc, ls-oct-text.h, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, luinc.cc, mappers.cc, matrix_type.cc, max.cc,
mex.h, mexproto.h, mgorth.cc, nproc.cc, oct-errno.in.cc, oct-fstrm.cc,
oct-hdf5-types.cc, oct-hdf5.h, oct-hist.cc, oct-iostrm.cc, oct-lvalue.cc,
oct-map.cc, oct-prcstrm.cc, oct-procbuf.cc, oct-stream.cc, oct-strstrm.cc,
octave-link.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, procstream.cc,
profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc,
regexp.cc, schur.cc, sighandlers.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc,
spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, sysdep.h, time.cc, toplev.cc,
tril.cc, tsearch.cc, txt-eng-ft.cc, txt-eng.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, xdiv.cc, xnorm.cc, xpow.cc, zfstream.cc,
__delaunayn__.cc, __eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc,
__init_fltk__.cc, __init_gnuplot__.cc, __magick_read__.cc, __osmesa_print__.cc,
__voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc,
colamd.cc, convhulln.cc, dmperm.cc, fftw.cc, oct-qhull.h, qr.cc, symbfact.cc,
symrcm.cc, oct-conf.in.cc, ov-base-diag.cc, ov-base-int.cc, ov-base-mat.cc,
ov-base-scalar.cc, ov-base-sparse.cc, ov-base.cc, ov-bool-mat.cc,
ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc, ov-ch-mat.cc,
ov-class.cc, ov-classdef.cc, ov-colon.cc, ov-complex.cc, ov-cs-list.cc,
ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-dld-fcn.cc, ov-fcn-handle.cc,
ov-fcn-inline.cc, ov-fcn.cc, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-diag.cc,
ov-flt-cx-mat.cc, ov-flt-re-diag.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-lazy-idx.cc,
ov-mex-fcn.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-perm.cc, ov-range.cc,
ov-re-diag.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc,
ov-struct.cc, ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc,
ov-uint8.cc, ov-usr-fcn.cc, ov.cc, ovl.cc, octave.cc, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-double-conv.cc, op-fcdm-fcdm.cc,
op-fcdm-fdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc,
op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc,
op-fdm-fdm.cc, op-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc,
op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc,
op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc,
op-int-conv.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc,
op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc,
op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc,
op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc,
op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc,
op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc,
op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc,
op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, pt-arg-list.cc,
pt-array-list.cc, pt-assign.cc, pt-binop.cc, pt-bp.cc, pt-cbinop.cc,
pt-cell.cc, pt-check.cc, pt-classdef.cc, pt-cmd.cc, pt-colon.cc, pt-colon.h,
pt-const.cc, pt-decl.cc, pt-eval.cc, pt-except.cc, pt-exp.cc, pt-fcn-handle.cc,
pt-funcall.cc, pt-id.cc, pt-idx.cc, pt-jump.cc, pt-loop.cc, pt-mat.cc,
pt-misc.cc, pt-pr-code.cc, pt-select.cc, pt-stmt.cc, pt-unop.cc, pt.cc,
token.cc, Array-jit.cc, Array-os.cc, Array-sym.cc, Array-tc.cc, version.cc:
Indent #ifdef blocks in libinterp.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 05 Feb 2016 16:29:08 -0800 |
parents | 3d0d84305600 |
children | f08ae27289e4 |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton Copyright (C) 2008-2009 Jaroslav Hajek 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/>. */ // Author: A. S. Hodel <scotte@eng.auburn.edu> #ifdef HAVE_CONFIG_H # include <config.h> #endif #include <string> #include "CmplxAEPBAL.h" #include "fCmplxAEPBAL.h" #include "dbleAEPBAL.h" #include "floatAEPBAL.h" #include "CmplxGEPBAL.h" #include "fCmplxGEPBAL.h" #include "dbleGEPBAL.h" #include "floatGEPBAL.h" #include "quit.h" #include "defun.h" #include "error.h" #include "f77-fcn.h" #include "errwarn.h" #include "ovl.h" #include "utils.h" DEFUN (balance, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{AA} =} balance (@var{A})\n\ @deftypefnx {} {@var{AA} =} balance (@var{A}, @var{opt})\n\ @deftypefnx {} {[@var{DD}, @var{AA}] =} balance (@var{A}, @var{opt})\n\ @deftypefnx {} {[@var{D}, @var{P}, @var{AA}] =} balance (@var{A}, @var{opt})\n\ @deftypefnx {} {[@var{CC}, @var{DD}, @var{AA}, @var{BB}] =} balance (@var{A}, @var{B}, @var{opt})\n\ \n\ Balance the matrix @var{A} to reduce numerical errors in future\n\ calculations.\n\ \n\ Compute @code{@var{AA} = @var{DD} \\ @var{A} * @var{DD}} in which @var{AA}\n\ is a matrix whose row and column norms are roughly equal in magnitude, and\n\ @code{@var{DD} = @var{P} * @var{D}}, in which @var{P} is a permutation\n\ matrix and @var{D} is a diagonal matrix of powers of two. This allows the\n\ equilibration to be computed without round-off. Results of eigenvalue\n\ calculation are typically improved by balancing first.\n\ \n\ If two output values are requested, @code{balance} returns\n\ the diagonal @var{D} and the permutation @var{P} separately as vectors.\n\ In this case, @code{@var{DD} = eye(n)(:,@var{P}) * diag (@var{D})}, where\n\ @math{n} is the matrix size.\n\ \n\ If four output values are requested, compute @code{@var{AA} =\n\ @var{CC}*@var{A}*@var{DD}} and @code{@var{BB} = @var{CC}*@var{B}*@var{DD}},\n\ in which @var{AA} and @var{BB} have nonzero elements of approximately the\n\ same magnitude and @var{CC} and @var{DD} are permuted diagonal matrices as\n\ in @var{DD} for the algebraic eigenvalue problem.\n\ \n\ The eigenvalue balancing option @var{opt} may be one of:\n\ \n\ @table @asis\n\ @item @qcode{\"noperm\"}, @qcode{\"S\"}\n\ Scale only; do not permute.\n\ \n\ @item @qcode{\"noscal\"}, @qcode{\"P\"}\n\ Permute only; do not scale.\n\ @end table\n\ \n\ Algebraic eigenvalue balancing uses standard @sc{lapack} routines.\n\ \n\ Generalized eigenvalue problem balancing uses Ward's algorithm\n\ (SIAM Journal on Scientific and Statistical Computing, 1981).\n\ @end deftypefn") { int nargin = args.length (); if (nargin < 1 || nargin > 3 || nargout < 0) print_usage (); octave_value_list retval; // determine if it's AEP or GEP bool AEPcase = nargin == 1 || args(1).is_string (); // problem dimension octave_idx_type nn = args(0).rows (); if (nn != args(0).columns ()) err_square_matrix_required ("balance", "A"); bool isfloat = args(0).is_single_type () || (! AEPcase && args(1).is_single_type ()); bool complex_case = args(0).is_complex_type () || (! AEPcase && args(1).is_complex_type ()); // Extract argument 1 parameter for both AEP and GEP. Matrix aa; ComplexMatrix caa; FloatMatrix faa; FloatComplexMatrix fcaa; if (isfloat) { if (complex_case) fcaa = args(0).float_complex_matrix_value (); else faa = args(0).float_matrix_value (); } else { if (complex_case) caa = args(0).complex_matrix_value (); else aa = args(0).matrix_value (); } // Treat AEP/GEP cases. if (AEPcase) { // Algebraic eigenvalue problem. bool noperm = false; bool noscal = false; if (nargin > 1) { std::string a1s = args(1).string_value (); noperm = a1s == "noperm" || a1s == "S"; noscal = a1s == "noscal" || a1s == "P"; } // balance the AEP if (isfloat) { if (complex_case) { FloatComplexAEPBALANCE result (fcaa, noperm, noscal); if (nargout == 0 || nargout == 1) retval = ovl (result.balanced_matrix ()); else if (nargout == 2) retval = ovl (result.balancing_matrix (), result.balanced_matrix ()); else retval = ovl (result.scaling_vector (), result.permuting_vector (), result.balanced_matrix ()); } else { FloatAEPBALANCE result (faa, noperm, noscal); if (nargout == 0 || nargout == 1) retval = ovl (result.balanced_matrix ()); else if (nargout == 2) retval = ovl (result.balancing_matrix (), result.balanced_matrix ()); else retval = ovl (result.scaling_vector (), result.permuting_vector (), result.balanced_matrix ()); } } else { if (complex_case) { ComplexAEPBALANCE result (caa, noperm, noscal); if (nargout == 0 || nargout == 1) retval = ovl (result.balanced_matrix ()); else if (nargout == 2) retval = ovl (result.balancing_matrix (), result.balanced_matrix ()); else retval = ovl (result.scaling_vector (), result.permuting_vector (), result.balanced_matrix ()); } else { AEPBALANCE result (aa, noperm, noscal); if (nargout == 0 || nargout == 1) retval = ovl (result.balanced_matrix ()); else if (nargout == 2) retval = ovl (result.balancing_matrix (), result.balanced_matrix ()); else retval = ovl (result.scaling_vector (), result.permuting_vector (), result.balanced_matrix ()); } } } else { std::string bal_job; if (nargout == 1) warning ("balance: used GEP, should have two output arguments"); // Generalized eigenvalue problem. if (nargin == 2) bal_job = "B"; else bal_job = args(2).xstring_value ("balance: OPT argument must be a string"); if ((nn != args(1).columns ()) || (nn != args(1).rows ())) err_nonconformant (); Matrix bb; ComplexMatrix cbb; FloatMatrix fbb; FloatComplexMatrix fcbb; if (isfloat) { if (complex_case) fcbb = args(1).float_complex_matrix_value (); else fbb = args(1).float_matrix_value (); } else { if (complex_case) cbb = args(1).complex_matrix_value (); else bb = args(1).matrix_value (); } // balance the GEP if (isfloat) { if (complex_case) { FloatComplexGEPBALANCE result (fcaa, fcbb, bal_job); switch (nargout) { case 4: retval(3) = result.balanced_matrix2 (); // fall through case 3: retval(2) = result.balanced_matrix (); retval(1) = result.balancing_matrix2 (); retval(0) = result.balancing_matrix (); break; case 2: retval(1) = result.balancing_matrix2 (); // fall through case 1: retval(0) = result.balancing_matrix (); break; default: error ("balance: invalid number of output arguments"); break; } } else { FloatGEPBALANCE result (faa, fbb, bal_job); switch (nargout) { case 4: retval(3) = result.balanced_matrix2 (); // fall through case 3: retval(2) = result.balanced_matrix (); retval(1) = result.balancing_matrix2 (); retval(0) = result.balancing_matrix (); break; case 2: retval(1) = result.balancing_matrix2 (); // fall through case 1: retval(0) = result.balancing_matrix (); break; default: error ("balance: invalid number of output arguments"); break; } } } else { if (complex_case) { ComplexGEPBALANCE result (caa, cbb, bal_job); switch (nargout) { case 4: retval(3) = result.balanced_matrix2 (); // fall through case 3: retval(2) = result.balanced_matrix (); retval(1) = result.balancing_matrix2 (); retval(0) = result.balancing_matrix (); break; case 2: retval(1) = result.balancing_matrix2 (); // fall through case 1: retval(0) = result.balancing_matrix (); break; default: error ("balance: invalid number of output arguments"); break; } } else { GEPBALANCE result (aa, bb, bal_job); switch (nargout) { case 4: retval(3) = result.balanced_matrix2 (); // fall through case 3: retval(2) = result.balanced_matrix (); retval(1) = result.balancing_matrix2 (); retval(0) = result.balancing_matrix (); break; case 2: retval(1) = result.balancing_matrix2 (); // fall through case 1: retval(0) = result.balancing_matrix (); break; default: error ("balance: invalid number of output arguments"); break; } } } } return retval; }