Mercurial > octave-nkf
changeset 19099:d20c81d3cd21
Deprecate syl, add new function sylvester.
* sylvester.cc: New function
* syl.cc: Remove syl C++ function.
* scriptss/deprecated/syl.m: m-file to replace syl.cc
* NEWS: Announce new sylvester function. Announce deprecation of syl.
* linalg.txi: Replace reference to syl with sylvester.
* libinterp/corefcn/module.mk: Add sylvester.cc to build system.
* scripts/deprecated/module.mk: Add syl.m to build system.
* CMatrix.cc (Sylvester), dMatrix.cc (Sylvester), fCMatrix.cc (Sylvester),
fMatrix.cc (Sylvester): Return +C rather than -C to conform to changed
definition of Sylvester equation.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 31 Aug 2014 21:05:38 -0700 |
parents | d3a223128efc |
children | f7c524595a71 |
files | NEWS doc/interpreter/linalg.txi libinterp/corefcn/module.mk libinterp/corefcn/syl.cc libinterp/corefcn/sylvester.cc liboctave/array/CMatrix.cc liboctave/array/dMatrix.cc liboctave/array/fCMatrix.cc liboctave/array/fMatrix.cc scripts/deprecated/module.mk scripts/deprecated/syl.m |
diffstat | 11 files changed, 306 insertions(+), 227 deletions(-) [+] |
line wrap: on
line diff
--- a/NEWS Sun Aug 31 21:41:33 2014 +0200 +++ b/NEWS Sun Aug 31 21:05:38 2014 -0700 @@ -69,7 +69,7 @@ bandwidth ilu javachk dir_in_loadpath isbanded linkaxes hgload isdiag numfields - hgsave istril + hgsave istril sylvester ichol istriu ** Deprecated functions. @@ -78,7 +78,7 @@ be removed from Octave 4.6 (or whatever version is the second major release after 4.2): - bicubic + bicubic syl find_dir_in_path nfields
--- a/doc/interpreter/linalg.txi Sun Aug 31 21:41:33 2014 +0200 +++ b/doc/interpreter/linalg.txi Sun Aug 31 21:05:38 2014 -0700 @@ -201,7 +201,7 @@ @DOCSTRING(blkmm) -@DOCSTRING(syl) +@DOCSTRING(sylvester) @node Specialized Solvers @section Specialized Solvers
--- a/libinterp/corefcn/module.mk Sun Aug 31 21:41:33 2014 +0200 +++ b/libinterp/corefcn/module.mk Sun Aug 31 21:05:38 2014 -0700 @@ -244,7 +244,7 @@ corefcn/strfns.cc \ corefcn/sub2ind.cc \ corefcn/svd.cc \ - corefcn/syl.cc \ + corefcn/sylvester.cc \ corefcn/symtab.cc \ corefcn/syscalls.cc \ corefcn/sysdep.cc \
--- a/libinterp/corefcn/syl.cc Sun Aug 31 21:41:33 2014 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,218 +0,0 @@ -/* - -Copyright (C) 1996-2013 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/>. - -*/ - -// Author: A. S. Hodel <scotte@eng.auburn.edu> - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include "defun.h" -#include "error.h" -#include "gripes.h" -#include "oct-obj.h" -#include "utils.h" - -DEFUN (syl, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{x} =} syl (@var{A}, @var{B}, @var{C})\n\ -Solve the Sylvester equation\n\ -@tex\n\ -$$\n\ - A X + X B + C = 0\n\ -$$\n\ -@end tex\n\ -@ifnottex\n\ -\n\ -@example\n\ -A X + X B + C = 0\n\ -@end example\n\ -\n\ -@end ifnottex\n\ -using standard @sc{lapack} subroutines. For example:\n\ -\n\ -@example\n\ -@group\n\ -syl ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12])\n\ - @result{} [ -0.50000, -0.66667; -0.66667, -0.50000 ]\n\ -@end group\n\ -@end example\n\ -@end deftypefn") -{ - octave_value retval; - - int nargin = args.length (); - - if (nargin != 3 || nargout > 1) - { - print_usage (); - return retval; - } - - octave_value arg_a = args(0); - octave_value arg_b = args(1); - octave_value arg_c = args(2); - - octave_idx_type a_nr = arg_a.rows (); - octave_idx_type a_nc = arg_a.columns (); - - octave_idx_type b_nr = arg_b.rows (); - octave_idx_type b_nc = arg_b.columns (); - - octave_idx_type c_nr = arg_c.rows (); - octave_idx_type c_nc = arg_c.columns (); - - int arg_a_is_empty = empty_arg ("syl", a_nr, a_nc); - int arg_b_is_empty = empty_arg ("syl", b_nr, b_nc); - int arg_c_is_empty = empty_arg ("syl", c_nr, c_nc); - - bool isfloat = arg_a.is_single_type () || arg_b.is_single_type () - || arg_c.is_single_type (); - - if (arg_a_is_empty > 0 && arg_b_is_empty > 0 && arg_c_is_empty > 0) - if (isfloat) - return octave_value (FloatMatrix ()); - else - return octave_value (Matrix ()); - else if (arg_a_is_empty || arg_b_is_empty || arg_c_is_empty) - return retval; - - // Arguments are not empty, so check for correct dimensions. - - if (a_nr != a_nc || b_nr != b_nc) - { - gripe_square_matrix_required ("syl: first two parameters:"); - return retval; - } - else if (a_nr != c_nr || b_nr != c_nc) - { - gripe_nonconformant (); - return retval; - } - - // Dimensions look o.k., let's solve the problem. - if (isfloat) - { - if (arg_a.is_complex_type () - || arg_b.is_complex_type () - || arg_c.is_complex_type ()) - { - // Do everything in complex arithmetic; - - FloatComplexMatrix ca = arg_a.float_complex_matrix_value (); - - if (error_state) - return retval; - - FloatComplexMatrix cb = arg_b.float_complex_matrix_value (); - - if (error_state) - return retval; - - FloatComplexMatrix cc = arg_c.float_complex_matrix_value (); - - if (error_state) - return retval; - - retval = Sylvester (ca, cb, cc); - } - else - { - // Do everything in real arithmetic. - - FloatMatrix ca = arg_a.float_matrix_value (); - - if (error_state) - return retval; - - FloatMatrix cb = arg_b.float_matrix_value (); - - if (error_state) - return retval; - - FloatMatrix cc = arg_c.float_matrix_value (); - - if (error_state) - return retval; - - retval = Sylvester (ca, cb, cc); - } - } - else - { - if (arg_a.is_complex_type () - || arg_b.is_complex_type () - || arg_c.is_complex_type ()) - { - // Do everything in complex arithmetic; - - ComplexMatrix ca = arg_a.complex_matrix_value (); - - if (error_state) - return retval; - - ComplexMatrix cb = arg_b.complex_matrix_value (); - - if (error_state) - return retval; - - ComplexMatrix cc = arg_c.complex_matrix_value (); - - if (error_state) - return retval; - - retval = Sylvester (ca, cb, cc); - } - else - { - // Do everything in real arithmetic. - - Matrix ca = arg_a.matrix_value (); - - if (error_state) - return retval; - - Matrix cb = arg_b.matrix_value (); - - if (error_state) - return retval; - - Matrix cc = arg_c.matrix_value (); - - if (error_state) - return retval; - - retval = Sylvester (ca, cb, cc); - } - } - - return retval; -} - -/* -%!assert (syl ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12]), [-1/2, -2/3; -2/3, -1/2], sqrt (eps)) -%!assert (syl (single ([1, 2; 3, 4]), single ([5, 6; 7, 8]), single ([9, 10; 11, 12])), single ([-1/2, -2/3; -2/3, -1/2]), sqrt (eps ("single"))) - -%!error syl () -%!error syl (1, 2, 3, 4) -%!error <must be a square matrix> syl ([1, 2; 3, 4], [1, 2, 3; 4, 5, 6], [4, 3]) -*/
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libinterp/corefcn/sylvester.cc Sun Aug 31 21:05:38 2014 -0700 @@ -0,0 +1,230 @@ +/* + +Copyright (C) 1996-2013 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/>. + +*/ + +// Author: A. S. Hodel <scotte@eng.auburn.edu> + +#ifdef HAVE_CONFIG_H +#include <config.h> +#endif + +#include "defun.h" +#include "error.h" +#include "gripes.h" +#include "oct-obj.h" +#include "utils.h" + +DEFUN (sylvester, args, nargout, + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {@var{X} =} syl (@var{A}, @var{B}, @var{C})\n\ +Solve the Sylvester equation\n\ +@tex\n\ +$$\n\ + A X + X B = C\n\ +$$\n\ +@end tex\n\ +@ifnottex\n\ +\n\ +@example\n\ +A X + X B = C\n\ +@end example\n\ +\n\ +@end ifnottex\n\ +using standard @sc{lapack} subroutines.\n\ +\n\ +For example:\n\ +\n\ +@example\n\ +@group\n\ +sylvester ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12])\n\ + @result{} [ 0.50000, 0.66667; 0.66667, 0.50000 ]\n\ +@end group\n\ +@end example\n\ +@end deftypefn") +{ + octave_value retval; + + int nargin = args.length (); + + if (nargin != 3 || nargout > 1) + { + print_usage (); + return retval; + } + + octave_value arg_a = args(0); + octave_value arg_b = args(1); + octave_value arg_c = args(2); + + octave_idx_type a_nr = arg_a.rows (); + octave_idx_type a_nc = arg_a.columns (); + + octave_idx_type b_nr = arg_b.rows (); + octave_idx_type b_nc = arg_b.columns (); + + octave_idx_type c_nr = arg_c.rows (); + octave_idx_type c_nc = arg_c.columns (); + + int arg_a_is_empty = empty_arg ("sylvester", a_nr, a_nc); + int arg_b_is_empty = empty_arg ("sylvester", b_nr, b_nc); + int arg_c_is_empty = empty_arg ("sylvester", c_nr, c_nc); + + bool isfloat = arg_a.is_single_type () + || arg_b.is_single_type () + || arg_c.is_single_type (); + + if (arg_a_is_empty > 0 && arg_b_is_empty > 0 && arg_c_is_empty > 0) + if (isfloat) + return octave_value (FloatMatrix ()); + else + return octave_value (Matrix ()); + else if (arg_a_is_empty || arg_b_is_empty || arg_c_is_empty) + return retval; + + // Arguments are not empty, so check for correct dimensions. + + if (a_nr != a_nc) + { + gripe_square_matrix_required ("sylvester: input A"); + return retval; + } + else if (b_nr != b_nc) + { + gripe_square_matrix_required ("sylvester: input B"); + return retval; + } + else if (a_nr != c_nr || b_nr != c_nc) + { + gripe_nonconformant (); + return retval; + } + + if (isfloat) + { + if (arg_a.is_complex_type () + || arg_b.is_complex_type () + || arg_c.is_complex_type ()) + { + // Do everything in complex arithmetic; + + FloatComplexMatrix ca = arg_a.float_complex_matrix_value (); + + if (error_state) + return retval; + + FloatComplexMatrix cb = arg_b.float_complex_matrix_value (); + + if (error_state) + return retval; + + FloatComplexMatrix cc = arg_c.float_complex_matrix_value (); + + if (error_state) + return retval; + + retval = Sylvester (ca, cb, cc); + } + else + { + // Do everything in real arithmetic. + + FloatMatrix ca = arg_a.float_matrix_value (); + + if (error_state) + return retval; + + FloatMatrix cb = arg_b.float_matrix_value (); + + if (error_state) + return retval; + + FloatMatrix cc = arg_c.float_matrix_value (); + + if (error_state) + return retval; + + retval = Sylvester (ca, cb, cc); + } + } + else + { + if (arg_a.is_complex_type () + || arg_b.is_complex_type () + || arg_c.is_complex_type ()) + { + // Do everything in complex arithmetic; + + ComplexMatrix ca = arg_a.complex_matrix_value (); + + if (error_state) + return retval; + + ComplexMatrix cb = arg_b.complex_matrix_value (); + + if (error_state) + return retval; + + ComplexMatrix cc = arg_c.complex_matrix_value (); + + if (error_state) + return retval; + + retval = Sylvester (ca, cb, cc); + } + else + { + // Do everything in real arithmetic. + + Matrix ca = arg_a.matrix_value (); + + if (error_state) + return retval; + + Matrix cb = arg_b.matrix_value (); + + if (error_state) + return retval; + + Matrix cc = arg_c.matrix_value (); + + if (error_state) + return retval; + + retval = Sylvester (ca, cb, cc); + } + } + + return retval; +} + +/* +%!assert (sylvester ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12]), [1/2, 2/3; 2/3, 1/2], sqrt (eps)) +%!assert (sylvester (single ([1, 2; 3, 4]), single ([5, 6; 7, 8]), single ([9, 10; 11, 12])), single ([1/2, 2/3; 2/3, 1/2]), sqrt (eps ("single"))) + +%% Test input validation +%!error sylvester () +%!error sylvester (1) +%!error sylvester (1,2) +%!error sylvester (1, 2, 3, 4) +%!error <input A: .* must be a square matrix> sylvester (ones (2,3), ones (2,2), ones (2,2)) +%!error <input B: .* must be a square matrix> sylvester (ones (2,2), ones (2,3), ones (2,2)) +%!error <nonconformant matrices> sylvester (ones (2,2), ones (2,2), ones (3,3)) +*/
--- a/liboctave/array/CMatrix.cc Sun Aug 31 21:41:33 2014 +0200 +++ b/liboctave/array/CMatrix.cc Sun Aug 31 21:05:38 2014 -0700 @@ -3705,7 +3705,7 @@ // FIXME: check info? - retval = -ua * cx * ub.hermitian (); + retval = ua * cx * ub.hermitian (); return retval; }
--- a/liboctave/array/dMatrix.cc Sun Aug 31 21:41:33 2014 +0200 +++ b/liboctave/array/dMatrix.cc Sun Aug 31 21:05:38 2014 -0700 @@ -3135,7 +3135,7 @@ // FIXME: check info? - retval = -ua*cx*ub.transpose (); + retval = ua*cx*ub.transpose (); return retval; }
--- a/liboctave/array/fCMatrix.cc Sun Aug 31 21:41:33 2014 +0200 +++ b/liboctave/array/fCMatrix.cc Sun Aug 31 21:05:38 2014 -0700 @@ -3729,7 +3729,7 @@ // FIXME: check info? - retval = -ua * cx * ub.hermitian (); + retval = ua * cx * ub.hermitian (); return retval; }
--- a/liboctave/array/fMatrix.cc Sun Aug 31 21:41:33 2014 +0200 +++ b/liboctave/array/fMatrix.cc Sun Aug 31 21:05:38 2014 -0700 @@ -3157,7 +3157,7 @@ // FIXME: check info? - retval = -ua*cx*ub.transpose (); + retval = ua*cx*ub.transpose (); return retval; }
--- a/scripts/deprecated/module.mk Sun Aug 31 21:41:33 2014 +0200 +++ b/scripts/deprecated/module.mk Sun Aug 31 21:05:38 2014 -0700 @@ -5,7 +5,8 @@ deprecated/find_dir_in_path.m \ deprecated/isstr.m \ deprecated/nfields.m \ - deprecated/strmatch.m + deprecated/strmatch.m \ + deprecated/syl.m FCN_FILES += $(deprecated_FCN_FILES)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/deprecated/syl.m Sun Aug 31 21:05:38 2014 -0700 @@ -0,0 +1,66 @@ +## Copyright (C) 2014 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/>. + +## -*- texinfo -*- +## @deftypefn {Built-in Function} {@var{x} =} syl (@var{A}, @var{B}, @var{C}) +## +## @code{syl} is deprecated and will be removed in Octave version 4.6. +## Use @code{sylvester} for the equivalent functionality. +## +## Solve the Sylvester equation +## @tex +## $$ +## A X + X B + C = 0 +## $$ +## @end tex +## @ifnottex +## +## @example +## A X + X B + C = 0 +## @end example +## +## @end ifnottex +## using standard @sc{lapack} subroutines. For example: +## +## @example +## @group +## syl ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12]) +## @result{} [ -0.50000, -0.66667; -0.66667, -0.50000 ] +## @end group +## @end example +## @end deftypefn + +## Deprecated in version 4.2 + +function x = syl (A, B, C) + + persistent warned = false; + if (! warned) + warned = true; + warning ("Octave:deprecated-function", + "syl is obsolete and will be removed from a future version of Octave, please use sylvester instead"); + endif + + if (nargin != 3 || nargout > 1) + print_usage (); + endif + + x = -sylvester (A, B, C); + +endfunction +