ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
Go to the source code of this file.
Functions | |
function | nproc (in config) |
Return the runtime number of MPI cores with which the mpiexec launcher may have been invoked.More... | |
function nproc | ( | in | config | ) |
Return the runtime number of MPI cores with which the mpiexec
launcher may have been invoked.
Otherwise, return 1
if no use of mpiexec
launcher is detected or it is invoked with only 1
MPI process.
An output value of 1
can be used as an indication of the mpiexec
launcher in launching the ParaMonte library.
[in] | config | : The input scalar (or array of) MATLAB string(s) containing the ParaMonte-preferred MPI library vendor/name or other configurations as used in naming the ParaMonte MATLAB shared libraries. This argument is passed directly to the corresponding argument of pm.lib.path.mexdir. Possible values of outmost interest to MPI applications are:
(optional. If missing, all possibilities are considered and the largest inferred count is returned.) |
count
: The output MATLAB scalar integer containing the number of MPI processes launched by the mpiexec
command or 1
if no mpiexec
invocation has occurred or the routine fails to load any MPI-enabled ParaMonte library.
Possible calling interfaces ⛓
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.