Mercurial > octave
view libinterp/dldfcn/__eigs__.cc @ 21100:e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
* libinterp/corefcn/errwarn.h, libinterp/corefcn/errwarn.cc: New header and .cc
file with common errors and warnings for libinterp.
* libinterp/corefcn/module.mk: Add errwarn.h, errwarn.cc to build system.
* liboctave/util/lo-array-errwarn.h, liboctave/util/lo-array-errwarn.cc: New
header and .cc file with common errors and warnings for liboctave.
* liboctave/util/module.mk: Add lo-array-errwarn.h, lo-array-errwarn.cc to
build system.
* lo-array-gripes.h: #include "lo-array-errwarn.h" for access to class
index_exception. Remove const char *error_id_XXX prototypes.
* lo-array-gripes.cc: Remove const char *error_id_XXX initializations.
Remove index_exception method definitions.
* Cell.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, betainc.cc, cellfun.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc,
dirfns.cc, eig.cc, fft.cc, fft2.cc, fftn.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, graphics.in.h, help.cc, hess.cc, hex2num.cc,
input.cc, inv.cc, jit-typeinfo.cc, load-save.cc, lookup.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc,
lsode.cc, lu.cc, luinc.cc, max.cc, mgorth.cc, oct-hist.cc, oct-procbuf.cc,
oct-stream.cc, oct.h, pager.cc, pinv.cc, pr-output.cc, quad.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.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, syscalls.cc, typecast.cc, utils.cc, variables.cc, xdiv.cc,
xnorm.cc, xpow.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc,
__osmesa_print__.cc, audiodevinfo.cc, audioread.cc, chol.cc, dmperm.cc,
fftw.cc, qr.cc, symbfact.cc, symrcm.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-complex.cc, ov-complex.h, ov-cs-list.cc,
ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc,
ov-fcn-inline.cc, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h,
ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-intx.h, ov-mex-fcn.cc, ov-perm.cc,
ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-scalar.h,
ov-str-mat.cc, ov-struct.cc, ov-type-conv.h, ov-uint16.cc, ov-uint32.cc,
ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.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-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-int.h, 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-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,
ops.h, lex.ll, pt-assign.cc, pt-eval.cc, pt-idx.cc, pt-loop.cc, pt-mat.cc,
pt-stmt.cc, Array-util.cc, Array-util.h, Array.cc, CColVector.cc,
CDiagMatrix.cc, CMatrix.cc, CNDArray.cc, CRowVector.cc, CSparse.cc,
DiagArray2.cc, MDiagArray2.cc, MSparse.cc, PermMatrix.cc, Range.cc, Sparse.cc,
dColVector.cc, dDiagMatrix.cc, dMatrix.cc, dNDArray.cc, dRowVector.cc,
dSparse.cc, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc, fCNDArray.cc,
fCRowVector.cc, fColVector.cc, fDiagMatrix.cc, fMatrix.cc, fNDArray.cc,
fRowVector.cc, idx-vector.cc, CmplxGEPBAL.cc, dbleGEPBAL.cc, fCmplxGEPBAL.cc,
floatGEPBAL.cc, Sparse-diag-op-defs.h, Sparse-op-defs.h, Sparse-perm-op-defs.h,
mx-inlines.cc, mx-op-defs.h, oct-binmap.h:
Replace 'include "gripes.h"' with 'include "errwarn.h". Change all gripe_XXX
to err_XXX or warn_XXX or errwarn_XXX.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 18 Jan 2016 18:28:06 -0800 |
parents | 850e3d2533d4 |
children | bd1752782e56 |
line wrap: on
line source
/* Copyright (C) 2005-2015 David Bateman 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 "ov.h" #include "defun-dld.h" #include "error.h" #include "errwarn.h" #include "quit.h" #include "variables.h" #include "ov-re-sparse.h" #include "ov-cx-sparse.h" #include "oct-map.h" #include "pager.h" #include "unwind-prot.h" #include "eigs-base.cc" // Global pointer for user defined function. static octave_function *eigs_fcn = 0; // Have we warned about imaginary values returned from user function? static bool warned_imaginary = false; // Is this a recursive call? static int call_depth = 0; ColumnVector eigs_func (const ColumnVector &x, int &eigs_error) { ColumnVector retval; octave_value_list args; args(0) = x; if (eigs_fcn) { octave_value_list tmp; try { tmp = eigs_fcn->do_multi_index_op (1, args); } catch (octave_execution_exception& e) { err_user_supplied_eval (e, "eigs"); } if (tmp.length () && tmp(0).is_defined ()) { if (! warned_imaginary && tmp(0).is_complex_type ()) { warning ("eigs: ignoring imaginary part returned from user-supplied function"); warned_imaginary = true; } retval = tmp(0).xvector_value ("eigs: evaluation of user-supplied function failed"); } else { eigs_error = 1; err_user_supplied_eval ("eigs"); } } return retval; } ComplexColumnVector eigs_complex_func (const ComplexColumnVector &x, int &eigs_error) { ComplexColumnVector retval; octave_value_list args; args(0) = x; if (eigs_fcn) { octave_value_list tmp; try { tmp = eigs_fcn->do_multi_index_op (1, args); } catch (octave_execution_exception& e) { err_user_supplied_eval (e, "eigs"); } if (tmp.length () && tmp(0).is_defined ()) { retval = tmp(0).complex_vector_value ("eigs: evaluation of user-supplied function failed"); } else { eigs_error = 1; err_user_supplied_eval ("eigs"); } } return retval; } DEFUN_DLD (__eigs__, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{d} =} __eigs__ (@var{A})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{k})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{k}, @var{sigma})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{k}, @var{sigma}, @var{opts})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{B})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{B}, @var{k})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{B}, @var{k}, @var{sigma})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{A}, @var{B}, @var{k}, @var{sigma}, @var{opts})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{B})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{k})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{B}, @var{k})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{k}, @var{sigma})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{B}, @var{k}, @var{sigma})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{k}, @var{sigma}, @var{opts})\n\ @deftypefnx {} {@var{d} =} __eigs__ (@var{af}, @var{n}, @var{B}, @var{k}, @var{sigma}, @var{opts})\n\ @deftypefnx {} {[@var{V}, @var{d}] =} __eigs__ (@var{A}, @dots{})\n\ @deftypefnx {} {[@var{V}, @var{d}] =} __eigs__ (@var{af}, @var{n}, @dots{})\n\ @deftypefnx {} {[@var{V}, @var{d}, @var{flag}] =} __eigs__ (@var{A}, @dots{})\n\ @deftypefnx {} {[@var{V}, @var{d}, @var{flag}] =} __eigs__ (@var{af}, @var{n}, @dots{})\n\ Undocumented internal function.\n\ @end deftypefn") { #ifdef HAVE_ARPACK int nargin = args.length (); if (nargin == 0) print_usage (); octave_value_list retval; std::string fcn_name; octave_idx_type n = 0; octave_idx_type k = 6; Complex sigma = 0.; double sigmar, sigmai; bool have_sigma = false; std::string typ = "LM"; Matrix amm, bmm, bmt; ComplexMatrix acm, bcm, bct; SparseMatrix asmm, bsmm, bsmt; SparseComplexMatrix ascm, bscm, bsct; int b_arg = 0; bool have_b = false; bool have_a_fun = false; bool a_is_complex = false; bool b_is_complex = false; bool symmetric = false; bool sym_tested = false; bool cholB = false; bool a_is_sparse = false; ColumnVector permB; int arg_offset = 0; double tol = std::numeric_limits<double>::epsilon (); int maxit = 300; int disp = 0; octave_idx_type p = -1; ColumnVector resid; ComplexColumnVector cresid; octave_idx_type info = 1; warned_imaginary = false; unwind_protect frame; frame.protect_var (call_depth); call_depth++; if (call_depth > 1) error ("eigs: invalid recursive call"); if (args(0).is_function_handle () || args(0).is_inline_function () || args(0).is_string ()) { if (args(0).is_string ()) { std::string name = args(0).string_value (); std::string fname = "function y = "; fcn_name = unique_symbol_name ("__eigs_fcn__"); fname.append (fcn_name); fname.append ("(x) y = "); eigs_fcn = extract_function (args(0), "eigs", fcn_name, fname, "; endfunction"); } else eigs_fcn = args(0).function_value (); if (! eigs_fcn) error ("eigs: unknown function"); if (nargin < 2) error ("eigs: incorrect number of arguments"); n = args(1).nint_value (); arg_offset = 1; have_a_fun = true; } else { if (args(0).is_complex_type ()) { if (args(0).is_sparse_type ()) { ascm = (args(0).sparse_complex_matrix_value ()); a_is_sparse = true; } else acm = (args(0).complex_matrix_value ()); a_is_complex = true; symmetric = false; // ARPACK doesn't special case complex symmetric sym_tested = true; } else { if (args(0).is_sparse_type ()) { asmm = (args(0).sparse_matrix_value ()); a_is_sparse = true; } else { amm = (args(0).matrix_value ()); } } } // Note hold off reading B until later to avoid issues of double // copies of the matrix if B is full/real while A is complex. if (nargin > 1 + arg_offset && ! (args(1 + arg_offset).is_real_scalar ())) { if (args(1+arg_offset).is_complex_type ()) { b_arg = 1+arg_offset; have_b = true; b_is_complex = true; arg_offset++; } else { b_arg = 1+arg_offset; have_b = true; arg_offset++; } } if (nargin > (1+arg_offset)) k = args(1+arg_offset).nint_value (); if (nargin > (2+arg_offset)) { if (args(2+arg_offset).is_string ()) { typ = args(2+arg_offset).string_value (); // Use STL function to convert to upper case transform (typ.begin (), typ.end (), typ.begin (), toupper); sigma = 0.; } else { sigma = args(2+arg_offset).xcomplex_value ("eigs: SIGMA must be a scalar or a string"); have_sigma = true; } } sigmar = std::real (sigma); sigmai = std::imag (sigma); if (nargin > (3+arg_offset)) { if (! args(3+arg_offset).is_map ()) error ("eigs: OPTS argument must be a structure"); octave_scalar_map map = args(3+arg_offset).xscalar_map_value ("eigs: OPTS argument must be a scalar structure"); octave_value tmp; // issym is ignored for complex matrix inputs tmp = map.getfield ("issym"); if (tmp.is_defined () && ! sym_tested) { symmetric = tmp.double_value () != 0.; sym_tested = true; } // isreal is ignored if A is not a function tmp = map.getfield ("isreal"); if (tmp.is_defined () && have_a_fun) a_is_complex = ! (tmp.double_value () != 0.); tmp = map.getfield ("tol"); if (tmp.is_defined ()) tol = tmp.double_value (); tmp = map.getfield ("maxit"); if (tmp.is_defined ()) maxit = tmp.nint_value (); tmp = map.getfield ("p"); if (tmp.is_defined ()) p = tmp.nint_value (); tmp = map.getfield ("v0"); if (tmp.is_defined ()) { if (a_is_complex || b_is_complex) cresid = ComplexColumnVector (tmp.complex_vector_value ()); else resid = ColumnVector (tmp.vector_value ()); } tmp = map.getfield ("disp"); if (tmp.is_defined ()) disp = tmp.nint_value (); tmp = map.getfield ("cholB"); if (tmp.is_defined ()) cholB = tmp.double_value () != 0.; tmp = map.getfield ("permB"); if (tmp.is_defined ()) permB = ColumnVector (tmp.vector_value ()) - 1.0; } if (nargin > (4+arg_offset)) error ("eigs: incorrect number of arguments"); // Test undeclared (no issym) matrix inputs for symmetry if (! sym_tested && ! have_a_fun) { if (a_is_sparse) symmetric = asmm.is_symmetric (); else symmetric = amm.is_symmetric (); } if (have_b) { if (a_is_complex || b_is_complex) { if (a_is_sparse) bscm = args(b_arg).sparse_complex_matrix_value (); else bcm = args(b_arg).complex_matrix_value (); } else { if (a_is_sparse) bsmm = args(b_arg).sparse_matrix_value (); else bmm = args(b_arg).matrix_value (); } } // Mode 1 for SM mode seems unstable for some reason. // Use Mode 3 instead, with sigma = 0. if (! have_sigma && typ == "SM") have_sigma = true; octave_idx_type nconv; if (a_is_complex || b_is_complex) { ComplexMatrix eig_vec; ComplexColumnVector eig_val; if (have_a_fun) nconv = EigsComplexNonSymmetricFunc (eigs_complex_func, n, typ, sigma, k, p, info, eig_vec, eig_val, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else if (have_sigma) { if (a_is_sparse) nconv = EigsComplexNonSymmetricMatrixShift (ascm, sigma, k, p, info, eig_vec, eig_val, bscm, permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsComplexNonSymmetricMatrixShift (acm, sigma, k, p, info, eig_vec, eig_val, bcm, permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } else { if (a_is_sparse) nconv = EigsComplexNonSymmetricMatrix (ascm, typ, k, p, info, eig_vec, eig_val, bscm, permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsComplexNonSymmetricMatrix (acm, typ, k, p, info, eig_vec, eig_val, bcm, permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } if (nargout < 2) retval(0) = eig_val; else retval = ovl (eig_vec, ComplexDiagMatrix (eig_val), double (info)); } else if (sigmai != 0.) { // Promote real problem to a complex one. ComplexMatrix eig_vec; ComplexColumnVector eig_val; if (have_a_fun) nconv = EigsComplexNonSymmetricFunc (eigs_complex_func, n, typ, sigma, k, p, info, eig_vec, eig_val, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else { if (a_is_sparse) nconv = EigsComplexNonSymmetricMatrixShift (SparseComplexMatrix (asmm), sigma, k, p, info, eig_vec, eig_val, SparseComplexMatrix (bsmm), permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsComplexNonSymmetricMatrixShift (ComplexMatrix (amm), sigma, k, p, info, eig_vec, eig_val, ComplexMatrix (bmm), permB, cresid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } if (nargout < 2) retval(0) = eig_val; else retval = ovl (eig_vec, ComplexDiagMatrix (eig_val), double (info)); } else { if (symmetric) { Matrix eig_vec; ColumnVector eig_val; if (have_a_fun) nconv = EigsRealSymmetricFunc (eigs_func, n, typ, sigmar, k, p, info, eig_vec, eig_val, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else if (have_sigma) { if (a_is_sparse) nconv = EigsRealSymmetricMatrixShift (asmm, sigmar, k, p, info, eig_vec, eig_val, bsmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsRealSymmetricMatrixShift (amm, sigmar, k, p, info, eig_vec, eig_val, bmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } else { if (a_is_sparse) nconv = EigsRealSymmetricMatrix (asmm, typ, k, p, info, eig_vec, eig_val, bsmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsRealSymmetricMatrix (amm, typ, k, p, info, eig_vec, eig_val, bmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } if (nargout < 2) retval(0) = eig_val; else retval = ovl (eig_vec, DiagMatrix (eig_val), double (info)); } else { ComplexMatrix eig_vec; ComplexColumnVector eig_val; if (have_a_fun) nconv = EigsRealNonSymmetricFunc (eigs_func, n, typ, sigmar, k, p, info, eig_vec, eig_val, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else if (have_sigma) { if (a_is_sparse) nconv = EigsRealNonSymmetricMatrixShift (asmm, sigmar, k, p, info, eig_vec, eig_val, bsmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsRealNonSymmetricMatrixShift (amm, sigmar, k, p, info, eig_vec, eig_val, bmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } else { if (a_is_sparse) nconv = EigsRealNonSymmetricMatrix (asmm, typ, k, p, info, eig_vec, eig_val, bsmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); else nconv = EigsRealNonSymmetricMatrix (amm, typ, k, p, info, eig_vec, eig_val, bmm, permB, resid, octave_stdout, tol, (nargout > 1), cholB, disp, maxit); } if (nargout < 2) retval(0) = eig_val; else retval = ovl (eig_vec, ComplexDiagMatrix (eig_val), double (info)); } } if (nconv <= 0) warning ("eigs: None of the %d requested eigenvalues converged", k); else if (nconv < k) warning ("eigs: Only %d of the %d requested eigenvalues converged", nconv, k); if (! fcn_name.empty ()) clear_function (fcn_name); return retval; #else error ("eigs: not available in this version of Octave"); #endif }