Functions
function	version (in lang, in type)
	Return a scalar MATLAB string containing the current ParaMonte generic or MATLAB library version numbers, or optionally, the major, minor, or the patch version number. More...

Function Documentation

◆ version()

function version	(	in	lang,
		in	type
	)

Return a scalar MATLAB string containing the current ParaMonte generic or MATLAB library version numbers, or optionally, the major, minor, or the patch version number.

Parameters

[in]	lang	: The input scalar MATLAB string that can be either: the value `"generic"`, indicating the generic library version found in the root directory of the ParaMonte library repository. the value `"matlab"`, indicating the MATLAB library version found in the `src/matlab` subdirectory in the ParaMonte library repository. The input version must be in triplet format (e.g., `"1.2.3"`). If the input value is empty `[]`, the default value is used. (optional, default = `"matlab"`)
[in]	type	: The input scalar MATLAB string that can be either: the value `"all"`, indicating the full version number output in the format `"major.minor.patch"`. the value `"major"`, indicating the full version number output in the format `"major"`. the value `"minor"`, indicating the full version number output in the format `"minor"`. the value `"patch"`, indicating the full version number output in the format `"patch"`. If the input value is empty `[]`, the default value is used. (optional, default = `"all"`)

Returns: vernum : The output scalar MATLAB string containing the requested current generic or language-specific ParaMonte library version.

Possible calling interfaces ⛓

: vernum = pm.lib.version()

vernum = pm.lib.version([])

vernum = pm.lib.version(lang)

vernum = pm.lib.version([], [])

vernum = pm.lib.version([], type)

vernum = pm.lib.version(lang, [])

vernum = pm.lib.version(lang, type)

Warning: If the routine fails to find the respective VERSION files within the local ParaMonte library, it will return the value "UNKNOWN" for the output vernum.

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()

5pm.matlab.show('pm.lib.version()')

6pm.matlab.show( pm.lib.version() )

7

8pm.matlab.show()

9pm.matlab.show('pm.lib.version("matlab")')

10pm.matlab.show( pm.lib.version("matlab") )

11

12pm.matlab.show()

13pm.matlab.show('pm.lib.version("generic")')

14pm.matlab.show( pm.lib.version("generic") )

15

16pm.matlab.show()

17

18pm.matlab.show()

19pm.matlab.show('pm.lib.version([], "major")')

20pm.matlab.show( pm.lib.version([], "major") )

21

22pm.matlab.show()

23pm.matlab.show('pm.lib.version([], "minor")')

24pm.matlab.show( pm.lib.version([], "minor") )

25

26pm.matlab.show()

27pm.matlab.show('pm.lib.version([], "patch")')

28pm.matlab.show( pm.lib.version([], "patch") )

29

30pm.matlab.show()

31

32pm.matlab.show()

33pm.matlab.show('pm.lib.version("matlab", "major")')

34pm.matlab.show( pm.lib.version("matlab", "major") )

35

36pm.matlab.show()

37pm.matlab.show('pm.lib.version("matlab", "minor")')

38pm.matlab.show( pm.lib.version("matlab", "minor") )

39

40pm.matlab.show()

41pm.matlab.show('pm.lib.version("matlab", "patch")')

42pm.matlab.show( pm.lib.version("matlab", "patch") )

43

44pm.matlab.show()

45

46pm.matlab.show()

47pm.matlab.show('pm.lib.version("generic", "major")')

48pm.matlab.show( pm.lib.version("generic", "major") )

49

50pm.matlab.show()

51pm.matlab.show('pm.lib.version("generic", "minor")')

52pm.matlab.show( pm.lib.version("generic", "minor") )

53

54pm.matlab.show()

55pm.matlab.show('pm.lib.version("generic", "patch")')

56pm.matlab.show( pm.lib.version("generic", "patch") )

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1

2pm.lib.version()

33.0.0

4

5pm.lib.version("matlab")

63.0.0

7

8pm.lib.version("generic")

92.0.0

10

11

12pm.lib.version([], "major")

133

14

15pm.lib.version([], "minor")

160

17

18pm.lib.version([], "patch")

190

20

21

22pm.lib.version("matlab", "major")

233

24

25pm.lib.version("matlab", "minor")

260

27

28pm.lib.version("matlab", "patch")

290

30

31

32pm.lib.version("generic", "major")

332

34

35pm.lib.version("generic", "minor")

360

37

38pm.lib.version("generic", "patch")

390

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.

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.
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:13 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

Functions

Function Documentation

◆ version()