use R2019b+ arguments validation

Author: scivision

+hdf5nc/auto_chunk_size.m

@@ -2,8 +2,9 @@
 % automatically determine HDF5 / NetCDF4 chunk size.
 % based on https://github.com/h5py/h5py/blob/master/h5py/_hl/filters.py
 % refer to https://support.hdfgroup.org/HDF5/Tutor/layout.html
-narginchk(1,1)
-validateattributes(dims, {'numeric'}, {'vector', 'integer', 'positive'})
+arguments
+  dims (1,:) {mustBeInteger,mustBePositive}
+end
 
 CHUNK_BASE = 16000;  % Multiplier by which chunks are adjusted
 CHUNK_MIN = 8000;    % lower limit: 8 kbyte

+hdf5nc/coerce_ds.m

@@ -1,8 +1,9 @@
 function A = coerce_ds(A, dtype)
 % used by h5save and ncsave
-narginchk(2,2)
-validateattributes(A, {'numeric'}, {'nonempty'},1)
-validateattributes(dtype, {'char'}, {'vector'},2)
+arguments
+  A {mustBeNumeric,mustBeNonempty}
+  dtype (1,1) string
+end
 
 switch dtype
   case {'float64', 'double'}
@@ -28,4 +29,4 @@
   otherwise, error('create_ds:type_error', 'unknown data type %s', dtype)
 end
 
-end % function
+end % function

+hdf5nc/expanduser.m

@@ -1,7 +1,7 @@
 function expanded = expanduser(p)
 % expanded = expanduser(path)
 %
-%   expands tilde ~ into user home directory for Matlab and GNU Octave.
+%   expands tilde ~ into user home directory
 %
 %   Useful for Matlab functions like h5read() and some Computer Vision toolbox functions
 %   that can't handle ~ and Matlab does not consider it a bug per conversations with
@@ -18,38 +18,24 @@
 %   timeit(f)
 %
 %   See also absolute_path
-
-narginchk(1,1)
-
-if isempty(p)
-  expanded = '';
-  return
+arguments
+  p (1,1) string
 end
 
-validateattributes(p, {'char'}, {'vector'}, 1)
-
 expanded = p;
 
-if strcmp(expanded(1), '~')
-
-  home = [];
-  if isunix
-    home = getenv('HOME');
-  elseif ispc
-    home = getenv('USERPROFILE');
-  end
+if ~startsWith(expanded, "~")
+  return
+end
 
-  if isempty(home)
-    if usejava('jvm')
-      % this is 100x slower than getenv() on Matlab R2020a
-      home = char(java.lang.System.getProperty("user.home"));
-    else
-      % return unmodified
-      return
-    end
-  end
+if ispc
+  home = getenv('USERPROFILE');
+else
+  home = getenv('HOME');
+end
 
-  expanded = fullfile(home, expanded(2:end));
+if ~isempty(home)
+  expanded = fullfile(home, extractAfter(expanded, 1));
 end
 
 end %function

+hdf5nc/h5exists.m

@@ -1,15 +1,24 @@
-function exists = h5exists(filename, varname)
-% check if variable exists in HDF5 file
+function exists = h5exists(filename, varnames)
+% check if variable(s) exists in HDF5 file
 %
 % filename: HDF5 filename
 % varname: name of variable inside HDF5 file
 %
 % exists: boolean
+arguments
+  filename (1,1) string
+  varnames (1,:) string
+end
 
-narginchk(2,2)
-validateattributes(filename, {'char'}, {'vector'}, 1)
-validateattributes(varname, {'char'}, {'vector'}, 2)
+if startsWith(varnames, "/")
+  varnames = extractAfter(varnames, 1);
+end
 
-exists = any(strcmp(hdf5nc.h5variables(filename), varname(2:end)));
+vars = hdf5nc.h5variables(filename);
+
+exists = false(size(varnames));
+for i = 1:length(varnames)
+  exists(i) = any(vars == varnames(i));
+end
 
 end % function

+hdf5nc/h5save.m

@@ -2,20 +2,25 @@ function h5save(filename, varname, A, sizeA, dtype)
 % H5SAVE
 % create or append to HDF5 file
 % parent folder (file directory) must already exist
-
-narginchk(3, 5)
+arguments
+  filename (1,1) string
+  varname (1,1) string
+  A {mustBeNumeric,mustBeNonempty}
+  sizeA (1,:) {mustBeInteger,mustBeNonnegative} = []
+  dtype (1,1) string = ""
+end
 
 filename = hdf5nc.expanduser(filename);
 
-if nargin < 4 || isempty(sizeA)
+if isempty(sizeA)
   if isvector(A)
     sizeA = length(A);
   else
     sizeA = size(A);
   end
 end
-
-if nargin >= 5 && ~isempty(dtype)
+% coerce if needed
+if dtype ~= ""
   A = hdf5nc.coerce_ds(A, dtype);
 end
 if ischar(A)
@@ -27,15 +32,13 @@ function h5save(filename, varname, A, sizeA, dtype)
   exist_file(filename, varname, A, sizeA)
 else
   new_file(filename, varname, A, sizeA)
-end % if
+end
 
 end % function
 
 
 function exist_file(filename, varname, A, sizeA)
 
-narginchk(4,4)
-
 diskshape = hdf5nc.h5size(filename, varname);
 if length(diskshape) >= 2
   % start is always a row vector, regardless of shape of array
@@ -58,7 +61,6 @@ function exist_file(filename, varname, A, sizeA)
 
 
 function new_file(filename, varname, A, sizeA)
-narginchk(4,4)
 
 folder = fileparts(filename);
 assert(isfolder(folder), '%s is not a folder, cannot create %s', folder, filename)

+hdf5nc/h5size.m

@@ -5,10 +5,10 @@
 % variable: name of variable inside HDF5 file
 %
 % fsize: vector of variable size per dimension
-
-narginchk(2,2)
-validateattributes(filename, {'char'}, {'vector'}, 1)
-validateattributes(variable, {'char'}, {'vector'}, 2)
+arguments
+  filename (1,1) string
+  variable (1,1) string
+end
 
 finf = h5info(hdf5nc.expanduser(filename), variable);
 fsize = finf.Dataspace.Size;

+hdf5nc/h5variables.m

@@ -1,18 +1,20 @@
 function [names, groups] = h5variables(filename, group)
 % get dataset names and groups in an HDF5 file
+arguments
+  filename (1,1) string
+  group (1,1) string = ""
+end
 
-narginchk(1,2)
-
-names = [];
-groups = [];
+names = string([]);
+groups = string([]);
 
-% use temporary variable to be R2017b OK
 finf = h5info(hdf5nc.expanduser(filename));
 ds = finf.Datasets;
 if isempty(ds)
   return
 end
-if nargin > 1
+
+if group ~= ""
   gs = finf.Groups;
   i = contains({gs(:).Name}, group);
   if ~any(i)
@@ -21,11 +23,11 @@
   ds = gs(i).Datasets;
 end
 
-names = {ds(:).Name};
+names = string({ds(:).Name});
 
 if nargout > 1
   gs = finf.Groups;
-  groups = {gs.Name};
+  groups = string({gs.Name});
 end
 
 end % function

+hdf5nc/ncexists.m

@@ -1,15 +1,20 @@
-function exists = ncexists(filename, varname)
-% check if variable exists in NetCDF4 file
+function exists = ncexists(filename, varnames)
+% check if variable(s) exists in NetCDF4 file
 %
 % filename: NetCDF4 filename
 % varname: name of variable inside file
 %
 % exists: boolean
+arguments
+  filename (1,1) string
+  varnames (1,:) string
+end
 
-narginchk(2,2)
-validateattributes(filename, {'char'}, {'vector'}, 1)
-validateattributes(varname, {'char'}, {'vector'}, 2)
+vars = hdf5nc.ncvariables(filename);
 
-exists = any(strcmp(hdf5nc.ncvariables(filename), varname));
+exists = false(size(varnames));
+for i = 1:length(varnames)
+  exists(i) = any(vars == varnames(i));
+end
 
 end % function

+hdf5nc/ncsave.m

@@ -1,10 +1,18 @@
 function ncsave(filename, varname, A, ncdims, dtype)
-
-narginchk(3, 5)
+% NCSAVE
+% create or append to NetCDF4 file
+% parent folder (file directory) must already exist
+arguments
+  filename (1,1) string
+  varname (1,1) string
+  A {mustBeNumeric,mustBeNonempty}
+  ncdims cell = {}
+  dtype (1,1) string = ""
+end
 
 filename = hdf5nc.expanduser(filename);
 
-if nargin >= 4 && ~isempty(ncdims)
+if ~isempty(ncdims)
   for i = 2:2:length(ncdims)
     sizeA(i/2) = ncdims{i};
   end
@@ -28,7 +36,7 @@ function ncsave(filename, varname, A, ncdims, dtype)
   end % if
 end
 % coerce if needed
-if nargin >= 5 && ~isempty(dtype)
+if dtype ~= ""
   A = hdf5nc.coerce_ds(A, dtype);
 end
 
@@ -44,8 +52,6 @@ function ncsave(filename, varname, A, ncdims, dtype)
 
 function exist_file(filename, varname, A, sizeA)
 
-narginchk(4,4)
-
 diskshape = hdf5nc.ncsize(filename, varname);
 
 if all(diskshape == sizeA)
@@ -61,8 +67,6 @@ function exist_file(filename, varname, A, sizeA)
 
 function new_file(filename, varname, A, sizeA, ncdims)
 
-narginchk(5,5)
-
 folder = fileparts(filename);
 assert(isfolder(folder), '%s is not a folder, cannot create %s', folder, filename)
 

+hdf5nc/ncsize.m

@@ -5,10 +5,10 @@
 % variable: name of variable inside file
 %
 % fsize: vector of variable size per dimension
-
-narginchk(2,2)
-validateattributes(filename, {'char'}, {'vector'}, 1)
-validateattributes(varname, {'char'}, {'vector'}, 2)
+arguments
+  filename (1,1) string
+  varname (1,1) string
+end
 
 vinf = ncinfo(hdf5nc.expanduser(filename), varname);
 fsize = vinf.Size;