Mercurial > octave
view scripts/miscellaneous/mustBePositive.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) 2019-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 {} {} mustBePositive (@var{x}) ## ## Require that input @var{x} is positive. ## ## Raise an error if any element of the input @var{x} is not positive, as ## determined by @code{@var{x} > 0}. ## ## @seealso{mustBeNonnegative, mustBeNonzero} ## @end deftypefn function mustBePositive (x) if (nargin < 1) print_usage (); endif tf = (x(:) > 0); if (! all (tf)) label = inputname (1); if (isempty (label)) label = "input"; endif bad_idx = find (! tf); try bad_val = x(bad_idx); errmsg = sprintf ("%s must be positive; found %d elements that were not: values %s", ... label, numel (bad_idx), mat2str (bad_val)); catch errmsg = sprintf ("%s must be positive; found %d elements that were not: indexes %s", ... label, numel (bad_idx), mat2str (bad_idx)); end_try_catch error (errmsg); endif endfunction %!test %! mustBePositive (1); %! mustBePositive (123.456); %! mustBePositive (Inf); %! mustBePositive (eps); %!error <Invalid call> mustBePositive () %!error <found 1 elements> mustBePositive (0) %!error <found 1 elements> mustBePositive (0:10) %!error <found 2 elements> mustBePositive ([-1 -2]) %!error <found 2 elements> mustBePositive ([0 1 2 3 -4]) %!error <found 1 elements> mustBePositive (-Inf) %!error <found 1 elements> mustBePositive (NaN)