annotate scripts/deprecated/lchol.m @ 8818:8dee145c777d

fix "Deprecated in version" comments in deprecated fuctions
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 16:26:27 -0500
parents 9a6012d7cbb7
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## Copyright (C) 2008 David Bateman
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Loadable Function} {@var{l} =} lchol (@var{a})
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @deftypefnx {Loadable Function} {[@var{l}, @var{p}] =} lchol (@var{a})
7710
9a6012d7cbb7 Minor texinfo errors
David Bateman <dbateman@free.fr>
parents: 7704
diff changeset
22 ## This function has been deprecated. Use @code{chol (@dots{},'lower')}
9a6012d7cbb7 Minor texinfo errors
David Bateman <dbateman@free.fr>
parents: 7704
diff changeset
23 ## instead.
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @end deftypefn
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
25
8818
8dee145c777d fix "Deprecated in version" comments in deprecated fuctions
John W. Eaton <jwe@octave.org>
parents: 7710
diff changeset
26 ## Deprecated in version 3.2
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7691
diff changeset
27
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 function varargout = lchol (varargin)
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 persistent warned = false;
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 if (! warned)
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 warned = true;
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 warning ("Octave:deprecated-function",
7704
1cdb42b372e8 don't embed newline in warning messages in deprecated functions
John W. Eaton <jwe@octave.org>
parents: 7693
diff changeset
33 "spfind is obsolete and will be removed from a future version of Octave; please use find instead");
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 endif
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
35
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 varargout = cell (nargout, 1);
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 [ varargout{:} ] = chol (varargin{:}, "lower");
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
38
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 endfunction