doc MEX build [skip ci]

Author: scivision

.gitignore

@@ -4,4 +4,6 @@ test-results/
 .buildtool/
 *.asv
 docs/
+
 *.mex*
+*.oct

Readme.md

@@ -14,6 +14,7 @@ Matlab ≥ R2022a is required to run the self-test suite.
 Matlab R2019b is the minimum required due to use of
 [arguments](https://www.mathworks.com/help/matlab/ref/arguments.html)
 syntax.
+URLs (e.g. https://, s3:// and similar) are treated as not existing.
 
 Self-tests can be run from that matlab-stdlib/ directory:
 
@@ -24,6 +25,10 @@ buildtool test
 Functions requiring or optionally benefiting from MEX are indicated in the
 [API Documentation](https://geospace-code.github.io/matlab-stdlib).
 
+To build the optional high-performance
+[MEX](https://www.mathworks.com/help/matlab/cpp-mex-file-applications.html)
+functions:
+
 ```matlab
 buildtool mex
 ```
@@ -34,7 +39,7 @@ or for older Matlab:
 legacy_mex_build()
 ```
 
-URLs (e.g. https://, s3:// and similar) are treated as not existing.
+If just building MEX functions for the first time, to ensure the MEX functions are used instead of the plain Matlab script, one-time do a `clear all` in Matlab.
 
 
 ## Java-based functions

Readme_octave.md

@@ -1,6 +1,6 @@
 # GNU Octave with Matlab-stdlib
 
-If using GNU Octave instead of Matlab the minimum Octave version is 6.0.
+If using GNU Octave instead of Matlab the minimum Octave version is 7.0.
 
 For HDF5 h5*() functions, install
 [hdf5oct](https://gnu-octave.github.io/packages/hdf5oct/)
@@ -17,3 +17,9 @@ package from Octave prompt:
 ```octave
 pkg install -forge netcdf
 ```
+
+## C++ Oct files
+
+Optionally, to enable higher-performance (faster) C++-based .oct functions, run the
+[octave_build](./octave_build.m)
+script from GNU Octave.

octave_build.m

@@ -0,0 +1,22 @@
+% Build C++-based .oct file for GNU Octave
+
+assert(stdlib.isoctave(), "for GNU Octave only")
+
+r = fileparts(mfilename("fullpath"));
+inc = fullfile(r, "src");
+d = fullfile(inc, "octave");
+t = fullfile(r, "+stdlib");
+
+%% specific source
+srcs = {
+fullfile(d, "is_rosetta.cpp"), ...
+};
+
+
+%% build C+ Octave
+for s = srcs
+  src = s{1};
+  [~, n] = fileparts(src);
+
+  mkoctfile(src,"-v", ["-I", inc], "--output", fullfile(t, n))
+end

src/octave/is_rosetta.cpp

@@ -0,0 +1,17 @@
+#include <octave/oct.h>
+
+#include "macos.cpp"
+
+
+DEFUN_DLD (is_rosetta, args, nargout,
+           "Hello World Help String")
+{
+  if (args.length() != 0){
+    octave_stdout << "is_rosetta: No input required\n";
+    return octave_value(false);
+  }
+
+  bool y = fs_is_rosetta();
+
+  return octave_value(y);
+}