Mercurial > octave
annotate scripts/plot/draw/private/__pie__.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) 2007-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 ## |
11330 | 6 ## |
7 ## This file is part of Octave. | |
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 |
11330 | 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. |
11330 | 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:
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. |
11330 | 18 ## |
19 ## You should have received a copy of the GNU General Public License | |
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/>. |
11330 | 22 |
23 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
24 ## @deftypefn {} {@var{hlist} =} __pie__ (caller, @dots{}) |
11330 | 25 ## Undocumented internal function. |
26 ## @end deftypefn | |
27 | |
28 function hlist = __pie__ (caller, varargin) | |
29 | |
30 h = varargin{1}; | |
31 x = abs (varargin{2}); | |
32 iarg = 3; | |
33 | |
34 if (! isvector (x)) | |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
35 error ("%s: X must be a vector", caller); |
11330 | 36 endif |
37 | |
38 len = length (x); | |
39 | |
40 have_explode = false; | |
41 have_labels = false; | |
42 | |
43 while (iarg <= nargin - 1) | |
44 arg = varargin{iarg++}; | |
45 if (iscell (arg)) | |
46 labels = arg; | |
47 have_labels = true; | |
48 if (numel (x) != numel (labels)) | |
11338
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
49 error ("%s: mismatch in number of labels and data", caller); |
11330 | 50 endif |
11338
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
51 elseif (isnumeric (arg) || islogical (arg)) |
11330 | 52 explode = arg; |
53 have_explode = true; | |
54 if (! size_equal (x, explode)) | |
11338
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
55 error ("%s: mismatch in number of elements in explode and data", |
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
56 caller); |
11330 | 57 endif |
11338
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
58 else |
892ef3688ccf
__pie__.m: improve error messages
John W. Eaton <jwe@octave.org>
parents:
11332
diff
changeset
|
59 error ("%s: %s is invalid as an optional argument", caller, class (arg)); |
11330 | 60 endif |
61 endwhile | |
62 | |
63 if (! have_explode) | |
64 explode = zeros (size (x)); | |
65 endif | |
66 | |
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
67 normalize = true; |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
68 if (sum (x(:)) < 1) |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
69 normalize = false; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
70 endif |
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
71 |
11330 | 72 if (! have_labels) |
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
73 if (normalize) |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
74 xp = round (100 * x ./ sum (x)); |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
75 else |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
76 xp = round (100 * x); |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
77 endif |
11330 | 78 for i = 1:len |
79 labels{i} = sprintf ("%d%%", xp(i)); | |
80 endfor | |
81 endif | |
82 | |
83 hlist = []; | |
84 refinement = 90; | |
85 phi = 0:refinement:360; | |
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
86 if (normalize) |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
87 xphi = cumsum (x / sum (x) * 360); |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
88 else |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
89 xphi = cumsum (x * 360); |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
90 endif |
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11338
diff
changeset
|
91 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
92 for i = 1:len |
11330 | 93 if (i == 1) |
94 xn = 0 : 360 / refinement : xphi(i); | |
95 else | |
96 xn = xphi(i-1) : 360 / refinement : xphi(i); | |
97 endif | |
98 | |
99 if (xn(end) != xphi(i)) | |
100 xn = [xn, xphi(i)]; | |
101 endif | |
102 | |
103 xn2 = (xn(1) + xn(end)) / 2; | |
104 if (explode (i)) | |
105 xoff = - 0.1 * sind (xn2); | |
106 yoff = 0.1 * cosd (xn2); | |
107 else | |
108 xoff = 0; | |
109 yoff = 0; | |
110 endif | |
111 xt = - 1.2 * sind (xn2); | |
112 yt = 1.2 * cosd (xn2); | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
113 |
11330 | 114 if (len == 1) |
115 set (h, "clim", [1, 2]); | |
116 else | |
117 set (h, "clim", [1, len]); | |
118 endif | |
119 | |
17405
3f0ed69d21c6
Replace unnecessary instances of strncmp with strcmp.
Rik <rik@octave.org>
parents:
17338
diff
changeset
|
120 if (strcmp (caller, "pie3")) |
11330 | 121 ln = length (xn); |
122 zlvl = 0.35; | |
15201
efac5593b1de
* __pie__.m: Avoid syntax errors in matrix lists.
John W. Eaton <jwe@octave.org>
parents:
14868
diff
changeset
|
123 sx = repmat (xoff + [0, -sind(xn), 0], [2, 1]); |
efac5593b1de
* __pie__.m: Avoid syntax errors in matrix lists.
John W. Eaton <jwe@octave.org>
parents:
14868
diff
changeset
|
124 sy = repmat (yoff + [0, cosd(xn), 0], [2, 1]); |
11330 | 125 sz = [zeros(1, ln + 2); zlvl * ones(1, ln + 2)]; |
126 sc = i * ones (size (sz)); | |
127 | |
128 hlist = [hlist; | |
15201
efac5593b1de
* __pie__.m: Avoid syntax errors in matrix lists.
John W. Eaton <jwe@octave.org>
parents:
14868
diff
changeset
|
129 patch(xoff + [0, -sind(xn)], yoff + [0, cosd(xn)], zeros (1, ln + 1), i); |
11330 | 130 surface(sx, sy, sz, sc); |
15201
efac5593b1de
* __pie__.m: Avoid syntax errors in matrix lists.
John W. Eaton <jwe@octave.org>
parents:
14868
diff
changeset
|
131 patch(xoff + [0, -sind(xn)], yoff + [0, cosd(xn)], zlvl * ones (1, ln + 1), i); |
11330 | 132 text(xt, yt, zlvl, labels{i})]; |
133 | |
17405
3f0ed69d21c6
Replace unnecessary instances of strncmp with strcmp.
Rik <rik@octave.org>
parents:
17338
diff
changeset
|
134 elseif (strcmp (caller, "pie")) |
11330 | 135 if (xt > 0) |
136 align = "left"; | |
25198
5251de3c34d7
Center label if only one value is given for a pie chart.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
137 elseif (xt < 0) |
5251de3c34d7
Center label if only one value is given for a pie chart.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
138 align = "right"; |
11330 | 139 else |
25198
5251de3c34d7
Center label if only one value is given for a pie chart.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
140 align = "center"; |
11330 | 141 endif |
142 | |
15201
efac5593b1de
* __pie__.m: Avoid syntax errors in matrix lists.
John W. Eaton <jwe@octave.org>
parents:
14868
diff
changeset
|
143 hlist = [hlist; patch(xoff + [0, -sind(xn)], yoff + [0, cosd(xn)], i); |
11330 | 144 text(xt, yt, labels{i}, "horizontalalignment", align)]; |
145 | |
146 else | |
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
147 error ("__pie__: unknown caller '%s'", caller); |
11330 | 148 endif |
149 endfor | |
150 | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
151 addlistener (gca, "view", {@update_text_pos, hlist}); |
11330 | 152 |
17405
3f0ed69d21c6
Replace unnecessary instances of strncmp with strcmp.
Rik <rik@octave.org>
parents:
17338
diff
changeset
|
153 if (strcmp (caller, "pie3")) |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
154 axis ([-1.25, 1.25, -1.25, 1.25, -0.05, 0.4], "equal", "off"); |
11330 | 155 view (-37.5, 30); |
17405
3f0ed69d21c6
Replace unnecessary instances of strncmp with strcmp.
Rik <rik@octave.org>
parents:
17338
diff
changeset
|
156 elseif (strcmp (caller, "pie")) |
11330 | 157 axis ([-1.5, 1.5, -1.5, 1.5], "square", "off"); |
158 endif | |
21758
ffad2baa90f7
maint: Use newlines to make code more readable.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
159 |
11330 | 160 endfunction |
161 | |
162 function update_text_pos (all_handles) | |
163 ## Text objects in the foreground should be at the base level. | |
164 ## Text objects in the background should be at the top level. | |
165 ## Text objects on the right side should be aligned to the right | |
166 ## and on the left side to the left. | |
167 tobj = findobj (all_handles, "type", "text"); | |
168 | |
169 ## check if we are called from pie3 | |
170 s = findobj (all_handles, "type", "surface"); | |
171 is_pie3 = false; | |
172 if (length (s) > 0) | |
173 is_pie3 = true; | |
174 endif | |
175 | |
176 if (length (tobj) > 0) | |
177 ax = get (tobj(1), "parent"); | |
178 azel = get (ax, "view"); | |
179 pos = get (tobj, "position"); | |
180 if (iscell (pos)) | |
181 pos = cell2mat (pos); | |
182 endif | |
183 phi = atand (pos(:,1) ./ pos(:,2)); | |
184 [theta, r] = cart2pol (pos(:,1), pos(:,2)); | |
185 theta *= 180/pi; | |
186 theta -= azel(1); | |
187 theta = mod (theta, 360); | |
188 ud_mask = (theta > 180); | |
189 lr_mask = (theta > 90) & (theta < 270); | |
190 for i = 1 : length (tobj) | |
191 if (is_pie3) | |
192 if (ud_mask(i)) | |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
193 set (tobj(i), "position", [pos(i,1), pos(i,2), -0.05]); |
11330 | 194 else |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
195 set (tobj(i), "position", [pos(i,1), pos(i,2), 0.40]); |
11330 | 196 endif |
197 endif | |
198 | |
199 if (lr_mask(i)) | |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
200 set (tobj(i), "horizontalalignment", "right"); |
11330 | 201 else |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
202 set (tobj(i), "horizontalalignment", "left"); |
11330 | 203 endif |
204 endfor | |
205 endif | |
21758
ffad2baa90f7
maint: Use newlines to make code more readable.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
206 |
11330 | 207 endfunction |