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

Go to the source code of this file.

Functions

function show (in obj, in name, in hidden)
 Display the components of an input MATLAB variable on MATLAB Console recursively. More...
 

Variables

 excluded
 

Function Documentation

◆ show()

function show ( in  obj,
in  name,
in  hidden 
)

Display the components of an input MATLAB variable on MATLAB Console recursively.

This function is particularly useful for displaying the hierarchical contents of a MATLAB struct or cell object.

Parameters
[in]obj: The input variable whose contents are to be displayed on MATLAB Console.
  1. If the input obj is a MATLAB struct, the function will recursively show the obj name, its fieldnames, and their contents.
  2. If the input obj is a cell array, the contents of each cell are displayed.
(optional. default = [], effectively adding a new line to the command line.)
[in]name: The input scalar MATLAB string, representing the actual name of the input obj.
(optional. If missing, the obj variable name from the caller workspace is used.)
[in]hidden: The input scalar MATLAB logical.
If true, then the contents of the input struct will not be shown, only the field names.
(optional, default = false)


Possible calling interfaces ⛓

pm.matlab.show();
pm.matlab.show([]);
pm.matlab.show(obj);
pm.matlab.show(obj, name);
pm.matlab.show(obj, [], hidden);
pm.matlab.show(obj, name, hidden);
name
function name(in vendor)
Return the MPI library name as used in naming the ParaMonte MATLAB shared libraries.


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('weblinks = pm.lib.weblinks()')
5 weblinks = pm.lib.weblinks()
6pm.matlab.show()
7
8pm.matlab.show()
9pm.matlab.show('pm.matlab.show(weblinks)')
10 pm.matlab.show(weblinks)
11
12pm.matlab.show()
13pm.matlab.show('pm.matlab.show(weblinks, [], true)')
14 pm.matlab.show(weblinks, [], true)
15
16pm.matlab.show()
17pm.matlab.show('pm.matlab.show(pm.lib.weblinks(), "weblinks", true)')
18 pm.matlab.show(pm.lib.weblinks(), "weblinks", true)
19
20pm.matlab.show()
21pm.matlab.show('pm.matlab.show(pm.lib.weblinks(), "weblinks")')
22 pm.matlab.show(pm.lib.weblinks(), "weblinks")
23
24pm.matlab.show()
25pm.matlab.show('struct("key1", "val1", "Key2", "Val2"), "s"')
26pm.matlab.show( struct("key1", "val1", "Key2", "Val2"), "s" )
27
28pm.matlab.show()
29pm.matlab.show('{"key1", 1, "key2", "val2"}, "mycell"')
30pm.matlab.show( {"key1", 1, "key2", "val2"}, "mycell" )
31
32pm.matlab.show()
33pm.matlab.show('[1, 2, 3, 4]', "vec")
34pm.matlab.show( [1, 2, 3, 4] , "vec")
35
36pm.matlab.show()
37pm.matlab.show('"string", "str"')
38pm.matlab.show( "string", "str" )
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1weblinks = pm.lib.weblinks()
2weblinks =
3 struct with fields:
4
5 home: [1x1 struct]
6 github: [1x1 struct]
7 intel: [1x1 struct]
8 openmpi: [1x1 struct]
9
10
11pm.matlab.show(weblinks)
12weblinks.home.url
13https://www.cdslab.org/paramonte
14weblinks.home.install.linux.url
15https://www.cdslab.org/paramonte/notes/installation/linux
16weblinks.home.install.windows.url
17https://www.cdslab.org/paramonte/notes/installation/windows
18weblinks.home.install.matlab.url
19https://www.cdslab.org/paramonte/notes/installation/matlab
20weblinks.home.install.python.url
21https://www.cdslab.org/paramonte/notes/installation/python
22weblinks.home.install.macos.url
23https://www.cdslab.org/paramonte/notes/installation/macos
24weblinks.home.install.macos.prereqs.url
25https://www.cdslab.org/paramonte/notes/installation/macos/#the-compile-time-and-runtime-prerequisites
26weblinks.home.install.macos.prereqs.cmd.url
27https://www.cdslab.org/paramonte/notes/installation/macos/#prereqs-install
28weblinks.home.overview.preface.url
29https://www.cdslab.org/paramonte/notes/overview/preface
30weblinks.home.overview.changes.fortran.url
31https://www.cdslab.org/paramonte/notes/overview/paramonte-kernel-release-notes
32weblinks.home.overview.changes.python.url
33https://www.cdslab.org/paramonte/notes/overview/paramonte-python-release-notes
34weblinks.home.overview.changes.matlab.url
35https://www.cdslab.org/paramonte/notes/overview/paramonte-matlab-release-notes
36weblinks.home.examples.python.jupyter.url
37https://www.cdslab.org/paramonte/notes/examples/python/jupyter
38weblinks.home.examples.python.postprocess.url
39https://www.cdslab.org/paramonte/notes/examples/python/postprocess
40weblinks.home.api.python.url
41https://www.cdslab.org/paramonte/notes/api/python/autoapi/paramonte
42weblinks.home.usage.paradram.quickstart.url
43https://www.cdslab.org/paramonte/notes/usage/paradram/interface
44weblinks.home.usage.paradram.input.url
45https://www.cdslab.org/paramonte/notes/usage/paradram/input
46weblinks.home.usage.paradram.specifications.url
47https://www.cdslab.org/paramonte/notes/usage/paradram/specifications
48weblinks.home.usage.paradram.restart.url
49https://www.cdslab.org/paramonte/notes/usage/paradram/restart
50weblinks.home.usage.paradram.output.url
51https://www.cdslab.org/paramonte/notes/usage/paradram/output
52weblinks.github.url
53https://github.com/cdslaborg/paramonte
54weblinks.github.issues.url
55https://github.com/cdslaborg/paramonte/issues
56weblinks.github.release.url
57https://github.com/cdslaborg/paramonte/releases
58weblinks.github.release.latest.url
59https://github.com/cdslaborg/paramonte/releases/latest
60weblinks.github.archive.main.zip.url
61https://github.com/cdslaborg/paramonte/archive/main.zip
62weblinks.github.archive.main.tar.url
63https://github.com/cdslaborg/paramonte/archive/main.tar.gz
64weblinks.github.examples.url
65https://github.com/cdslaborg/paramontex
66weblinks.intel.mpi.home.url
67https://software.intel.com/en-us/mpi-library
68weblinks.intel.mpi.windows.url
69https://software.intel.com/en-us/get-started-with-mpi-for-windows
70weblinks.openmpi.home.url
71https://www.open-mpi.org/
72
73pm.matlab.show(weblinks, [], true)
74weblinks.home.url
75weblinks.home.install.linux.url
76weblinks.home.install.windows.url
77weblinks.home.install.matlab.url
78weblinks.home.install.python.url
79weblinks.home.install.macos.url
80weblinks.home.install.macos.prereqs.url
81weblinks.home.install.macos.prereqs.cmd.url
82weblinks.home.overview.preface.url
83weblinks.home.overview.changes.fortran.url
84weblinks.home.overview.changes.python.url
85weblinks.home.overview.changes.matlab.url
86weblinks.home.examples.python.jupyter.url
87weblinks.home.examples.python.postprocess.url
88weblinks.home.api.python.url
89weblinks.home.usage.paradram.quickstart.url
90weblinks.home.usage.paradram.input.url
91weblinks.home.usage.paradram.specifications.url
92weblinks.home.usage.paradram.restart.url
93weblinks.home.usage.paradram.output.url
94weblinks.github.url
95weblinks.github.issues.url
96weblinks.github.release.url
97weblinks.github.release.latest.url
98weblinks.github.archive.main.zip.url
99weblinks.github.archive.main.tar.url
100weblinks.github.examples.url
101weblinks.intel.mpi.home.url
102weblinks.intel.mpi.windows.url
103weblinks.openmpi.home.url
104
105pm.matlab.show(pm.lib.weblinks(), "weblinks", true)
106weblinks.home.url
107weblinks.home.install.linux.url
108weblinks.home.install.windows.url
109weblinks.home.install.matlab.url
110weblinks.home.install.python.url
111weblinks.home.install.macos.url
112weblinks.home.install.macos.prereqs.url
113weblinks.home.install.macos.prereqs.cmd.url
114weblinks.home.overview.preface.url
115weblinks.home.overview.changes.fortran.url
116weblinks.home.overview.changes.python.url
117weblinks.home.overview.changes.matlab.url
118weblinks.home.examples.python.jupyter.url
119weblinks.home.examples.python.postprocess.url
120weblinks.home.api.python.url
121weblinks.home.usage.paradram.quickstart.url
122weblinks.home.usage.paradram.input.url
123weblinks.home.usage.paradram.specifications.url
124weblinks.home.usage.paradram.restart.url
125weblinks.home.usage.paradram.output.url
126weblinks.github.url
127weblinks.github.issues.url
128weblinks.github.release.url
129weblinks.github.release.latest.url
130weblinks.github.archive.main.zip.url
131weblinks.github.archive.main.tar.url
132weblinks.github.examples.url
133weblinks.intel.mpi.home.url
134weblinks.intel.mpi.windows.url
135weblinks.openmpi.home.url
136
137pm.matlab.show(pm.lib.weblinks(), "weblinks")
138weblinks.home.url
139https://www.cdslab.org/paramonte
140weblinks.home.install.linux.url
141https://www.cdslab.org/paramonte/notes/installation/linux
142weblinks.home.install.windows.url
143https://www.cdslab.org/paramonte/notes/installation/windows
144weblinks.home.install.matlab.url
145https://www.cdslab.org/paramonte/notes/installation/matlab
146weblinks.home.install.python.url
147https://www.cdslab.org/paramonte/notes/installation/python
148weblinks.home.install.macos.url
149https://www.cdslab.org/paramonte/notes/installation/macos
150weblinks.home.install.macos.prereqs.url
151https://www.cdslab.org/paramonte/notes/installation/macos/#the-compile-time-and-runtime-prerequisites
152weblinks.home.install.macos.prereqs.cmd.url
153https://www.cdslab.org/paramonte/notes/installation/macos/#prereqs-install
154weblinks.home.overview.preface.url
155https://www.cdslab.org/paramonte/notes/overview/preface
156weblinks.home.overview.changes.fortran.url
157https://www.cdslab.org/paramonte/notes/overview/paramonte-kernel-release-notes
158weblinks.home.overview.changes.python.url
159https://www.cdslab.org/paramonte/notes/overview/paramonte-python-release-notes
160weblinks.home.overview.changes.matlab.url
161https://www.cdslab.org/paramonte/notes/overview/paramonte-matlab-release-notes
162weblinks.home.examples.python.jupyter.url
163https://www.cdslab.org/paramonte/notes/examples/python/jupyter
164weblinks.home.examples.python.postprocess.url
165https://www.cdslab.org/paramonte/notes/examples/python/postprocess
166weblinks.home.api.python.url
167https://www.cdslab.org/paramonte/notes/api/python/autoapi/paramonte
168weblinks.home.usage.paradram.quickstart.url
169https://www.cdslab.org/paramonte/notes/usage/paradram/interface
170weblinks.home.usage.paradram.input.url
171https://www.cdslab.org/paramonte/notes/usage/paradram/input
172weblinks.home.usage.paradram.specifications.url
173https://www.cdslab.org/paramonte/notes/usage/paradram/specifications
174weblinks.home.usage.paradram.restart.url
175https://www.cdslab.org/paramonte/notes/usage/paradram/restart
176weblinks.home.usage.paradram.output.url
177https://www.cdslab.org/paramonte/notes/usage/paradram/output
178weblinks.github.url
179https://github.com/cdslaborg/paramonte
180weblinks.github.issues.url
181https://github.com/cdslaborg/paramonte/issues
182weblinks.github.release.url
183https://github.com/cdslaborg/paramonte/releases
184weblinks.github.release.latest.url
185https://github.com/cdslaborg/paramonte/releases/latest
186weblinks.github.archive.main.zip.url
187https://github.com/cdslaborg/paramonte/archive/main.zip
188weblinks.github.archive.main.tar.url
189https://github.com/cdslaborg/paramonte/archive/main.tar.gz
190weblinks.github.examples.url
191https://github.com/cdslaborg/paramontex
192weblinks.intel.mpi.home.url
193https://software.intel.com/en-us/mpi-library
194weblinks.intel.mpi.windows.url
195https://software.intel.com/en-us/get-started-with-mpi-for-windows
196weblinks.openmpi.home.url
197https://www.open-mpi.org/
198
199struct("key1", "val1", "Key2", "Val2"), "s"
200s.key1
201val1
202s.Key2
203Val2
204
205{"key1", 1, "key2", "val2"}, "mycell"
206mycell{1}
207key1
208mycell{2}
209 1
210mycell{3}
211key2
212mycell{4}
213val2
214
215vec
216[1, 2, 3, 4]
217vec
218 1 2 3 4
219
220"string", "str"
221str
222string
home
function home()
Return a MATLAB string containing the absolute path to the system home directory.
release
function release(in type)
Return a scalar MATLAB string containing the MATLAB release version, year, or season as requested.
show
function show(in obj, in name, in hidden)
Display the components of an input MATLAB variable on MATLAB Console recursively.


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

Variable Documentation

◆ excluded

excluded

Definition at line 172 of file show.m.