view scripts/deprecated/splu.m @ 12728:a17269b1148f stable

maint: undo unintended change removing deprecated functions
author John W. Eaton <jwe@octave.org>
date Thu, 09 Jun 2011 13:35:10 -0400
parents
children
line wrap: on
line source

## Copyright (C) 2008-2011 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{l}, @var{u}] =} splu (@var{a})
## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}] =} splu (@var{a})
## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@var{a})
## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@dots{}, @var{thres})
## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}] =} splu (@dots{}, @var{Q})
## This function has been deprecated.  Use @code{lu} instead.
## @end deftypefn

## Deprecated in version 3.2

function varargout = splu (varargin)
  persistent warned = false;
  if (! warned)
    warned = true;
    warning ("Octave:deprecated-function",
             "splu is obsolete and will be removed from a future version of Octave; please use lu instead");
  endif

  for i = 2 : nargin
    arg = varargin {i};
    if (! isscalar (arg))
      error ("splu: Can no longer treat input column permutations");
    endif
  endfor

  varargout = cell (nargout, 1);
  [ varargout{:} ] = lu (varargin{:});

endfunction