Mercurial > octave
annotate scripts/general/postpad.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 |
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) 1994-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 ## |
2313 | 6 ## |
7 ## This file is part of Octave. | |
8 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23573
diff
changeset
|
9 ## Octave is free software: you can redistribute it and/or modify it |
2313 | 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:
23573
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:
22489
diff
changeset
|
12 ## (at your option) any later version. |
2313 | 13 ## |
14 ## Octave is distributed in the hope that it will be useful, but | |
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22489
diff
changeset
|
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22489
diff
changeset
|
17 ## GNU General Public License for more details. |
2313 | 18 ## |
19 ## You should have received a copy of the GNU General Public License | |
7016 | 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:
23573
diff
changeset
|
21 ## <https://www.gnu.org/licenses/>. |
2303 | 22 |
3458 | 23 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
24 ## @deftypefn {} {} postpad (@var{x}, @var{l}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
25 ## @deftypefnx {} {} postpad (@var{x}, @var{l}, @var{c}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
26 ## @deftypefnx {} {} postpad (@var{x}, @var{l}, @var{c}, @var{dim}) |
12639
4d777e05d47c
doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents:
11539
diff
changeset
|
27 ## Append the scalar value @var{c} to the vector @var{x} until it is of length |
4d777e05d47c
doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents:
11539
diff
changeset
|
28 ## @var{l}. If @var{c} is not given, a value of 0 is used. |
11539
6bac61388876
Add undocumented postpad function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
29 ## |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
30 ## If @code{length (@var{x}) > @var{l}}, elements from the end of @var{x} are |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
31 ## removed until a vector of length @var{l} is obtained. |
11539
6bac61388876
Add undocumented postpad function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
32 ## |
6bac61388876
Add undocumented postpad function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
33 ## If @var{x} is a matrix, elements are appended or removed from each row. |
6bac61388876
Add undocumented postpad function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
34 ## |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
35 ## If the optional argument @var{dim} is given, operate along this dimension. |
18513
d28c4c4547ef
Allow postpad and prepad to expand singleton dimensions (bug #41633)
Mike Miller <mtmiller@ieee.org>
parents:
17744
diff
changeset
|
36 ## |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
37 ## If @var{dim} is larger than the dimensions of @var{x}, the result will have |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
38 ## @var{dim} dimensions. |
11539
6bac61388876
Add undocumented postpad function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
39 ## @seealso{prepad, cat, resize} |
3458 | 40 ## @end deftypefn |
3428 | 41 |
42 ## Author: Tony Richardson <arichard@stark.cc.oh.us> | |
43 ## Created: June 1994 | |
904 | 44 |
4862 | 45 function y = postpad (x, l, c, dim) |
46 | |
47 if (nargin < 2 || nargin > 4) | |
6046 | 48 print_usage (); |
4862 | 49 endif |
50 | |
51 if (nargin < 3 || isempty (c)) | |
52 c = 0; | |
53 else | |
54 if (! isscalar (c)) | |
55 error ("postpad: third argument must be empty or a scalar"); | |
56 endif | |
57 endif | |
561 | 58 |
4862 | 59 nd = ndims (x); |
60 sz = size (x); | |
61 if (nargin < 4) | |
12674
9493880928c8
Use common idiom in m-files for finding first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
62 ## Find the first non-singleton dimension. |
9493880928c8
Use common idiom in m-files for finding first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
12639
diff
changeset
|
63 (dim = find (sz > 1, 1)) || (dim = 1); |
4862 | 64 else |
18513
d28c4c4547ef
Allow postpad and prepad to expand singleton dimensions (bug #41633)
Mike Miller <mtmiller@ieee.org>
parents:
17744
diff
changeset
|
65 if (!(isscalar (dim) && dim == fix (dim) && dim >= 1)) |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10635
diff
changeset
|
66 error ("postpad: DIM must be an integer and a valid dimension"); |
4862 | 67 endif |
561 | 68 endif |
69 | |
5459 | 70 if (! isscalar (l) || l < 0) |
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
71 error ("postpad: second argument must be a positive scaler"); |
561 | 72 endif |
73 | |
5459 | 74 if (dim > nd) |
75 sz(nd+1:dim) = 1; | |
76 endif | |
77 | |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
78 d = sz(dim); |
5459 | 79 |
22210
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
80 if (d == l) |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
81 ## This optimization makes sense because the function is used to match |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
82 ## the length between two vectors not knowing a priori is larger, and |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
83 ## allow for: |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
84 ## ml = max (numel (v1), numel (v2)); |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
85 ## v1 = postpad (v1, ml); |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
86 ## v2 = postpad (v2, ml); |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
87 y = x; |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
88 elseif (d >= l) |
12676
2783fa95cab7
Use common code idiom for creating cell array for indexing ND-arrays
Rik <octave@nomad.inbox5.com>
parents:
12674
diff
changeset
|
89 idx = repmat ({':'}, nd, 1); |
7208 | 90 idx{dim} = 1:l; |
91 y = x(idx{:}); | |
561 | 92 else |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
93 sz(dim) = l - d; |
16304
c8e1b0213e34
pkg.m: Fix str-to-num warnings (bug #37785)
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
94 y = cat (dim, x, c(ones (sz))); |
561 | 95 endif |
96 | |
97 endfunction | |
12795
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12676
diff
changeset
|
98 |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12676
diff
changeset
|
99 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
100 %!assert (postpad ([1,2], 4), [1,2,0,0]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
101 %!assert (postpad ([1;2], 4), [1;2;0;0]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
102 %!assert (postpad ([1,2], 4, 2), [1,2,2,2]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
103 %!assert (postpad ([1;2], 4, 2), [1;2;2;2]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
104 %!assert (postpad ([1,2], 2, 2, 1), [1,2;2,2]) |
18513
d28c4c4547ef
Allow postpad and prepad to expand singleton dimensions (bug #41633)
Mike Miller <mtmiller@ieee.org>
parents:
17744
diff
changeset
|
105 %!assert (postpad ([1;2], 2, 2, 3), reshape ([1;2;2;2], 2, 1, 2)) |
d28c4c4547ef
Allow postpad and prepad to expand singleton dimensions (bug #41633)
Mike Miller <mtmiller@ieee.org>
parents:
17744
diff
changeset
|
106 %!assert (postpad ([1,2], 2, 2, 3), reshape ([1,2,2,2], 1, 2, 2)) |
12795
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12676
diff
changeset
|
107 |
22210
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
108 %!assert (postpad ([1 2], 2), [1 2]) |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
109 %!assert (postpad ([1; 2], 2), [1; 2]) |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
110 %!assert (postpad ([1; 2], 2, 3, 2), [1 3; 2 3]) |
30eefd9ddb48
prepad, postpad: do nothing wen input is already of the right size.
Carnë Draug <carandraug@octave.org>
parents:
20852
diff
changeset
|
111 |
22489
93ea313301f9
test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
112 %! ## Test with string concatenation |
23573
1b4f4ec53b4a
use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents:
23572
diff
changeset
|
113 %!assert <*44162> (postpad ("Octave", 16, "x"), "Octavexxxxxxxxxx") |
19654
107ec5195a47
prepad.m: Fix str-to-num warnings (bug #44162)
Mike Miller <mtmiller@ieee.org>
parents:
18513
diff
changeset
|
114 %!assert (postpad ("Octave", 4), "Octa") |
107ec5195a47
prepad.m: Fix str-to-num warnings (bug #44162)
Mike Miller <mtmiller@ieee.org>
parents:
18513
diff
changeset
|
115 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
116 %!error postpad () |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
117 %!error postpad (1) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
118 %!error postpad (1,2,3,4,5) |