comparison scripts/deprecated/gmap40.m @ 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 scripts/image/gmap40.m@7503499a252b
children
comparison
equal deleted inserted replaced
20158:7503499a252b 20159:597991b19e40
1 ## Copyright (C) 2007-2015 David Bateman
2 ##
3 ## This file is part of Octave.
4 ##
5 ## Octave is free software; you can redistribute it and/or modify it
6 ## under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
9 ##
10 ## Octave is distributed in the hope that it will be useful, but
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## General Public License for more details.
14 ##
15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{map} =} gmap40 ()
21 ## @deftypefnx {Function File} {@var{map} =} gmap40 (@var{n})
22 ##
23 ## @code{gmap40} is deprecated and will be removed in Octave version 4.4.
24 ##
25 ## Create color colormap. The colormap consists of red, green, blue, yellow,
26 ## magenta and cyan.
27 ##
28 ## This colormap is specifically designed for users of gnuplot 4.0 where these
29 ## 6 colors are the allowable ones for patch objects.
30 ##
31 ## The argument @var{n} must be a scalar.
32 ## If unspecified, a length of 6 is assumed. Larger values of @var{n} result
33 ## in a repetition of the above colors.
34 ## @seealso{colormap}
35 ## @end deftypefn
36
37 ## PKG_ADD: colormap ("register", "gmap40");
38 ## PKG_DEL: colormap ("unregister", "gmap40");
39
40 ## Deprecated in 4.0
41
42 function map = gmap40 (n = rows (colormap ()))
43
44 persistent warned = false;
45 if (! warned)
46 warned = true;
47 warning ("Octave:deprecated-function",
48 "gmap40 is obsolete and will be removed from a future version of Octave");
49 endif
50
51 if (nargin > 1)
52 print_usage ();
53 elseif (! isscalar (n))
54 error ("gmap40: N must be a scalar");
55 endif
56
57 if (n > 0)
58 C = [1, 0, 0; 0, 1, 0; 0, 0, 1; 1, 1, 0; 1, 0, 1; 0, 1, 1];
59 map = C(rem (0:(n-1), 6) + 1, :);
60 else
61 map = zeros (0, 3);
62 endif
63
64 endfunction
65
66
67 %!demo
68 %! ## Show the 'gmap40' colormap as an image
69 %! image (1:6, linspace (0, 1, 6), repmat ((1:6)', 1, 6));
70 %! axis ([1, 6, 0, 1], "ticy", "xy");
71 %! colormap (gmap40 (6));
72