diff scripts/deprecated/sphcat.m @ 11390:7ca273af4309

Deprecate sphcat and spvcat functions.
author Rik <octave@nomad.inbox5.com>
date Sat, 18 Dec 2010 08:43:34 -0800
parents
children fd0a3ac60b0e
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/scripts/deprecated/sphcat.m
@@ -0,0 +1,35 @@
+## Copyright (C) 2004, 2005, 2006, 2007, 2009 David Bateman and Andy Adler
+##
+## 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 {Function File} {@var{y} =} sphcat (@var{a1}, @var{a2}, @dots{}, @var{aN})
+## Return the horizontal concatenation of sparse matrices.  This function
+## is obselete and @code{horzcat} should be used instead.
+## @seealso {horzcat, spvcat, vertcat, cat}
+## @end deftypefn
+
+function y = sphcat (varargin)
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "sphcat is obsolete and will be removed from a future version of Octave; please use horzcat instead");
+  endif
+
+  y = horzcat (varargin{:});
+endfunction