octave-antonio: scripts/deprecated/gmap40.m annotate

annotate 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

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19613 diff changeset	1 ## Copyright (C) 2007-2015 David Bateman
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	2 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	4 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	8 ## your option) any later version.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	9 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	14 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	18
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	20 ## @deftypefn {Function File} {@var{map} =} gmap40 ()
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	21 ## @deftypefnx {Function File} {@var{map} =} gmap40 (@var{n})
20159 597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	22 ##
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	23 ## @code{gmap40} is deprecated and will be removed in Octave version 4.4.
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	24 ##
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	25 ## Create color colormap. The colormap consists of red, green, blue, yellow,
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## magenta and cyan.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## This colormap is specifically designed for users of gnuplot 4.0 where these
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## 6 colors are the allowable ones for patch objects.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	31 ## The argument @var{n} must be a scalar.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	32 ## If unspecified, a length of 6 is assumed. Larger values of @var{n} result
1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	33 ## in a repetition of the above colors.
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	34 ## @seealso{colormap}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	35 ## @end deftypefn
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	36
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	37 ## PKG_ADD: colormap ("register", "gmap40");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	38 ## PKG_DEL: colormap ("unregister", "gmap40");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	39
20159 597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	40 ## Deprecated in 4.0
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	41
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 19612 diff changeset	42 function map = gmap40 (n = rows (colormap ()))
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	43
20159 597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	44 persistent warned = false;
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	45 if (! warned)
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	46 warned = true;
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	47 warning ("Octave:deprecated-function",
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	48 "gmap40 is obsolete and will be removed from a future version of Octave");
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	49 endif
597991b19e40 gmap40.m: Deprecate function. Rik <rik@octave.org> parents: 20158 diff changeset	50
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 19612 diff changeset	51 if (nargin > 1)
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	52 print_usage ();
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 19612 diff changeset	53 elseif (! isscalar (n))
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 19612 diff changeset	54 error ("gmap40: N must be a scalar");
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	55 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	56
19612 68cc16969f78 gmap40.m: fix for corner case when N is 1 Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	57 if (n > 0)
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	58 C = [1, 0, 0; 0, 1, 0; 0, 0, 1; 1, 1, 0; 1, 0, 1; 0, 1, 1];
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	59 map = C(rem (0:(n-1), 6) + 1, :);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	60 else
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	61 map = zeros (0, 3);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	62 endif
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	63
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: diff changeset	64 endfunction
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 9245 diff changeset	65
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	66
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 9245 diff changeset	67 %!demo
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 9245 diff changeset	68 %! ## Show the 'gmap40' colormap as an image
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %! image (1:6, linspace (0, 1, 6), repmat ((1:6)', 1, 6));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %! axis ([1, 6, 0, 1], "ticy", "xy");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %! colormap (gmap40 (6));
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 9245 diff changeset	72

Mercurial > octave-antonio

annotate scripts/deprecated/gmap40.m @ 20159:597991b19e40 stable