Mercurial > octave
view scripts/miscellaneous/ver.m @ 32047:e3de59065cf1
inputParser.m: Re-architect internal data structures for 60% speed improvement.
Key idea is to replace Parameter and Switch structs with name field containing
a nested struct (def, val fields) with a struct array that has fields "name",
"def", and "val". This makes it possible to eliminate for loops.
* NEWS.9.md: Announce performance improvement.
* inputParser.m: Declare "Parameter" and "Switch" properties as struct arrays.
Add new private property "last_idx" which caches the last Parameter or Switch
lookup.
* inputParser.m (addRequired): Adjust input validation to use numel() now
rather than numfields().
* inputParser.m (addOptional): Adjust input validation to use numel() now
rather than numfields().
* inputParser.m (addParameter): Change code to add new Parameter to a struct
array.
* inputParser.m (addSwitch): Change code to add new Switch to a struct
array.
* inputParser.m (parse): Adjust initialization of internal variables
ParameterNames and SwitchNames to match new data structure.
Use last_idx to simplify call to validate_arg() for Parameters.
* inputParser.m (validate_arg): Move creation of error message
to code path when error has been found---No need to do it for every
function call. Don't capture "exception" variable in try/catch as
it is no longer used.
* inputParser.m (is_argname): Cache "last_idx" if match was found.
* inputParser.m (add_missing): Replace call to setdiff() with in-place
code which can take advantage of implicit knowledge to eliminate calls
to unique and input validation. Replace for loop with cell2struct/struct2cell
combination.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 21 Apr 2023 11:01:40 -0700 |
parents | 597f3ee61a48 |
children | 2e484f9f1f18 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-2023 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} ver ## @deftypefnx {} {} ver Octave ## @deftypefnx {} {} ver @var{package} ## @deftypefnx {} {v =} ver (@dots{}) ## ## Display a header containing the current Octave version number, license ## string, and operating system. The header is followed by a list of installed ## packages, versions, and installation directories. ## ## Use the package name @var{package} or Octave to query a specific component. ## ## When called with an output argument, return a vector of structures ## describing Octave and each installed package. Each structure includes the ## following fields. ## ## @table @code ## @item Name ## Package name. ## ## @item Version ## Version of the package. ## ## @item Release ## Release of the package (currently unused, defaults to @code{[]}). ## ## @item Date ## Date that the version was released. ## @end table ## ## @seealso{version, usejava, pkg} ## @end deftypefn function v = ver (package = "") if (nargout == 0) hg_id = __octave_config_info__ ("hg_id"); [unm, err] = uname (); if (err) os_string = "unknown"; else os_string = sprintf ("%s %s %s %s", unm.sysname, unm.release, unm.version, unm.machine); endif hbar(1:70) = "-"; desc = {hbar ["GNU Octave Version: " OCTAVE_VERSION " (hg id: " hg_id ")"] ["GNU Octave License: " license] ["Operating System: " os_string] hbar}; printf ("%s\n", desc{:}); if (isempty (package)) pkg ("list"); elseif (strcmpi (package, "Octave")) ## Nothing to do, Octave version was already reported else pkg ("list", package); endif else ## Return outputs rather than displaying summary to screen. if (isempty (package)) ## Start with the version info for Octave [octver, octdate] = version (); v = struct ("Name", "Octave", "Version", octver, "Release", [], "Date", octdate); lst = pkg ("list"); for i = 1:numel (lst) v(end+1) = struct ("Name", lst{i}.name, "Version", lst{i}.version, "Release", [], "Date", lst{i}.date); endfor elseif (strcmpi (package, "Octave")) [octver, octdate] = version (); v = struct ("Name", "Octave", "Version", octver, "Release", [], "Date", octdate); else lst = pkg ("list", package); if (isempty (lst)) v = struct ("Name", {}, "Version", {}, "Release", {}, "Date", {}); else v = struct ("Name", lst{1}.name, "Version", lst{1}.version, "Release", [], "Date", lst{1}.date); endif endif endif endfunction %!test %! result = ver; %! assert (result(1).Name, "Octave"); %! assert (result(1).Version, OCTAVE_VERSION ()); %! assert (result(1).Release, []); %! assert (result(1).Date, __octave_config_info__ ("release_date")); %! result = ver ("octave"); %! assert (result.Name, "Octave"); %! assert (result.Version, OCTAVE_VERSION ()); %! assert (result.Release, []); %! assert (result.Date, __octave_config_info__ ("release_date")); %!test %! lst = pkg ("list"); %! for n = 1:numel (lst) %! expected = lst{n}.name; %! result = ver (expected); %! assert (result.Name, expected); %! assert (isfield (result, "Version"), true); %! assert (isfield (result, "Release"), true); %! assert (isfield (result, "Date"), true); %! endfor %!test %! result = ver ("%_an_unknown_package_%"); %! assert (isempty (result), true);