annotate scripts/strings/isstring.m @ 27918:b442ec6dda5c

use centralized file for copyright info for individual contributors * COPYRIGHT.md: New file. * In most other files, use "Copyright (C) YYYY-YYYY The Octave Project Developers" instead of tracking individual names in separate source files. The motivation is to reduce the effort required to update the notices each year. Until now, the Octave source files contained copyright notices that list individual contributors. I adopted these file-scope copyright notices because that is what everyone was doing 30 years ago in the days before distributed version control systems. But now, with many contributors and modern version control systems, having these file-scope copyright notices causes trouble when we update copyright years or refactor code. Over time, the file-scope copyright notices may become outdated as new contributions are made or code is moved from one file to another. Sometimes people contribute significant patches but do not add a line claiming copyright. Other times, people add a copyright notice for their contribution but then a later refactoring moves part or all of their contribution to another file and the notice is not moved with the code. As a practical matter, moving such notices is difficult -- determining what parts are due to a particular contributor requires a time-consuming search through the project history. Even managing the yearly update of copyright years is problematic. We have some contributors who are no longer living. Should we update the copyright dates for their contributions when we release new versions? Probably not, but we do still want to claim copyright for the project as a whole. To minimize the difficulty of maintaining the copyright notices, I would like to change Octave's sources to use what is described here: https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html in the section "Maintaining centralized copyright notices": The centralized notice approach consolidates all copyright notices in a single location, usually a top-level file. This file should contain all of the copyright notices provided project contributors, unless the contribution was clearly insignificant. It may also credit -- without a copyright notice -- anyone who helped with the project but did not contribute code or other copyrighted material. This approach captures less information about contributions within individual files, recognizing that the DVCS is better equipped to record those details. As we mentioned before, it does have one disadvantage as compared to the file-scope approach: if a single file is separated from the distribution, the recipient won't see the contributors' copyright notices. But this can be easily remedied by including a single copyright notice in each file's header, pointing to the top-level file: Copyright YYYY-YYYY The Octave Project Developers See the COPYRIGHT file at the top-level directory of this distribution or at https://octave.org/COPYRIGHT.html. followed by the usual GPL copyright statement. For more background, see the discussion here: https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html Most files in the following directories have been skipped intentinally in this changeset: doc libgui/qterminal liboctave/external m4
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 15:38:17 -0500
parents 00f796120a6d
children 1891570abac8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1 ## Copyright (C) 2017-2019 The Octave Project Developers
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
6 ##
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
7 ## This file is part of Octave.
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24474
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
10 ## 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: 24474
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
12 ## (at your option) any later version.
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
13 ##
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
17 ## GNU General Public License for more details.
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
18 ##
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
20 ## 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: 24474
diff changeset
21 ## <https://www.gnu.org/licenses/>.
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
22
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
23 ## -*- texinfo -*-
25039
40a65b30fadf maint: Match variable names in documentation to those in function prototype.
Rik <rik@octave.org>
parents: 24985
diff changeset
24 ## @deftypefn {} {} isstring (@var{s})
40a65b30fadf maint: Match variable names in documentation to those in function prototype.
Rik <rik@octave.org>
parents: 24985
diff changeset
25 ## Return true if @var{s} is a string array.
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
26 ##
24985
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
27 ## A string array is a data type that stores strings (row vectors of
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
28 ## characters) at each element in the array. It is distinct from character
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
29 ## arrays which are N-dimensional arrays where each element is a single 1x1
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
30 ## character. It is also distinct from cell arrays of strings which store
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
31 ## strings at each element, but use cell indexing @samp{@{@}} to access
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
32 ## elements rather than string arrays which use ordinary array indexing
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
33 ## @samp{()}.
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
34 ##
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
35 ## Programming Note: Octave does not yet implement string arrays so this
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
36 ## function will always return false.
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
37 ## @seealso{ischar, iscellstr, isfloat, isinteger, islogical, isnumeric, isa}
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
38 ## @end deftypefn
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
39
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
40 function retval = isstring (s)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
41
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
42 if (nargin != 1)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
43 print_usage ();
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
44 endif
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
45
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
46 retval = false;
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
47
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
48 endfunction
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
49
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
50
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
51 %!assert (isstring ([]), false)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
52 %!assert (isstring (1), false)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
53 %!assert (isstring ('a'), false)
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
54 ## FIXME: when string arrays are implemented, this should return true.
24474
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
55 #%!assert (isstring ("b"), true)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
56 %!assert (isstring ({'a'}), false)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
57 %!assert (isstring ({"b"}), false)
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
58
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
59 %!error isstring ()
0b65949870e3 isstring.m: Add new function for identifying string arrays.
Rik <rik@octave.org>
parents:
diff changeset
60 %!error isstring ("a", "b")