Functions
function	detect (in vendor)
	Return the MPI image count and current image ID (e.g., MPI rank + 1) and the MPI library name as it appears in the ParaMonte library path and the corresponding MPI-parallel ParaMonte library path . More...

Function Documentation

◆ detect()

function detect ( in vendor )

Return the MPI image count and current image ID (e.g., MPI rank + 1) and the MPI library name as it appears in the ParaMonte library path and the corresponding MPI-parallel ParaMonte library path .

This function attempts to detect the invocation of the current MATLAB session via checking the runtime behavior of the mpiexec binary MPI launcher instance.

Output values interpretation

If the output mpiname is set to an empty string "", meaning that strcmp(mpiname, "") yields true, then the algorithm has failed, implying that the current application is likely to have been launched by via an mpiexec binary whose MPI library is supported by the ParaMonte library.
If the output mpiname is set to an non-empty string, which must be the name of an MPI library vendor used within ParaMonte,
then an instance of the corresponding MPI library likely exists on the current system and its mpiexec binary has been used to launch the current application in parallel.
If so,
1. A value of 0 for either of the output values nproc and rankp1 implies the algorithm failed to infer the corresponding parameters.
2. A non-zero positive value for either or both of the output values nproc and rankp1 implies that the mpiexec MPI launcher binary of the corresponding MPI library might have been used to launch MATLAB and its might have been used to launch MATLAB.
  1. A non-zero positive value other than 1 for the output nproc guarantees that the mpiexec launcher has been used to launch MATLAB with the specified nproc number of MPI images (processes).

Parameters

[in]

vendor

: The input scalar MATLAB string, containing the MPI library vendor supported by the ParaMonte library.
Possible values are:

OpenMPI, representing the OpenMPI library.
MPICH, representing the MPICH MPI library.
Intel, representing the Intel MPI library.
any, representing any available MPI library.

or any other informal name returned by the ParaMonte MATLAB function pm.lib.mpi.name().
Note that all values are case-insensitive.
(**optional, default = "any".)

Returns: mpiname : The output scalar MATLAB string containing the MPI library name as it appears in the ParaMonte library path.
An output value of "" implies the algorithm failed to detect a ParaMonte-compatible MPI library invoked or installed on the system.
nproc : The output scalar MATLAB non-negative whole number containing the number of MPI images in the current invocation of the mpiexec binary MPI launcher.
An output value of 0 implies the algorithm failed to detect a ParaMonte-compatible MPI library or failed to infer the image count.
rankp1 : The output scalar MATLAB non-negative whole number containing the image ID (e.g., MPI rank + 1) of the current MPI image in the current invocation of the mpiexec binary MPI launcher.
An output value of 0 implies the algorithm failed to detect a ParaMonte-compatible MPI library or failed to infer the image count.
Note that the image ID always starts at 1, unlike the MPI rank.
The argument rankp1 stands for rank + 1.

Possible calling interfaces ⛓

: [mpiname, nproc, rankp1] = pm.lib.mpi.runtime.detect();

[mpiname, nproc, rankp1] = pm.lib.mpi.runtime.detect(vendor);

vendor
function vendor(in name)
Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared lib...

nproc
function nproc(in vendor)
Return the runtime number of MPI processes with which the mpiexec launcher may have been invoked.

rankp1
function rankp1(in vendor)
Return the ID (MPI rank + 1) of the current MPI image (process), starting from the number one.

Warning: This routine must be called before the MPI library is finalized by any other application.
Example applications that finalize the MPI library upon return includes the ParaMonte MPI-parallel samplers.
However, each application offers an option to prevent the default finalization of the MPI library.
For this reason, the results of this function are saved within the function for subsequent usage after the first call.

Note: This function internally uses a persistent MATLAB struct to store the results for the default input value for vendor to expedite future inquiries using this function.
Specifying an input argument value will always

Example usage ⛓

: 1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

2addpath('../../../../'); % Add the ParaMonte library root directory to the search path.

3

4disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect()')

5 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect()

6disp("")

7

8disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("impi")')

9 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("impi")

10disp("")

11

12disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("INTEL")')

13 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("INTEL")

14disp("")

15

16disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("intel")')

17 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("intel")

18disp("")

19

20disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("ompi")')

21 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("ompi")

22disp("")

23

24disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("openmpi")')

25 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("openmpi")

26disp("")

27

28disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("open-mpi")')

29 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("open-mpi")

30disp("")

31

32disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpich")')

33 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpich")

34disp("")

35

36disp('[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpi")')

37 [mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpi")

detect
function detect(in vendor)
Return the MPI image count and current image ID (e.g., MPI rank + 1) and the MPI library name as it a...

impi
function impi()
Return the MPI image count and the current image ID (e.g., MPI rank + 1) if the application has been ...

lib
function lib()
Return a scalar MATLAB string containing the path to the lib directory of the ParaMonte library packa...

ompi
function ompi()
Return the MPI image count and the current image ID (e.g., MPI rank + 1) if the application has been ...

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect()

2mpiname =

3 ""

4bindir =

5 ""

6count =

7 0

8rankp1 =

9 0

10[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("impi")

11mpiname =

12 ""

13bindir =

14 ""

15count =

16 0

17rankp1 =

18 0

19[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("INTEL")

20mpiname =

21 ""

22bindir =

23 ""

24count =

25 0

26rankp1 =

27 0

28[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("intel")

29mpiname =

30 ""

31bindir =

32 ""

33count =

34 0

35rankp1 =

36 0

37[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("ompi")

38mpiname =

39 ""

40bindir =

41 ""

42count =

43 0

44rankp1 =

45 0

46[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("openmpi")

47mpiname =

48 ""

49bindir =

50 ""

51count =

52 0

53rankp1 =

54 0

55[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("open-mpi")

56mpiname =

57 ""

58bindir =

59 ""

60count =

61 0

62rankp1 =

63 0

64[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpich")

65mpiname =

66 ""

67bindir =

68 ""

69count =

70 0

71rankp1 =

72 0

73[mpiname, bindir, count, rankp1] = pm.lib.mpi.detect("mpi")

74mpiname =

75 ""

76bindir =

77 ""

78count =

79 0

80rankp1 =

81 0

Todo:: High Priority: The internals of this function can be improved for better efficiency and less redundancy.

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.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

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.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, 2:27 AM Monday, November 11, 2024, Dallas, TX

Functions

Function Documentation

◆ detect()

Output values interpretation