annotate scripts/miscellaneous/swapbytes.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 f6730533820e
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: 26600
diff changeset
1 ## Copyright (C) 2007-2019 The Octave Project Developers
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26600
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26600
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: 26600
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: 26600
diff changeset
5 ##
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
6 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
7 ## This file is part of Octave.
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## 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
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: 23220
diff changeset
11 ## 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
12 ## (at your option) any later version.
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
13 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
14 ## 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
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
18 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
19 ## 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
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: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
22
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20164
diff changeset
24 ## @deftypefn {} {} swapbytes (@var{x})
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ## Swap the byte order on values, converting from little endian to big endian
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
26 ## and vice versa.
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ##
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 ## For example:
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
29 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
30 ## @example
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
31 ## @group
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
32 ## swapbytes (uint16 (1:4))
26600
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
33 ## @result{} 256 512 768 1024
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
34 ## @end group
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
35 ## @end example
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
36 ##
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
37 ## @seealso{typecast, cast}
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
38 ## @end deftypefn
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
39
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
40 function y = swapbytes (x)
12847
619c1895e3e0 codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
41
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
42 if (nargin != 1)
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
43 print_usage ();
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
44 endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
45
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
46 cls = class (x);
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
47 if (strcmp (cls, "int8") || strcmp (cls, "uint8") || isempty (x))
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
48 y = x;
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
49 else
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
50 if (strcmp (cls, "int16") || strcmp (cls, "uint16"))
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
51 nb = 2;
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
52 elseif (strcmp (cls, "single")
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
53 || strcmp (cls, "int32") || strcmp (cls, "uint32"))
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
54 nb = 4;
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
55 elseif (strcmp (cls, "double")
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
56 || strcmp (cls, "int64") || strcmp (cls, "uint64"))
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
57 nb = 8;
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
58 else
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
59 error ("swapbytes: invalid object of class '%s'", cls);
6869
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 y = reshape (typecast (reshape (typecast (x(:), "uint8"), nb, numel (x))
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
62 ([nb : -1 : 1], :) (:), cls), size (x));
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
63 endif
12847
619c1895e3e0 codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
64
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
65 endfunction
12847
619c1895e3e0 codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
66
619c1895e3e0 codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
67
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
68 %!assert (swapbytes (uint16 (1:4)), uint16 ([256 512 768 1024]))
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
69 %!test
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
70 %! assert (swapbytes (swapbytes (pi)), pi);
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
71 %! assert (swapbytes (swapbytes (single (pi))), single (pi));
12847
619c1895e3e0 codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
72
19209
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
73 ## Test input validation
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
74 %!error swapbytes ()
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
75 %!error swapbytes (1, 2)
827ac8b5ae07 swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents: 17744
diff changeset
76 %!error <invalid object of class 'cell'> swapbytes ({1})