changeset 20159:597991b19e40 stable

gmap40.m: Deprecate function. Function is specifically for gnuplot-4.0 support, but Octave already requires version 4.2.5. * scripts/deprecated/gmap40.m: Moved from image/ directory. Add warning when run. Add deprecation notice to docstring. * scripts/deprecated/module.mk: Add gmap40.m to build system. * scripts/image/module.mk: Remove gmap40.m from image dir build system. * scripts/image/gmap40.m: Moved to deprecated/ directory.
author Rik <rik@octave.org>
date Sun, 03 May 2015 12:58:42 -0700
parents 7503499a252b
children 03b9d17a2d95
files scripts/deprecated/gmap40.m scripts/deprecated/module.mk scripts/image/gmap40.m scripts/image/module.mk
diffstat 4 files changed, 73 insertions(+), 61 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/gmap40.m	Sun May 03 12:58:42 2015 -0700
@@ -0,0 +1,72 @@
+## Copyright (C) 2007-2015 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  {Function File} {@var{map} =} gmap40 ()
+## @deftypefnx {Function File} {@var{map} =} gmap40 (@var{n})
+##
+## @code{gmap40} is deprecated and will be removed in Octave version 4.4.
+##
+## Create color colormap.  The colormap consists of red, green, blue, yellow,
+## magenta and cyan.
+##
+## This colormap is specifically designed for users of gnuplot 4.0 where these
+## 6 colors are the allowable ones for patch objects.
+##
+## The argument @var{n} must be a scalar.
+## If unspecified, a length of 6 is assumed.  Larger values of @var{n} result
+## in a repetition of the above colors.
+## @seealso{colormap}
+## @end deftypefn
+
+## PKG_ADD: colormap ("register", "gmap40");
+## PKG_DEL: colormap ("unregister", "gmap40");
+
+## Deprecated in 4.0
+
+function map = gmap40 (n = rows (colormap ()))
+
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "gmap40 is obsolete and will be removed from a future version of Octave");
+  endif
+
+  if (nargin > 1)
+    print_usage ();
+  elseif (! isscalar (n))
+    error ("gmap40: N must be a scalar");
+  endif
+
+  if (n > 0)
+    C = [1, 0, 0; 0, 1, 0; 0, 0, 1; 1, 1, 0; 1, 0, 1; 0, 1, 1];
+    map = C(rem (0:(n-1), 6) + 1, :);
+  else
+    map = zeros (0, 3);
+  endif
+
+endfunction
+
+
+%!demo
+%! ## Show the 'gmap40' colormap as an image
+%! image (1:6, linspace (0, 1, 6), repmat ((1:6)', 1, 6));
+%! axis ([1, 6, 0, 1], "ticy", "xy");
+%! colormap (gmap40 (6));
+
--- a/scripts/deprecated/module.mk	Sun May 03 09:36:20 2015 -0700
+++ b/scripts/deprecated/module.mk	Sun May 03 12:58:42 2015 -0700
@@ -10,6 +10,7 @@
   deprecated/fmod.m \
   deprecated/fnmatch.m \
   deprecated/gen_doc_cache.m \
+  deprecated/gmap40.m \
   deprecated/interp1q.m \
   deprecated/isequalwithequalnans.m \
   deprecated/isstr.m \
--- a/scripts/image/gmap40.m	Sun May 03 09:36:20 2015 -0700
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,60 +0,0 @@
-## Copyright (C) 2007-2015 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  {Function File} {@var{map} =} gmap40 ()
-## @deftypefnx {Function File} {@var{map} =} gmap40 (@var{n})
-## Create color colormap.  The colormap consists of red, green, blue, yellow,
-## magenta and cyan.
-##
-## This colormap is specifically designed for users of gnuplot 4.0 where these
-## 6 colors are the allowable ones for patch objects.
-##
-## The argument @var{n} must be a scalar.
-## If unspecified, a length of 6 is assumed.  Larger values of @var{n} result
-## in a repetition of the above colors.
-## @seealso{colormap}
-## @end deftypefn
-
-## PKG_ADD: colormap ("register", "gmap40");
-## PKG_DEL: colormap ("unregister", "gmap40");
-
-function map = gmap40 (n = rows (colormap ()))
-
-  if (nargin > 1)
-    print_usage ();
-  elseif (! isscalar (n))
-    error ("gmap40: N must be a scalar");
-  endif
-
-  if (n > 0)
-    C = [1, 0, 0; 0, 1, 0; 0, 0, 1; 1, 1, 0; 1, 0, 1; 0, 1, 1];
-    map = C(rem (0:(n-1), 6) + 1, :);
-  else
-    map = zeros (0, 3);
-  endif
-
-endfunction
-
-
-%!demo
-%! ## Show the 'gmap40' colormap as an image
-%! image (1:6, linspace (0, 1, 6), repmat ((1:6)', 1, 6));
-%! axis ([1, 6, 0, 1], "ticy", "xy");
-%! colormap (gmap40 (6));
-
--- a/scripts/image/module.mk	Sun May 03 09:36:20 2015 -0700
+++ b/scripts/image/module.mk	Sun May 03 12:58:42 2015 -0700
@@ -21,7 +21,6 @@
   image/copper.m \
   image/cubehelix.m \
   image/flag.m \
-  image/gmap40.m \
   image/gray.m \
   image/gray2ind.m \
   image/hot.m \