add [h5,nc]ndims

Author: scivision

+stdlib/+hdf5nc/h5ndims.m

@@ -0,0 +1,25 @@
+function frank = h5ndims(file, variable)
+% get number of dimensions of an HDF5 dataset
+%
+% filename: HDF5 filename
+% variable: name of variable inside file
+%
+arguments
+  file (1,1) string {mustBeNonzeroLengthText}
+  variable (1,1) string {mustBeNonzeroLengthText}
+end
+
+import stdlib.fileio.expanduser
+
+file = expanduser(file);
+
+assert(isfile(file), "%s not found", file)
+
+dsi = h5info(file, variable).Dataspace;
+if dsi.Type == "scalar"
+  frank = 0;
+else
+  frank = length(dsi.Size);
+end
+
+end

+stdlib/+hdf5nc/ncndims.m

@@ -0,0 +1,25 @@
+function frank = ncndims(file, variable)
+% get number of dimensions of a NetCDF4 variable
+%
+% filename: NetCDF4 filename
+% variable: name of variable inside file
+
+arguments
+  file (1,1) string {mustBeNonzeroLengthText}
+  variable (1,1) string {mustBeNonzeroLengthText}
+end
+
+import stdlib.fileio.expanduser
+
+file = expanduser(file);
+
+assert(isfile(file), "%s not found", file)
+
+dsi = ncinfo(file, variable);
+if isempty(dsi.Dimensions)
+  frank = 0;
+else
+  frank = length(dsi.Size);
+end
+
+end

+stdlib/TestHDF5.m

@@ -113,26 +113,38 @@ function test_exists(tc, vars)
 
 function test_size(tc)
 import stdlib.hdf5nc.h5size
+import stdlib.hdf5nc.h5ndims
 basic = tc.TestData.basic;
 
+r = h5ndims(basic, '/A0');
 s = h5size(basic, '/A0');
 tc.verifyEmpty(s)
+tc.verifyEqual(r, 0)
 
+r = h5ndims(basic, '/A1');
 s = h5size(basic, '/A1');
 tc.verifyTrue(isscalar(s))
 tc.verifyEqual(s, 2)
+tc.verifyEqual(r, 1)
 
+r = h5ndims(basic, '/A2');
 s = h5size(basic, '/A2');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,4])
+tc.verifyEqual(r, 2)
 
+r = h5ndims(basic, '/A3');
 s = h5size(basic, '/A3');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2])
+tc.verifyEqual(r, 3)
 
+r = h5ndims(basic, '/A4');
 s = h5size(basic, '/A4');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2,5])
+tc.verifyEqual(r, 4)
+
 end
 
 

+stdlib/TestNetCDF.m

@@ -79,27 +79,38 @@ function test_exists(tc, vars)
 
 function test_size(tc)
 import stdlib.hdf5nc.ncsize
+import stdlib.hdf5nc.ncndims
 import matlab.unittest.constraints.IsScalar
 basic = tc.TestData.basic;
 
+r = ncndims(basic, 'A0');
 s = ncsize(basic, 'A0');
 tc.verifyEmpty(s)
+tc.verifyEqual(r, 0)
 
+r = ncndims(basic, 'A1');
 s = ncsize(basic, 'A1');
 tc.verifyThat(s, IsScalar)
 tc.verifyEqual(s, 2)
+tc.verifyEqual(r, 1)
 
+r = ncndims(basic, 'A2');
 s = ncsize(basic, 'A2');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,4])
+tc.verifyEqual(r, 2)
 
+r = ncndims(basic, 'A3');
 s = ncsize(basic, 'A3');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2])
+tc.verifyEqual(r, 3)
 
+r = ncndims(basic, 'A4');
 s = ncsize(basic, 'A4');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2,5])
+tc.verifyEqual(r, 4)
 
 end
 

Readme.md

@@ -56,6 +56,14 @@ h5save(filename, dataset_name, dataset, "type", "int32")
 
 ---
 
+Get the dataset rank (number of dimensions)
+
+```matlab
+h5ndims(filename, variable_name)
+```
+
+---
+
 Get the dataset size (shape)
 
 ```matlab
@@ -99,6 +107,14 @@ ncsave(filename, variable_name, variable)
 
 ---
 
+Get the variable rank (number of dimensions)
+
+```matlab
+ncndims(filename, variable_name)
+```
+
+---
+
 Get the dataset size (shape)
 
 ```matlab