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

Go to the source code of this file.

Functions

function cite (in format)
 Return a scalar MATLAB raw string or HTML-style hyperlink containing the weblink to ParaMonte library publications. More...
 

Function Documentation

◆ cite()

function cite ( in  format)

Return a scalar MATLAB raw string or HTML-style hyperlink containing the weblink to ParaMonte library publications.

Parameters
[in]format: The input scalar MATLAB string indicating the format of the output we address.
  1. An input value of "raw" will return a raw web address.
  2. An input value of "html" will return an HTML style web address.
(optional, default = "html")
Returns
str : The output scalar MATLAB string containing either,
  1. a raw weblink to the ParaMonte library publications if the library is used outside the MATLAB GUI interface, or,
  2. an HTML-style hyperlink to the ParaMonte library publications if the library is used within the MATLAB GUI interface.


Possible calling interfaces ⛓

str = pm.lib.cite()
str = pm.lib.cite(format)


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("")
5disp('pm.lib.cite()')
6disp( pm.lib.cite() )
7
8disp("")
9disp('pm.lib.cite([])')
10disp( pm.lib.cite([]) )
11
12disp("")
13disp('pm.lib.cite("html")')
14disp( pm.lib.cite("html") )
15
16disp("")
17disp('pm.lib.cite("raw")')
18disp( pm.lib.cite("raw") )
cite
function cite(in format)
Return a scalar MATLAB raw string or HTML-style hyperlink containing the weblink to ParaMonte library...
lib
function lib()
Return a scalar MATLAB string containing the path to the lib directory of the ParaMonte library packa...
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1pm.lib.cite()
2https://www.cdslab.org/paramonte/generic/latest/overview/preface/#how-to-acknowledge-the-use-of-the-paramonte-library-in-your-work
3pm.lib.cite([])
4https://www.cdslab.org/paramonte/generic/latest/overview/preface/#how-to-acknowledge-the-use-of-the-paramonte-library-in-your-work
5pm.lib.cite("html")
6https://www.cdslab.org/paramonte/generic/latest/overview/preface/#how-to-acknowledge-the-use-of-the-paramonte-library-in-your-work
7pm.lib.cite("raw")
8https://www.cdslab.org/paramonte/generic/latest/overview/preface/#how-to-acknowledge-the-use-of-the-paramonte-library-in-your-work


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, 8:05 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