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

Go to the source code of this file.

Functions

function isgui ()
 Return a scalar MATLAB logical true if and only if the current environment is the MATLAB Graphical User Interface (GUI), otherwise, return false implying that MATLAB engine is active without the GUI (e.g., called from the system shell command line). More...
 

Function Documentation

◆ isgui()

function isgui ( )

Return a scalar MATLAB logical true if and only if the current environment is the MATLAB Graphical User Interface (GUI), otherwise, return false implying that MATLAB engine is active without the GUI (e.g., called from the system shell command line).

This functionality is important for certain library features that require MATLAB GUI.

Warning
This function relies on functionalities that are supported only in MATLAB > 2019a.
Returns
itis : The output scalar MATLAB logical that is true if and only if ParaMonte MATLAB library is being called from MATLAB Graphical User Interface (GUI), otherwise, false.


Possible calling interfaces ⛓

itis = pm.matlab.isgui()


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
4pm.matlab.show('pm.matlab.isgui()')
5pm.matlab.show( pm.matlab.isgui() )
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1pm.matlab.isgui()
2 0


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, 11:39 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