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: "mpi" : The corresponding output vendor name txt would be unknown and set to "MPI". "impi" : The corresponding output vendor name txt would be set to "Intel". "mpich" : The corresponding output vendor name txt would be set to "MPICH". "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)

See also

pm.lib.mpi.name()
pm.lib.mpi.vendor()
pm.sys.path.mpiexec.vendor()

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
 
disp('pm.lib.mpi.vendor("impi")')
disp( pm.lib.mpi.vendor("impi") )
disp("")
 
disp('pm.lib.mpi.vendor("INTEL")')
disp( pm.lib.mpi.vendor("INTEL") )
disp("")
 
disp('pm.lib.mpi.vendor("intel")')
disp( pm.lib.mpi.vendor("intel") )
disp("")
 
disp('pm.lib.mpi.vendor("ompi")')
disp( pm.lib.mpi.vendor("ompi") )
disp("")
 
disp('pm.lib.mpi.vendor("openmpi")')
disp( pm.lib.mpi.vendor("openmpi") )
disp("")
 
disp('pm.lib.mpi.vendor("open-mpi")')
disp( pm.lib.mpi.vendor("open-mpi") )
disp("")
 
disp('pm.lib.mpi.vendor("mpich")')
disp( pm.lib.mpi.vendor("mpich") )
disp("")
 
disp('pm.lib.mpi.vendor("unknown")')
disp( pm.lib.mpi.vendor("unknown") )

Example output ⛓

pm.lib.mpi.vendor("impi")
Intel
pm.lib.mpi.vendor("INTEL")
Intel
pm.lib.mpi.vendor("intel")
Intel
pm.lib.mpi.vendor("ompi")
OpenMPI
pm.lib.mpi.vendor("openmpi")
OpenMPI
pm.lib.mpi.vendor("open-mpi")
OpenMPI
pm.lib.mpi.vendor("mpich")
MPICH
pm.lib.mpi.vendor("unknown")
MPI

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.

Copyright

Computational Data Science Lab

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