Mercurial > hg > octave-nkf
diff scripts/deprecated/spchol.m @ 7691:4a01572f4268
Add versions of removed dispatched sparse function in the deprecated directory
author | David Bateman <dbateman@free.fr> |
---|---|
date | Thu, 03 Apr 2008 17:10:15 -0400 |
parents | |
children | 8e5371d47da6 |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/scripts/deprecated/spchol.m @@ -0,0 +1,38 @@ +## Copyright (C) 2008 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/>. + +## -*- texinfo -*- +## @deftypefn {Loadable Function} {@var{r} =} spchol (@var{a}) +## @deftypefnx {Loadable Function} {[@var{r}, @var{p}] =} spchol (@var{a}) +## @deftypefnx {Loadable Function} {[@var{r}, @var{p}, @var{q}] =} spchol (@var{a}) +## This function has been deprecated. Use @code{chol} instead. +## @end deftypefn + +function varargout = spchol (varargin) + persistent warned = false; + if (! warned) + warned = true; + warning ("Octave:deprecated-function", + ["spchol is obsolete and will be removed from a future\n", + "version of Octave, please use chol instead"]); + endif + + varargout = cell (nargout, 1); + [ varargout{:} ] = chol (varargin{:}); + +endfunction