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

Go to the source code of this file.

Functions

function choices ()
 Return the ParaMonte-preferred MPI library vendor name(s) as used in naming the ParaMonte MATLAB shared libraries in the order of preference on the current platform. More...
 

Function Documentation

◆ choices()

function choices ( )

Return the ParaMonte-preferred MPI library vendor name(s) as used in naming the ParaMonte MATLAB shared libraries in the order of preference on the current platform.

Returns
names : The output vector of MATLAB strings containing the the ParaMonte-preferred MPI library vendor names as used in naming the ParaMonte MATLAB shared libraries.


Possible calling interfaces ⛓

names = pm.lib.mpi.choices()
Warning
Beware that this function only verifies the existence of the relevant MPI-parallel ParaMonte libraries on the system.
It does not detect the existence of the relevant MPI runtime library installations on the system.


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.choices()")
5disp( pm.lib.mpi.choices() )
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1pm.lib.mpi.choices()


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:18 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