ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
FileContentsSampleDRAM.m
Go to the documentation of this file.
1%> \brief
2%> This is the base class for generating objects
3%> that contain the contents of a sample/chain file
4%> generated by a ParaMonte sampler.<br>
5%> This class is meant to be primarily internally
6%> used by the ParaMonte MATLAB library samplers.<br>
7%>
8%> \note
9%> See the documentation of the class constructor
10%> [pm.sampling.FileContentsSampleDRAM::FileContentsSampleDRAM](@ref FileContentsSampleDRAM::FileContentsSampleDRAM).<br>
11%>
12%> \note
13%> See below for information on the methods.<br>
14%>
15%> \note
16%> See also the documentation of the superclass [pm.sampling.FileContentsSample](@ref FileContentsSample).<br>
17%>
18%> \final{FileContentsSampleDRAM}
19%>
20%> \author
21%> \JoshuaOsborne, May 21 2024, 3:32 AM, University of Texas at Arlington<br>
22%> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
23%> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
24classdef FileContentsSampleDRAM < pm.sampling.FileContentsSample
25
26 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27
28 properties(Access = public)
29 end
30
31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32
33 properties(Hidden)
34 end
35
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37
38 methods(Access = public)
39
40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
41
42 %> \brief
43 %> Return a scalar object of class [pm.sampling.FileContentsSampleDRAM](@ref FileContentsSampleDRAM).<br>
44 %> This is the constructor of the class [pm.sampling.FileContentsSampleDRAM](@ref FileContentsSampleDRAM).<br>
45 %>
46 %> \param[in] file : The input scalar MATLAB string containing the path to an external file.<br>
47 %> \param[in] silent : See the corresponding argument of [pm.sampling.FileContentsRestart](@ref FileContentsRestart) class.<br>
48 %> (**optional**. The default is set by [pm.sampling.FileContentsRestart](@ref FileContentsRestart).)
49 %> \param[in] sep : The input scalar MATLAB string containing the field separator used in the file.<br>
50 %> (**optional**, default = ``","``)
51 %>
52 %> \return
53 %> ``self`` : The output scalar object of class [pm.sampling.FileContentsSampleDRAM](@ref FileContentsSampleDRAM).<br>
54 %>
55 %> \interface{FileContentsSampleDRAM}
56 %> \code{.m}
57 %>
58 %> contents = pm.sampling.FileContentsSampleDRAM(file)
59 %> contents = pm.sampling.FileContentsSampleDRAM(file, [])
60 %> contents = pm.sampling.FileContentsSampleDRAM(file, silent)
61 %> contents = pm.sampling.FileContentsSampleDRAM(file, [], [])
62 %> contents = pm.sampling.FileContentsSampleDRAM(file, [], sep)
63 %> contents = pm.sampling.FileContentsSampleDRAM(file, silent, [])
64 %> contents = pm.sampling.FileContentsSampleDRAM(file, silent, sep)
65 %>
66 %> \endcode
67 %>
68 %> \example{FileContentsSampleDRAM}
69 %> \include{lineno} example/sampling/FileContentsSampleDRAM/main.m
70 %> \vis{FileContentsSampleDRAM}
71 %> <br><br>
72 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour.1.png width=700
73 %> <br><br>
74 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour.2.png width=700
75 %> <br><br>
76 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour.3.png width=700
77 %> <br><br>
78 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour3.1.png width=700
79 %> <br><br>
80 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour3.2.png width=700
81 %> <br><br>
82 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contour3.3.png width=700
83 %> <br><br>
84 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contourf.1.png width=700
85 %> <br><br>
86 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contourf.2.png width=700
87 %> <br><br>
88 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.contourf.3.png width=700
89 %> <br><br>
90 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histfit.1.png width=700
91 %> <br><br>
92 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histfit.2.png width=700
93 %> <br><br>
94 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histfit.3.png width=700
95 %> <br><br>
96 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram.1.png width=700
97 %> <br><br>
98 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram.2.png width=700
99 %> <br><br>
100 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram.3.png width=700
101 %> <br><br>
102 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram2.1.png width=700
103 %> <br><br>
104 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram2.2.png width=700
105 %> <br><br>
106 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.histogram2.3.png width=700
107 %> <br><br>
108 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line.1.png width=700
109 %> <br><br>
110 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line.2.png width=700
111 %> <br><br>
112 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line.3.png width=700
113 %> <br><br>
114 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line3.1.png width=700
115 %> <br><br>
116 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line3.2.png width=700
117 %> <br><br>
118 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.line3.3.png width=700
119 %> <br><br>
120 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter.1.png width=700
121 %> <br><br>
122 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter.2.png width=700
123 %> <br><br>
124 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter.3.png width=700
125 %> <br><br>
126 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter3.1.png width=700
127 %> <br><br>
128 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter3.2.png width=700
129 %> <br><br>
130 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.lineScatter3.3.png width=700
131 %> <br><br>
132 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter.1.png width=700
133 %> <br><br>
134 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter.2.png width=700
135 %> <br><br>
136 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter.3.png width=700
137 %> <br><br>
138 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter3.1.png width=700
139 %> <br><br>
140 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter3.2.png width=700
141 %> <br><br>
142 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.cascade.scatter3.3.png width=700
143 %> <br><br>
144 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.contour.png width=700
145 %> <br><br>
146 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.contour3.png width=700
147 %> <br><br>
148 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.contourf.png width=700
149 %> <br><br>
150 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.histfit.png width=700
151 %> <br><br>
152 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.histogram.png width=700
153 %> <br><br>
154 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.histogram2.png width=700
155 %> <br><br>
156 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.line.png width=700
157 %> <br><br>
158 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.line3.png width=700
159 %> <br><br>
160 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.lineScatter.png width=700
161 %> <br><br>
162 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.lineScatter3.png width=700
163 %> <br><br>
164 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.scatter.png width=700
165 %> <br><br>
166 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.plot.scatter3.png width=700
167 %> <br><br>
168 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.contour.png width=700
169 %> <br><br>
170 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.contour3.png width=700
171 %> <br><br>
172 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.contourf.png width=700
173 %> <br><br>
174 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.histfit.png width=700
175 %> <br><br>
176 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.histogram.png width=700
177 %> <br><br>
178 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.histogram2.png width=700
179 %> <br><br>
180 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.line.png width=700
181 %> <br><br>
182 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.line3.png width=700
183 %> <br><br>
184 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.lineScatter.png width=700
185 %> <br><br>
186 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.lineScatter3.png width=700
187 %> <br><br>
188 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.scatter.png width=700
189 %> <br><br>
190 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.tile.scatter3.png width=700
191 %> <br><br>
192 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.triplex.lshc2.png width=700
193 %> <br><br>
194 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.triplex.lshc3.png width=700
195 %> <br><br>
196 %> \image html example/sampling/FileContentsSampleDRAM/FileContentsSampleDRAM.triplex.lshcf.png width=700
197 %>
198 %> \final{FileContentsSampleDRAM}
199 %>
200 %> \author
201 %> \AmirShahmoradi, 7:41 PM Friday, November 8, 2024, Dallas, TX<br>
202 %> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
203 function self = FileContentsSampleDRAM(file, silent, sep)
204
205 if nargin < 3
206 sep = [];
207 end
208 if nargin < 2
209 silent = [];
210 end
211
212 self = self@pm.sampling.FileContentsSample(file, silent, sep);
213 self.setstats();
214 self.setvis();
215
216 end
217
218 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
219
220 end
221
222 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
223
224end
FileContentsRestart
This is the base class for generating objects that contain the contents of a restart file generated b...
Definition: FileContentsRestart.m:27
FileContentsSampleDRAM
This is the base class for generating objects that contain the contents of a sample/chain file genera...
Definition: FileContentsSampleDRAM.m:25
FileContentsSampleDRAM::FileContentsSampleDRAM
function FileContentsSampleDRAM(in file, in silent, in sep)
Return a scalar object of class pm.sampling.FileContentsSampleDRAM. This is the constructor of the c...
FileContentsSample
This is the base class for generating objects that contain the contents of a sample/chain file genera...
Definition: FileContentsSample.m:23