ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
TileHistfit.m
Go to the documentation of this file.
1%> \brief
2%> This is the [pm.vis.TileHistfit](@ref TileHistfit) class for generating
3%> instances of 1-dimensional Histfit [Tile visualizations](@ref Tile)
4%> based on the relevant MATLAB intrinsic functions.<br>
5%>
6%> \see
7%> [pm.vis.Cascade](@ref Cascade)<br>
8%> [pm.vis.Subplot](@ref Subplot)<br>
9%> [pm.vis.Triplex](@ref Triplex)<br>
10%> [pm.vis.Figure](@ref Figure)<br>
11%> [pm.vis.Plot](@ref Plot)<br>
12%> [pm.vis.Tile](@ref Tile)<br>
13%>
14%> \final
15%>
16%> \author
17%> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
18%> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
19classdef TileHistfit < pm.vis.Tile
20
21 methods(Access = public)
22
23 %> \brief
24 %> Construct and return an object of class [pm.vis.TileHistfit](@ref TileHistfit).<br>
25 %>
26 %> \details
27 %> This is the constructor of the class [pm.vis.TileHistfit](@ref TileHistfit).<br>
28 %>
29 %> \param[in] dfref : See the documentation of the corresponding input
30 %> argument of the class [pm.vis.Subplot](@ref Subplot).<br>
31 %> \param[in] varargin : Any ``property, value`` pair of the parent object.<br>
32 %> If the property is a ``struct()``, then its value must be given as a cell array,
33 %> with consecutive elements representing the struct ``property-name, property-value`` pairs.<br>
34 %> Note that all of these property-value pairs can be also directly set via the
35 %> parent object attributes, before calling the ``make()`` method.<br>
36 %>
37 %> \return
38 %> ``self`` : An object of [pm.vis.TileHistfit](@ref TileHistfit) class.<br>
39 %>
40 %> \interface{TileHistfit}
41 %> \code{.m}
42 %>
43 %> t = pm.vis.TileHistfit(dfref);
44 %> t = pm.vis.TileHistfit(dfref, varargin);
45 %>
46 %> \endcode
47 %>
48 %> \note
49 %> See the documentation of the attributes
50 %> of the superclass [pm.vis.Tile](@ref Tile).<br>
51 %>
52 %> \note
53 %> The input ``varargin`` can also contain the components
54 %> of the ``subplot`` component of the parent object.<br>
55 %>
56 %> \final{TileHistfit}
57 %>
58 %> \author
59 %> \JoshuaOsborne, May 22 2024, 7:22 PM, University of Texas at Arlington<br>
60 %> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
61 %> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
62 function self = TileHistfit(dfref, varargin)
63 if nargin < 1
64 dfref = [];
65 end
66 self = self@pm.vis.Tile(pm.vis.SubplotHistfit(dfref), varargin{:});
67 end
68
69 end
70
71end
function name(in vendor)
Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories.
This is the abstract class for generating instances of objects that contain the specifications of a c...
Definition: Cascade.m:32
This is the abstract class for generating instances of objects that contain the specifications of var...
Definition: Figure.m:27
This is the base class for generating instances of objects that contain the specifications of various...
Definition: Plot.m:29
This is the abstract class for generating instances of axes with various types of plots from one or m...
Definition: Subplot.m:188
This is the pm.vis.TileHistfit class for generating instances of 1-dimensional Histfit Tile visualiza...
Definition: TileHistfit.m:20
function TileHistfit(in dfref, in varargin)
Construct and return an object of class pm.vis.TileHistfit.
This is the abstract class for generating instances of objects that contain the specifications of var...
Definition: Tile.m:23
This is the base class for generating instances of figures containing a square symmetric tiling of su...
Definition: Triplex.m:31