annotate scripts/deprecated/splu.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents eb63fbe60fab
children be55736a0783
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8818
diff changeset
1 ## Copyright (C) 2008, 2009 David Bateman
7691
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}, @var{u}] =} splu (@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{u}, @var{P}] =} splu (@var{a})
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@var{a})
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@dots{}, @var{thres})
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}] =} splu (@dots{}, @var{Q})
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## This function has been deprecated. Use @code{lu} instead.
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @end deftypefn
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
27
8818
8dee145c777d fix "Deprecated in version" comments in deprecated fuctions
John W. Eaton <jwe@octave.org>
parents: 8664
diff changeset
28 ## Deprecated in version 3.2
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7691
diff changeset
29
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 function varargout = splu (varargin)
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 persistent warned = false;
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 if (! warned)
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 warned = true;
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 warning ("Octave:deprecated-function",
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
35 "splu is obsolete and will be removed from a future version of Octave; please use lu instead");
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 endif
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
37
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 for i = 2 : nargin
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 arg = varargin {i};
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 if (! isscalar (arg))
8664
e07e93c04080 style fixes
John W. Eaton <jwe@octave.org>
parents: 7704
diff changeset
41 error ("splu: Can no longer treat input column permutations");
7691
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 endif
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 endfor
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
44
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 varargout = cell (nargout, 1);
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 [ varargout{:} ] = lu (varargin{:});
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
47
4a01572f4268 Add versions of removed dispatched sparse function in the deprecated directory
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 endfunction