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 library directories.


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 docs: [1x1 struct]
6 github: [1x1 struct]
7 external: [1x1 struct]
8
9
10pm.matlab.show(weblinks)
11weblinks.docs.url
12https://www.cdslab.org/paramonte
13weblinks.docs.generic.url
14https://www.cdslab.org/paramonte/generic/2
15weblinks.docs.generic.overview.url
16https://www.cdslab.org/paramonte/generic/2/overview
17weblinks.docs.generic.overview.preface.url
18https://www.cdslab.org/paramonte/generic/2/overview/preface
19weblinks.docs.generic.overview.fortran.url
20https://www.cdslab.org/paramonte/generic/2/overview/paramonte-kernel-release-notes
21weblinks.docs.generic.overview.matlab.url
22https://www.cdslab.org/paramonte/generic/2/overview/paramonte-matlab-release-notes
23weblinks.docs.generic.overview.python.url
24https://www.cdslab.org/paramonte/generic/2/overview/paramonte-python-release-notes
25weblinks.docs.generic.installation.url
26https://www.cdslab.org/paramonte/generic/2/installation
27weblinks.docs.generic.installation.linux.url
28https://www.cdslab.org/paramonte/generic/2/installation/linux
29weblinks.docs.generic.installation.windows.url
30https://www.cdslab.org/paramonte/generic/2/installation/windows
31weblinks.docs.generic.installation.matlab.url
32https://www.cdslab.org/paramonte/generic/2/installation/matlab
33weblinks.docs.generic.installation.python.url
34https://www.cdslab.org/paramonte/generic/2/installation/python
35weblinks.docs.generic.installation.macos.url
36https://www.cdslab.org/paramonte/generic/2/installation/macos
37weblinks.docs.generic.installation.macos.prereqs.url
38https://www.cdslab.org/paramonte/generic/2/installation/macos/#the-compile-time-and-runtime-prerequisites
39weblinks.docs.generic.installation.macos.prereqs.cmd.url
40https://www.cdslab.org/paramonte/generic/2/installation/macos/#prereqs-install
41weblinks.docs.generic.examples.url
42https://www.cdslab.org/paramonte/generic/2/examples
43weblinks.docs.generic.examples.python.jupyter.url
44https://www.cdslab.org/paramonte/generic/2/examples/python/jupyter
45weblinks.docs.generic.examples.python.postprocess.url
46https://www.cdslab.org/paramonte/generic/2/examples/python/postprocess
47weblinks.docs.generic.api.url
48https://www.cdslab.org/paramonte/generic/2/api
49weblinks.docs.generic.api.python.url
50https://www.cdslab.org/paramonte/generic/2/api/python/autoapi/paramonte
51weblinks.docs.generic.usage.url
52https://www.cdslab.org/paramonte/generic/2/usage
53weblinks.docs.generic.usage.paradram.url
54https://www.cdslab.org/paramonte/generic/2/usage/paradram
55weblinks.docs.generic.usage.paradram.quickstart.url
56https://www.cdslab.org/paramonte/generic/2/usage/paradram/interface
57weblinks.docs.generic.usage.paradram.input.url
58https://www.cdslab.org/paramonte/generic/2/usage/paradram/input
59weblinks.docs.generic.usage.paradram.specifications.url
60https://www.cdslab.org/paramonte/generic/2/usage/paradram/specifications
61weblinks.docs.generic.usage.paradram.restart.url
62https://www.cdslab.org/paramonte/generic/2/usage/paradram/restart
63weblinks.docs.generic.usage.paradram.output.url
64https://www.cdslab.org/paramonte/generic/2/usage/paradram/output
65weblinks.docs.matlab.url
66https://www.cdslab.org/paramonte/matlab/3
67weblinks.github.url
68https://github.com/cdslaborg/paramonte
69weblinks.github.issues.url
70https://github.com/cdslaborg/paramonte/issues
71weblinks.github.releases.url
72https://github.com/cdslaborg/paramonte/releases
73weblinks.github.releases.latest.url
74https://github.com/cdslaborg/paramonte/releases/latest
75weblinks.github.releases.tag.url
76https://github.com/cdslaborg/paramonte/releases/tag
77weblinks.github.releases.tag.auxil.url
78https://github.com/cdslaborg/paramonte/releases/tag/auxil
79weblinks.github.releases.download.url
80https://github.com/cdslaborg/paramonte/releases/download
81weblinks.github.releases.download.auxil.url
82https://github.com/cdslaborg/paramonte/releases/download/auxil
83weblinks.github.archive.url
84https://github.com/cdslaborg/paramonte/archive
85weblinks.github.archive.main.zip.url
86https://github.com/cdslaborg/paramonte/archive/main.zip
87weblinks.github.archive.main.tar.url
88https://github.com/cdslaborg/paramonte/archive/main.tar.gz
89weblinks.github.examples.url
90https://github.com/cdslaborg/paramontex
91weblinks.external.intel.url
92https://software.intel.com/en-us
93weblinks.external.intel.mpi.url
94https://software.intel.com/en-us/mpi-library
95weblinks.external.openmpi.url
96https://www.open-mpi.org/
97
98pm.matlab.show(weblinks, [], true)
99weblinks.docs.url
100weblinks.docs.generic.url
101weblinks.docs.generic.overview.url
102weblinks.docs.generic.overview.preface.url
103weblinks.docs.generic.overview.fortran.url
104weblinks.docs.generic.overview.matlab.url
105weblinks.docs.generic.overview.python.url
106weblinks.docs.generic.installation.url
107weblinks.docs.generic.installation.linux.url
108weblinks.docs.generic.installation.windows.url
109weblinks.docs.generic.installation.matlab.url
110weblinks.docs.generic.installation.python.url
111weblinks.docs.generic.installation.macos.url
112weblinks.docs.generic.installation.macos.prereqs.url
113weblinks.docs.generic.installation.macos.prereqs.cmd.url
114weblinks.docs.generic.examples.url
115weblinks.docs.generic.examples.python.jupyter.url
116weblinks.docs.generic.examples.python.postprocess.url
117weblinks.docs.generic.api.url
118weblinks.docs.generic.api.python.url
119weblinks.docs.generic.usage.url
120weblinks.docs.generic.usage.paradram.url
121weblinks.docs.generic.usage.paradram.quickstart.url
122weblinks.docs.generic.usage.paradram.input.url
123weblinks.docs.generic.usage.paradram.specifications.url
124weblinks.docs.generic.usage.paradram.restart.url
125weblinks.docs.generic.usage.paradram.output.url
126weblinks.docs.matlab.url
127weblinks.github.url
128weblinks.github.issues.url
129weblinks.github.releases.url
130weblinks.github.releases.latest.url
131weblinks.github.releases.tag.url
132weblinks.github.releases.tag.auxil.url
133weblinks.github.releases.download.url
134weblinks.github.releases.download.auxil.url
135weblinks.github.archive.url
136weblinks.github.archive.main.zip.url
137weblinks.github.archive.main.tar.url
138weblinks.github.examples.url
139weblinks.external.intel.url
140weblinks.external.intel.mpi.url
141weblinks.external.openmpi.url
142
143pm.matlab.show(pm.lib.weblinks(), "weblinks", true)
144weblinks.docs.url
145weblinks.docs.generic.url
146weblinks.docs.generic.overview.url
147weblinks.docs.generic.overview.preface.url
148weblinks.docs.generic.overview.fortran.url
149weblinks.docs.generic.overview.matlab.url
150weblinks.docs.generic.overview.python.url
151weblinks.docs.generic.installation.url
152weblinks.docs.generic.installation.linux.url
153weblinks.docs.generic.installation.windows.url
154weblinks.docs.generic.installation.matlab.url
155weblinks.docs.generic.installation.python.url
156weblinks.docs.generic.installation.macos.url
157weblinks.docs.generic.installation.macos.prereqs.url
158weblinks.docs.generic.installation.macos.prereqs.cmd.url
159weblinks.docs.generic.examples.url
160weblinks.docs.generic.examples.python.jupyter.url
161weblinks.docs.generic.examples.python.postprocess.url
162weblinks.docs.generic.api.url
163weblinks.docs.generic.api.python.url
164weblinks.docs.generic.usage.url
165weblinks.docs.generic.usage.paradram.url
166weblinks.docs.generic.usage.paradram.quickstart.url
167weblinks.docs.generic.usage.paradram.input.url
168weblinks.docs.generic.usage.paradram.specifications.url
169weblinks.docs.generic.usage.paradram.restart.url
170weblinks.docs.generic.usage.paradram.output.url
171weblinks.docs.matlab.url
172weblinks.github.url
173weblinks.github.issues.url
174weblinks.github.releases.url
175weblinks.github.releases.latest.url
176weblinks.github.releases.tag.url
177weblinks.github.releases.tag.auxil.url
178weblinks.github.releases.download.url
179weblinks.github.releases.download.auxil.url
180weblinks.github.archive.url
181weblinks.github.archive.main.zip.url
182weblinks.github.archive.main.tar.url
183weblinks.github.examples.url
184weblinks.external.intel.url
185weblinks.external.intel.mpi.url
186weblinks.external.openmpi.url
187
188pm.matlab.show(pm.lib.weblinks(), "weblinks")
189weblinks.docs.url
190https://www.cdslab.org/paramonte
191weblinks.docs.generic.url
192https://www.cdslab.org/paramonte/generic/2
193weblinks.docs.generic.overview.url
194https://www.cdslab.org/paramonte/generic/2/overview
195weblinks.docs.generic.overview.preface.url
196https://www.cdslab.org/paramonte/generic/2/overview/preface
197weblinks.docs.generic.overview.fortran.url
198https://www.cdslab.org/paramonte/generic/2/overview/paramonte-kernel-release-notes
199weblinks.docs.generic.overview.matlab.url
200https://www.cdslab.org/paramonte/generic/2/overview/paramonte-matlab-release-notes
201weblinks.docs.generic.overview.python.url
202https://www.cdslab.org/paramonte/generic/2/overview/paramonte-python-release-notes
203weblinks.docs.generic.installation.url
204https://www.cdslab.org/paramonte/generic/2/installation
205weblinks.docs.generic.installation.linux.url
206https://www.cdslab.org/paramonte/generic/2/installation/linux
207weblinks.docs.generic.installation.windows.url
208https://www.cdslab.org/paramonte/generic/2/installation/windows
209weblinks.docs.generic.installation.matlab.url
210https://www.cdslab.org/paramonte/generic/2/installation/matlab
211weblinks.docs.generic.installation.python.url
212https://www.cdslab.org/paramonte/generic/2/installation/python
213weblinks.docs.generic.installation.macos.url
214https://www.cdslab.org/paramonte/generic/2/installation/macos
215weblinks.docs.generic.installation.macos.prereqs.url
216https://www.cdslab.org/paramonte/generic/2/installation/macos/#the-compile-time-and-runtime-prerequisites
217weblinks.docs.generic.installation.macos.prereqs.cmd.url
218https://www.cdslab.org/paramonte/generic/2/installation/macos/#prereqs-install
219weblinks.docs.generic.examples.url
220https://www.cdslab.org/paramonte/generic/2/examples
221weblinks.docs.generic.examples.python.jupyter.url
222https://www.cdslab.org/paramonte/generic/2/examples/python/jupyter
223weblinks.docs.generic.examples.python.postprocess.url
224https://www.cdslab.org/paramonte/generic/2/examples/python/postprocess
225weblinks.docs.generic.api.url
226https://www.cdslab.org/paramonte/generic/2/api
227weblinks.docs.generic.api.python.url
228https://www.cdslab.org/paramonte/generic/2/api/python/autoapi/paramonte
229weblinks.docs.generic.usage.url
230https://www.cdslab.org/paramonte/generic/2/usage
231weblinks.docs.generic.usage.paradram.url
232https://www.cdslab.org/paramonte/generic/2/usage/paradram
233weblinks.docs.generic.usage.paradram.quickstart.url
234https://www.cdslab.org/paramonte/generic/2/usage/paradram/interface
235weblinks.docs.generic.usage.paradram.input.url
236https://www.cdslab.org/paramonte/generic/2/usage/paradram/input
237weblinks.docs.generic.usage.paradram.specifications.url
238https://www.cdslab.org/paramonte/generic/2/usage/paradram/specifications
239weblinks.docs.generic.usage.paradram.restart.url
240https://www.cdslab.org/paramonte/generic/2/usage/paradram/restart
241weblinks.docs.generic.usage.paradram.output.url
242https://www.cdslab.org/paramonte/generic/2/usage/paradram/output
243weblinks.docs.matlab.url
244https://www.cdslab.org/paramonte/matlab/3
245weblinks.github.url
246https://github.com/cdslaborg/paramonte
247weblinks.github.issues.url
248https://github.com/cdslaborg/paramonte/issues
249weblinks.github.releases.url
250https://github.com/cdslaborg/paramonte/releases
251weblinks.github.releases.latest.url
252https://github.com/cdslaborg/paramonte/releases/latest
253weblinks.github.releases.tag.url
254https://github.com/cdslaborg/paramonte/releases/tag
255weblinks.github.releases.tag.auxil.url
256https://github.com/cdslaborg/paramonte/releases/tag/auxil
257weblinks.github.releases.download.url
258https://github.com/cdslaborg/paramonte/releases/download
259weblinks.github.releases.download.auxil.url
260https://github.com/cdslaborg/paramonte/releases/download/auxil
261weblinks.github.archive.url
262https://github.com/cdslaborg/paramonte/archive
263weblinks.github.archive.main.zip.url
264https://github.com/cdslaborg/paramonte/archive/main.zip
265weblinks.github.archive.main.tar.url
266https://github.com/cdslaborg/paramonte/archive/main.tar.gz
267weblinks.github.examples.url
268https://github.com/cdslaborg/paramontex
269weblinks.external.intel.url
270https://software.intel.com/en-us
271weblinks.external.intel.mpi.url
272https://software.intel.com/en-us/mpi-library
273weblinks.external.openmpi.url
274https://www.open-mpi.org/
275
276struct("key1", "val1", "Key2", "Val2"), "s"
277s.key1
278val1
279s.Key2
280Val2
281
282{"key1", 1, "key2", "val2"}, "mycell"
283mycell{1}
284key1
285mycell{2}
286 1
287mycell{3}
288key2
289mycell{4}
290val2
291
292vec
293[1, 2, 3, 4]
294vec
295 1 2 3 4
296
297"string", "str"
298str
299string
auxil
function auxil()
Return a scalar MATLAB string containing the path to the auxil directory of the ParaMonte library pac...
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.