changeset 11390:7ca273af4309

Deprecate sphcat and spvcat functions.
author Rik <octave@nomad.inbox5.com>
date Sat, 18 Dec 2010 08:43:34 -0800
parents 934ed3e07542
children 98d523608f70
files ChangeLog NEWS scripts/ChangeLog scripts/deprecated/module.mk scripts/deprecated/sphcat.m scripts/deprecated/spvcat.m scripts/sparse/module.mk scripts/sparse/sphcat.m scripts/sparse/spvcat.m
diffstat 9 files changed, 93 insertions(+), 86 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Sat Dec 18 03:27:46 2010 -0500
+++ b/ChangeLog	Sat Dec 18 08:43:34 2010 -0800
@@ -1,3 +1,7 @@
+2010-12-18  Rik  <octave@nomad.inbox5.com>
+
+	* NEWS: Deprecate sphcat and spvcat functions.
+
 2010-12-17  Rik  <octave@nomad.inbox5.com>
 
 	* README.MacOS: New file documenting build instructions for Mac OSX.
--- a/NEWS	Sat Dec 18 03:27:46 2010 -0500
+++ b/NEWS	Sat Dec 18 08:43:34 2010 -0800
@@ -393,17 +393,17 @@
     be removed from Octave 3.6 (or whatever version is the second major
     release after 3.2):
 
-      create_set          spcholinv  spmax
-      dmult               spcumprod  spmin
-      iscommand           spcumsum   spprod
-      israwcommand        spdet      spqr
-      lchol               spdiag     spsum
-      loadimage           spfind     spsumsq
-      mark_as_command     spinv      str2mat
-      mark_as_rawcommand  spkron     unmark_command
-      spatan2             splchol    unmark_rawcommand
-      spchol              split
-      spchol2inv          splu
+      create_set          spcholinv    splu   
+      dmult               spcumprod    spmax
+      iscommand           spcumsum     spmin
+      israwcommand        spdet        spprod
+      lchol               spdiag       spqr
+      loadimage           spfind       spsum
+      mark_as_command     sphcat       spsumsq
+      mark_as_rawcommand  spinv        spvcat 
+      spatan2             spkron       str2mat
+      spchol              splchol      unmark_command
+      spchol2inv          split        unmark_rawcommand
 
     The following functions have been deprecated in Octave 3.4 and will
     be removed from Octave 3.8 (or whatever version is the second major
--- a/scripts/ChangeLog	Sat Dec 18 03:27:46 2010 -0500
+++ b/scripts/ChangeLog	Sat Dec 18 08:43:34 2010 -0800
@@ -1,3 +1,8 @@
+2010-10-28  Rik  <octave@nomad.inbox5.com>
+
+	* deprecated/module.mk, sparse/module.mk, deprecated/sphcat.m,
+	deprecated/spvcat.m: Deprecate sphcat and spvcat functions.
+
 2010-12-17  John W. Eaton  <jwe@octave.org>
 
 	* plot/comet3.m: New function.
--- a/scripts/deprecated/module.mk	Sat Dec 18 03:27:46 2010 -0500
+++ b/scripts/deprecated/module.mk	Sat Dec 18 08:43:34 2010 -0800
@@ -23,14 +23,15 @@
   deprecated/mark_as_rawcommand.m \
   deprecated/setstr.m \
   deprecated/spatan2.m \
-  deprecated/spchol.m \
   deprecated/spchol2inv.m \
   deprecated/spcholinv.m \
+  deprecated/spchol.m \
   deprecated/spcumprod.m \
   deprecated/spcumsum.m \
   deprecated/spdet.m \
   deprecated/spdiag.m \
   deprecated/spfind.m \
+  deprecated/sphcat.m \
   deprecated/spinv.m \
   deprecated/spkron.m \
   deprecated/splchol.m \
@@ -42,6 +43,7 @@
   deprecated/spqr.m \
   deprecated/spsum.m \
   deprecated/spsumsq.m \
+  deprecated/spvcat.m \
   deprecated/str2mat.m \
   deprecated/unmark_command.m \
   deprecated/unmark_rawcommand.m \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/sphcat.m	Sat Dec 18 08:43:34 2010 -0800
@@ -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
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/spvcat.m	Sat Dec 18 08:43:34 2010 -0800
@@ -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} =} spvcat (@var{a1}, @var{a2}, @dots{}, @var{aN})
+## Return the vertical concatenation of sparse matrices.  This function
+## is obselete and @code{vertcat} should be used instead.
+## @seealso{vertcat, sphcat, horzcat, cat}
+## @end deftypefn
+
+function y = spvcat (varargin)
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "spvcat is obsolete and will be removed from a future version of Octave; please use vertcat instead");
+  endif
+
+  y = vertcat (varargin{:});
+endfunction
--- a/scripts/sparse/module.mk	Sat Dec 18 03:27:46 2010 -0500
+++ b/scripts/sparse/module.mk	Sat Dec 18 08:43:34 2010 -0800
@@ -14,13 +14,11 @@
   sparse/spdiags.m \
   sparse/speye.m \
   sparse/spfun.m \
-  sparse/sphcat.m \
   sparse/spones.m \
   sparse/sprand.m \
   sparse/sprandn.m \
   sparse/sprandsym.m \
   sparse/spstats.m \
-  sparse/spvcat.m \
   sparse/spy.m \
   sparse/svds.m \
   sparse/treelayout.m \
--- a/scripts/sparse/sphcat.m	Sat Dec 18 03:27:46 2010 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-## 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.
-## @seealso {spvcat, vertcat, horzcat, cat}
-## @end deftypefn
-
-function y = sphcat (varargin)
-
-  persistent sphcat_warned = false;
-
-  if (! sphcat_warned)
-    sphcat_warned = true;
-    warning ("sphcat: This function is depreciated.  Use horzcat instead");
-  endif
-
-  y = horzcat (varargin{:});
-endfunction
--- a/scripts/sparse/spvcat.m	Sat Dec 18 03:27:46 2010 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-## 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} =} spvcat (@var{a1}, @var{a2}, @dots{}, @var{aN})
-## Return the vertical concatenation of sparse matrices.  This function
-## is obselete and @code{vertcat} should be used
-## @seealso{sphcat, vertcat, horzcat, cat}
-## @end deftypefn
-
-function y = spvcat (varargin)
-
-  persistent spvcat_warned = false;
-
-  if (! spvcat_warned)
-    spvcat_warned = true;
-    warning ("spvcat: This function is depreciated. Use vertcat instead");
-  endif
-
-  y = vertcat (varargin{:});
-endfunction