Mercurial > octave
view libinterp/corefcn/eig.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.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, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.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.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-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, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | aba2e6293dd8 |
children | 510886d03ef2 |
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/>. */ #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "EIG.h" #include "fEIG.h" #include "defun.h" #include "error.h" #include "errwarn.h" #include "ovl.h" #include "utils.h" DEFUN (eig, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{lambda} =} eig (@var{A}) @deftypefnx {} {@var{lambda} =} eig (@var{A}, @var{B}) @deftypefnx {} {[@var{V}, @var{lambda}] =} eig (@var{A}) @deftypefnx {} {[@var{V}, @var{lambda}] =} eig (@var{A}, @var{B}) Compute the eigenvalues (and optionally the eigenvectors) of a matrix or a pair of matrices The algorithm used depends on whether there are one or two input matrices, if they are real or complex, and if they are symmetric (Hermitian if complex) or non-symmetric. The eigenvalues returned by @code{eig} are not ordered. @seealso{eigs, svd} @end deftypefn */) { int nargin = args.length (); if (nargin > 2 || nargin == 0) print_usage (); octave_value_list retval; octave_value arg_a, arg_b; octave_idx_type nr_a, nr_b, nc_a, nc_b; nr_a = nr_b = nc_a = nc_b = 0; arg_a = args(0); nr_a = arg_a.rows (); nc_a = arg_a.columns (); int arg_is_empty = empty_arg ("eig", nr_a, nc_a); if (arg_is_empty < 0) return retval; else if (arg_is_empty > 0) return octave_value_list (2, Matrix ()); if (! arg_a.is_double_type () && ! arg_a.is_single_type ()) err_wrong_type_arg ("eig", arg_a); if (nargin == 2) { arg_b = args(1); nr_b = arg_b.rows (); nc_b = arg_b.columns (); arg_is_empty = empty_arg ("eig", nr_b, nc_b); if (arg_is_empty < 0) return retval; else if (arg_is_empty > 0) return ovl (2, Matrix ()); if (! arg_b.is_single_type () && ! arg_b.is_double_type ()) err_wrong_type_arg ("eig", arg_b); } if (nr_a != nc_a) err_square_matrix_required ("eig", "A"); if (nargin == 2 && nr_b != nc_b) err_square_matrix_required ("eig", "B"); Matrix tmp_a, tmp_b; ComplexMatrix ctmp_a, ctmp_b; FloatMatrix ftmp_a, ftmp_b; FloatComplexMatrix fctmp_a, fctmp_b; if (arg_a.is_single_type ()) { FloatEIG result; if (nargin == 1) { if (arg_a.is_real_type ()) { ftmp_a = arg_a.float_matrix_value (); result = FloatEIG (ftmp_a, nargout > 1); } else { fctmp_a = arg_a.float_complex_matrix_value (); result = FloatEIG (fctmp_a, nargout > 1); } } else if (nargin == 2) { if (arg_a.is_real_type () && arg_b.is_real_type ()) { ftmp_a = arg_a.float_matrix_value (); ftmp_b = arg_b.float_matrix_value (); result = FloatEIG (ftmp_a, ftmp_b, nargout > 1); } else { fctmp_a = arg_a.float_complex_matrix_value (); fctmp_b = arg_b.float_complex_matrix_value (); result = FloatEIG (fctmp_a, fctmp_b, nargout > 1); } } if (nargout == 0 || nargout == 1) { retval = ovl (result.eigenvalues ()); } else { // Blame it on Matlab. FloatComplexDiagMatrix d (result.eigenvalues ()); retval = ovl (result.eigenvectors (), d); } } else { EIG result; if (nargin == 1) { if (arg_a.is_real_type ()) { tmp_a = arg_a.matrix_value (); result = EIG (tmp_a, nargout > 1); } else { ctmp_a = arg_a.complex_matrix_value (); result = EIG (ctmp_a, nargout > 1); } } else if (nargin == 2) { if (arg_a.is_real_type () && arg_b.is_real_type ()) { tmp_a = arg_a.matrix_value (); tmp_b = arg_b.matrix_value (); result = EIG (tmp_a, tmp_b, nargout > 1); } else { ctmp_a = arg_a.complex_matrix_value (); ctmp_b = arg_b.complex_matrix_value (); result = EIG (ctmp_a, ctmp_b, nargout > 1); } } if (nargout == 0 || nargout == 1) { retval = ovl (result.eigenvalues ()); } else { // Blame it on Matlab. ComplexDiagMatrix d (result.eigenvalues ()); retval = ovl (result.eigenvectors (), d); } } return retval; } /* %!assert (eig ([1, 2; 2, 1]), [-1; 3], sqrt (eps)) %!test %! [v, d] = eig ([1, 2; 2, 1]); %! x = 1 / sqrt (2); %! assert (d, [-1, 0; 0, 3], sqrt (eps)); %! assert (v, [-x, x; x, x], sqrt (eps)); %!assert (eig (single ([1, 2; 2, 1])), single ([-1; 3]), sqrt (eps ("single"))) %!test %! [v, d] = eig (single ([1, 2; 2, 1])); %! x = single (1 / sqrt (2)); %! assert (d, single ([-1, 0; 0, 3]), sqrt (eps ("single"))); %! assert (v, [-x, x; x, x], sqrt (eps ("single"))); %!test %! A = [1, 2; -1, 1]; B = [3, 3; 1, 2]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = single ([1, 2; -1, 1]); B = single ([3, 3; 1, 2]); %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps ("single"))); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps ("single"))); %!test %! A = [1, 2; 2, 1]; B = [3, -2; -2, 3]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = single ([1, 2; 2, 1]); B = single ([3, -2; -2, 3]); %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps ("single"))); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps ("single"))); %!test %! A = [1+3i, 2+i; 2-i, 1+3i]; B = [5+9i, 2+i; 2-i, 5+9i]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = single ([1+3i, 2+i; 2-i, 1+3i]); B = single ([5+9i, 2+i; 2-i, 5+9i]); %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps ("single"))); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps ("single"))); %!test %! A = [1+3i, 2+3i; 3-8i, 8+3i]; B = [8+i, 3+i; 4-9i, 3+i]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = single ([1+3i, 2+3i; 3-8i, 8+3i]); B = single ([8+i, 3+i; 4-9i, 3+i]); %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps ("single"))); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps ("single"))); %!test %! A = [1, 2; 3, 8]; B = [8, 3; 4, 3]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = [1, 1+i; 1-i, 1]; B = [2, 0; 0, 2]; %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps)); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps)); %!test %! A = single ([1, 1+i; 1-i, 1]); B = single ([2, 0; 0, 2]); %! [v, d] = eig (A, B); %! assert (A * v(:, 1), d(1, 1) * B * v(:, 1), sqrt (eps ("single"))); %! assert (A * v(:, 2), d(2, 2) * B * v(:, 2), sqrt (eps ("single"))); %!error eig () %!error eig ([1, 2; 3, 4], [4, 3; 2, 1], 1) %!error <EIG requires same size matrices> eig ([1, 2; 3, 4], 2) %!error <must be a square matrix> eig ([1, 2; 3, 4; 5, 6]) %!error <wrong type argument> eig ("abcd") %!error <wrong type argument> eig ([1 2 ; 2 3], "abcd") %!error <wrong type argument> eig (false, [1 2 ; 2 3]) */