diskfree => disk_available, add disk_capacity()

Author: scivision

+stdlib/diskfree.m renamed to +stdlib/disk_available.m

@@ -1,11 +1,10 @@
-%% DISKFREE disk free space
-% returns disk free space in bytes
+%% DISK_AVAILABLE disk available space (bytes)
 %
-% example:  diskfree('/')
+% example:  stdlib.disk_available('/')
 %
 % Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#getUsableSpace()
 
-function f = diskfree(d)
+function f = disk_available(d)
 arguments
   d (1,1) string
 end
@@ -14,4 +13,4 @@
 
 end
 
-%!assert (diskfree('.') > 0)
+%!assert (disk_available('.') > 0)

+stdlib/disk_capacity.m

@@ -0,0 +1,14 @@
+%% DISK_CAPACITY disk total capacity (bytes)
+%
+% example:  stdlib.disk_capacity('/')
+
+function f = disk_capacity(d)
+arguments
+  d (1,1) string
+end
+
+f = javaFileObject(d).getTotalSpace();
+
+end
+
+%!assert (disk_capacity('.') > 0)

Readme.md

@@ -5,8 +5,10 @@
 [![ci](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci.yml/badge.svg)](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci.yml)
 [![ci-nojvm](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci-nojvm.yml/badge.svg)](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci-nojvm.yml)
 
-Matlab or GNU Octave users coming from other languages often notice the missing functionality contained within this user-developed, unofficial "stdlib" standard library of functions.
-These system, filesystem, and HDF5 / HDF4 / NetCDF functions are useful across several of our own and others projects.
+Matlab or
+[GNU Octave](./Readme_octave.md)
+users coming from other languages will benefit from the functionality contained within this user-developed, unofficial "stdlib" standard library of functions.
+These system, filesystem, and HDF5 / HDF4 / NetCDF functions are used across numerous projects.
 
 Matlab ≥ R2021a has full functionality.
 Matlab R2019b is the minimum required due to use of

test/TestJava.m

@@ -132,9 +132,12 @@ function test_checkRAM(tc)
 end
 
 
-function test_diskfree(tc)
-tc.assertTrue(isnumeric(stdlib.diskfree('/')))
-tc.assertTrue(stdlib.diskfree('/') > 0, 'diskfree')
+function test_disk_available(tc)
+tc.assertGreaterThan(stdlib.disk_available('/'), 0)
+end
+
+function test_disk_capacity(tc)
+tc.assertGreaterThan(stdlib.disk_capacity('/'), 0)
 end
 
 end