ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
vendor.m File Reference

Go to the source code of this file.

Functions

function vendor (in name)
 Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared libraries naming conventions.
More...
 

Function Documentation

◆ vendor()

function vendor ( in  name)

Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared libraries naming conventions.

Parameters
[in]name: The output scalar MATLAB string containing the MPI library name corresponding to the output MPI vendor.
If the input name is not supported, the default string "mpi" is returned as the value of str.
Possible values are:
  1. "mpi" : The corresponding output vendor name txt would be unknown and set to "MPI".
  2. "impi" : The corresponding output vendor name txt would be set to "Intel".
  3. "mpich" : The corresponding output vendor name txt would be set to "MPICH".
  4. "openmpi" : The corresponding output vendor name txt would be set to "OpenMPI".
Note that all values are case-insensitive.
Returns
str : The output scalar MATLAB string, containing the MPI library vendor name supported by the ParaMonte library.
Possible values are:
  1. "MPI", representing an unknown MPI library vendor.
  2. "Intel", representing the Intel MPI library vendor.
  3. "MPICH", representing the MPICH MPI library vendor.
  4. "OpenMPI", representing the OpenMPI library vendor.


Possible calling interfaces

str = pm.lib.mpi.vendor(name)
function name(in vendor)
Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories.
See also
pm.lib.mpi.name()
pm.lib.mpi.vendor()
pm.sys.path.mpiexec.vendor()


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('pm.lib.mpi.vendor("impi")')
5disp( pm.lib.mpi.vendor("impi") )
6disp("")
7
8disp('pm.lib.mpi.vendor("INTEL")')
9disp( pm.lib.mpi.vendor("INTEL") )
10disp("")
11
12disp('pm.lib.mpi.vendor("intel")')
13disp( pm.lib.mpi.vendor("intel") )
14disp("")
15
16disp('pm.lib.mpi.vendor("ompi")')
17disp( pm.lib.mpi.vendor("ompi") )
18disp("")
19
20disp('pm.lib.mpi.vendor("openmpi")')
21disp( pm.lib.mpi.vendor("openmpi") )
22disp("")
23
24disp('pm.lib.mpi.vendor("open-mpi")')
25disp( pm.lib.mpi.vendor("open-mpi") )
26disp("")
27
28disp('pm.lib.mpi.vendor("mpich")')
29disp( pm.lib.mpi.vendor("mpich") )
30disp("")
31
32disp('pm.lib.mpi.vendor("unknown")')
33disp( pm.lib.mpi.vendor("unknown") )
function vendor(in name)
Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared lib...
function lib()
Return a scalar MATLAB string containing the path to the lib directory of the ParaMonte library packa...
function ompi()
Return the MPI image count and the current image ID (e.g., MPI rank + 1) if the application has been ...
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output
1pm.lib.mpi.vendor("impi")
2Intel
3pm.lib.mpi.vendor("INTEL")
4Intel
5pm.lib.mpi.vendor("intel")
6Intel
7pm.lib.mpi.vendor("ompi")
8OpenMPI
9pm.lib.mpi.vendor("openmpi")
10OpenMPI
11pm.lib.mpi.vendor("open-mpi")
12OpenMPI
13pm.lib.mpi.vendor("mpich")
14MPICH
15pm.lib.mpi.vendor("unknown")
16MPI


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.

  1. 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.
  2. 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.

Author:
Joshua Alexander Osborne, May 21 2024, 7:20 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin