octave: scripts/general/celldisp.m annotate

annotate scripts/general/celldisp.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	7854d5752dd2
children	5d3faba0342e

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	3 ## Copyright (C) 2007-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	7 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	8 ## This file is part of Octave.
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	14 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	19 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6869 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	25
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	27 ## @deftypefn {} {} celldisp (@var{c})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	28 ## @deftypefnx {} {} celldisp (@var{c}, @var{name})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	29 ## Recursively display the contents of a cell array.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	30 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	31 ## By default the values are displayed with the name of the variable @var{c}.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	32 ## However, this name can be replaced with the variable @var{name}. For
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	33 ## example:
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	34 ##
10122 9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	35 ## @example
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	36 ## @group
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	37 ## c = @{1, 2, @{31, 32@}@};
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38 ## celldisp (c, "b")
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	39 ## @result{}
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	40 ## b@{1@} =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	41 ## 1
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	42 ## b@{2@} =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	43 ## 2
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	44 ## b@{3@}@{1@} =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	45 ## 31
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	46 ## b@{3@}@{2@} =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	47 ## 32
10122 9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	48 ## @end group
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	49 ## @end example
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	50 ##
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	51 ## @seealso{disp}
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	52 ## @end deftypefn
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	53
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	54 ## This is ugly, but seems to be what matlab does..
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	55
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	56 function celldisp (c, name)
16191 049c769b11c5 celldisp.m: Tweak docstring and error message. Rik <rik@octave.org> parents: 14868 diff changeset	57
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	58 if (nargin < 1)
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	59 print_usage ();
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	60 endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	61
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	62 if (! iscell (c))
16191 049c769b11c5 celldisp.m: Tweak docstring and error message. Rik <rik@octave.org> parents: 14868 diff changeset	63 error ("celldisp: C must be a cell array");
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	64 endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	65
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	66 if (nargin == 1)
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	67 name = inputname (1);
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	68 endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	69
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	70 for i = 1: numel (c)
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	71 if (iscell (c{i}))
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	72 celldisp (c{i}, sprintf ("%s{%s}", name, indices (size (c), i)));
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	73 else
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	74 disp (sprintf ("%s{%s} = \n", name, indices (size (c), i)));
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	75 disp (c{i});
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	76 disp ("");
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	77 endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	78 endfor
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 20852 diff changeset	79
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	80 endfunction
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	81
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	82 function s = indices (dv, i)
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 20852 diff changeset	83
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	84 if (sum (dv != 1) > 1)
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	85 c = cell (size (dv));
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	86 [c{:}] = ind2sub (dv, i);
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	87 s = sprintf ("%i,", c{:});
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	88 s(end) = [];
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	89 else
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	90 s = sprintf ("%i", i);
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	91 endif
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 20852 diff changeset	92
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	93 endfunction
10122 9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	94
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95
10122 9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	96 %!demo
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9245 diff changeset	97 %! c = {1, 2, {31, 32}};
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %! celldisp (c, "b")
13046 b2aca5ac54a2 codesprint: argument checking tests for celldisp John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	99
16191 049c769b11c5 celldisp.m: Tweak docstring and error message. Rik <rik@octave.org> parents: 14868 diff changeset	100 ## Test input validation
28896 90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 28789 diff changeset	101 %!error <Invalid call> celldisp ()
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14335 diff changeset	102 %!error celldisp ({}, "name", 1)
16191 049c769b11c5 celldisp.m: Tweak docstring and error message. Rik <rik@octave.org> parents: 14868 diff changeset	103 %!error <C must be a cell array> celldisp (1)

Mercurial > octave

annotate scripts/general/celldisp.m @ 30564:796f54d4ddbf stable