Mercurial > octave
annotate scripts/miscellaneous/ver.m @ 28789:28de41192f3c
Eliminate unneeded verification of nargin, nargout in m-files.
* FIRfilter.m, FIRfilter_aggregation.m, get.m, polynomial.m,
polynomial_superiorto.m, polynomial2.m, makeUniqueStrings.m, base64decode.m,
base64encode.m, cd.m, lin2mu.m, record.m, sound.m, soundsc.m, accumarray.m,
accumdim.m, bitcmp.m, bitset.m, cart2pol.m, celldisp.m, circshift.m,
cplxpair.m, cumtrapz.m, flip.m, idivide.m, interpft.m, logspace.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, rat.m, rot90.m, rotdim.m, shift.m, shiftdim.m,
sortrows.m, trapz.m, dsearch.m, dsearchn.m, getappdata.m, getpixelposition.m,
guidata.m, guihandles.m, isappdata.m, listfonts.m, uigetdir.m,
waitforbuttonpress.m, __makeinfo__.m, doc.m, get_first_help_sentence.m,
autumn.m, bone.m, brighten.m, cmpermute.m, cmunique.m, colorcube.m, contrast.m,
cool.m, copper.m, cubehelix.m, flag.m, gray.m, gray2ind.m, hot.m, hsv.m,
im2double.m, im2frame.m, imformats.m, jet.m, lines.m, ocean.m, pink.m, prism.m,
rainbow.m, rgbplot.m, spinmap.m, spring.m, summer.m, viridis.m, white.m,
winter.m, beep.m, importdata.m, is_valid_file_id.m, javachk.m, javaclasspath.m,
findstr.m, genvarname.m, strmatch.m, bandwidth.m, commutation_matrix.m, cond.m,
cross.m, isdefinite.m, ishermitian.m, issymmetric.m, krylov.m, linsolve.m,
logm.m, lscov.m, null.m, ordeig.m, orth.m, rank.m, rref.m, vecnorm.m,
bunzip2.m, citation.m, computer.m, copyfile.m, dir.m, dos.m, fileattrib.m,
gunzip.m, inputParser.m, inputname.m, ismac.m, ispc.m, isunix.m, license.m,
list_primes.m, methods.m, mkdir.m, movefile.m, nargchk.m, news.m,
orderfields.m, recycle.m, tar.m, unix.m, unpack.m, untar.m, unzip.m, ver.m,
version.m, what.m, zip.m, decic.m, fminbnd.m, fminunc.m, fsolve.m, fzero.m,
glpk.m, humps.m, lsqnonneg.m, optimget.m, pqpnonneg.m, sqp.m, pathdef.m,
camlookat.m, hidden.m, specular.m, plotmatrix.m, smooth3.m, sombrero.m,
stemleaf.m, __gnuplot_drawnow__.m, __opengl_info__.m, ancestor.m, cla.m,
close.m, closereq.m, copyobj.m, gca.m, gcf.m, ginput.m, graphics_toolkit.m,
groot.m, hgload.m, hgsave.m, isgraphics.m, ishold.m, linkaxes.m, meshgrid.m,
newplot.m, refresh.m, refreshdata.m, rotate.m, saveas.m, struct2hdl.m, conv.m,
mkpp.m, mpoles.m, padecoef.m, pchip.m, polyder.m, polyfit.m, polygcd.m,
polyint.m, polyout.m, polyval.m, ppder.m, ppint.m, getpref.m, ispref.m,
rmpref.m, profexport.m, profshow.m, powerset.m, arch_fit.m, arma_rnd.m,
blackman.m, detrend.m, diffpara.m, fftconv.m, fftfilt.m, filter2.m, freqz.m,
freqz_plot.m, hamming.m, hanning.m, sinetone.m, sinewave.m, spectral_adf.m,
spectral_xdf.m, stft.m, unwrap.m, gplot.m, ichol.m, ilu.m, spdiags.m, sprand.m,
sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, betainc.m,
betaincinv.m, ellipke.m, gammainc.m, gammaincinv.m, legendre.m, pow2.m,
hankel.m, pascal.m, rosser.m, toeplitz.m, bounds.m, corr.m, cov.m, histc.m,
kendall.m, kurtosis.m, mad.m, mode.m, moment.m, prctile.m, quantile.m, range.m,
ranks.m, run_count.m, skewness.m, spearman.m, std.m, var.m, zscore.m,
dec2base.m, dec2bin.m, dec2hex.m, index.m, mat2str.m, native2unicode.m,
ostrsplit.m, strjoin.m, strjust.m, strtok.m, substr.m, unicode2native.m,
untabify.m, __debug_octave__.m, demo.m, example.m, fail.m, oruntests.m,
dump_demos.m, speed.m, test.m, date.m, datenum.m, datestr.m, datevec.m,
is_leap_year.m, now.m, weekday.m:
Eliminate unneeded verification of nargin, nargout in m-files now that
the interpreter checks these values.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 24 Sep 2020 14:44:58 -0700 |
parents | 8e8cfb6304e1 |
children | 7854d5752dd2 |
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 ## |
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
3 ## Copyright (C) 2005-2020 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/>. |
5546 | 7 ## |
8 ## This file is part of Octave. | |
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 |
5546 | 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. |
5546 | 14 ## |
15 ## Octave is distributed in the hope that it will be useful, but | |
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. |
5546 | 19 ## |
20 ## You should have received a copy of the GNU General Public License | |
7016 | 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 ######################################################################## |
5546 | 25 |
26 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
27 ## @deftypefn {} {} ver |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
28 ## @deftypefnx {} {} ver Octave |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
29 ## @deftypefnx {} {} ver @var{package} |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
30 ## @deftypefnx {} {v =} ver (@dots{}) |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
31 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
32 ## Display a header containing the current Octave version number, license |
19187 | 33 ## string, and operating system. The header is followed by a list of installed |
34 ## packages, versions, and installation directories. | |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
35 ## |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
36 ## Use the package name @var{package} or Octave to query a specific component. |
16491
b10a23fe80bb
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
Rik <rik@octave.org>
parents:
16489
diff
changeset
|
37 ## |
19187 | 38 ## When called with an output argument, return a vector of structures |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
39 ## describing Octave and each installed package. Each structure includes the |
19187 | 40 ## following fields. |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
41 ## |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
42 ## @table @code |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
43 ## @item Name |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
44 ## Package name. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
45 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
46 ## @item Version |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
47 ## Version of the package. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
48 ## |
24581
06eb006b1e0f
doc: Correct fieldname of returned struct in ver (bug #52845).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23219
diff
changeset
|
49 ## @item Release |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
50 ## Release of the package (currently unused, defaults to @code{[]}). |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
51 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
52 ## @item Date |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
53 ## Date that the version was released. |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
54 ## @end table |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
55 ## |
21434
1da428cbf401
deprecate octave_config_info
John W. Eaton <jwe@octave.org>
parents:
20852
diff
changeset
|
56 ## @seealso{version, usejava, pkg} |
5546 | 57 ## @end deftypefn |
58 | |
19187 | 59 function retval = ver (package = "") |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
60 |
19187 | 61 if (nargout == 0) |
24746
52ca22ba4474
include hg ID in displayed version info
John W. Eaton <jwe@octave.org>
parents:
24582
diff
changeset
|
62 hg_id = __octave_config_info__ ("hg_id"); |
52ca22ba4474
include hg ID in displayed version info
John W. Eaton <jwe@octave.org>
parents:
24582
diff
changeset
|
63 |
19187 | 64 [unm, err] = uname (); |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
65 |
19187 | 66 if (err) |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
67 os_string = "unknown"; |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
68 else |
19187 | 69 os_string = sprintf ("%s %s %s %s", |
70 unm.sysname, unm.release, unm.version, unm.machine); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
71 endif |
5546 | 72 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
73 hbar(1:70) = "-"; |
19187 | 74 desc = {hbar |
24746
52ca22ba4474
include hg ID in displayed version info
John W. Eaton <jwe@octave.org>
parents:
24582
diff
changeset
|
75 ["GNU Octave Version: " OCTAVE_VERSION " (hg id: " hg_id ")"] |
19187 | 76 ["GNU Octave License: " license] |
77 ["Operating System: " os_string] | |
78 hbar}; | |
79 | |
80 printf ("%s\n", desc{:}); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
81 |
19187 | 82 if (isempty (package)) |
83 pkg ("list"); | |
84 elseif (strcmpi (package, "Octave")) | |
85 ## Nothing to do, Octave version was already reported | |
86 else | |
87 pkg ("list", package); | |
88 endif | |
5546 | 89 else |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
90 ## Return outputs rather than displaying summary to screen. |
19187 | 91 if (isempty (package)) |
92 ## Start with the version info for Octave | |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
93 [octver, octdate] = version (); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
94 retval = struct ("Name", "Octave", "Version", octver, |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
95 "Release", [], "Date", octdate); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
96 lst = pkg ("list"); |
19187 | 97 for i = 1:numel (lst) |
98 retval(end+1) = struct ("Name", lst{i}.name, "Version", lst{i}.version, | |
99 "Release", [], "Date", lst{i}.date); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
100 endfor |
19187 | 101 elseif (strcmpi (package, "Octave")) |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
102 [octver, octdate] = version (); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
103 retval = struct ("Name", "Octave", "Version", octver, |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
104 "Release", [], "Date", octdate); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
105 else |
19187 | 106 lst = pkg ("list", package); |
107 if (isempty (lst)) | |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
108 retval = struct ("Name", {}, "Version", {}, "Release", {}, "Date", {}); |
19187 | 109 else |
110 retval = struct ("Name", lst{1}.name, "Version", lst{1}.version, | |
111 "Release", [], "Date", lst{1}.date); | |
112 endif | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
113 endif |
5546 | 114 endif |
115 | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
116 endfunction |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
117 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
118 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
119 %!test |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
120 %! result = ver; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
121 %! assert (result(1).Name, "Octave"); |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
122 %! assert (result(1).Version, OCTAVE_VERSION ()); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
123 %! assert (result(1).Release, []); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
124 %! assert (result(1).Date, __octave_config_info__ ("release_date")); |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
125 %! result = ver ("octave"); |
28756
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
126 %! assert (result.Name, "Octave"); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
127 %! assert (result.Version, OCTAVE_VERSION ()); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
128 %! assert (result.Release, []); |
8e8cfb6304e1
ver.m: Return release date for "Octave" component (bug #59125).
Rik <rik@octave.org>
parents:
27978
diff
changeset
|
129 %! assert (result.Date, __octave_config_info__ ("release_date")); |
5546 | 130 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
131 %!test |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
132 %! lst = pkg ("list"); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
133 %! for n = 1:numel (lst) |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
134 %! expected = lst{n}.name; |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
135 %! result = ver (expected); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
136 %! assert (result.Name, expected); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
137 %! assert (isfield (result, "Version"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
138 %! assert (isfield (result, "Release"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
139 %! assert (isfield (result, "Date"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
140 %! endfor |
5546 | 141 |
21914
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
142 %!test |
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
143 %! result = ver ("%_an_unknown_package_%"); |
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
144 %! assert (isempty (result), true); |