tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-11 11:41:55 -04:00
parent 1e5938df0d
commit f0e1840c91
138 changed files with 18404 additions and 7317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

214
docs/html/class_metadata.html
View File

@@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>New 4DSSE Code: Metadata Class Reference</title>
<title>SERiF: Metadata Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -18,12 +18,9 @@
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
@@ -32,21 +29,10 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">New 4DSSE Code<span id="projectnumber">&#160;0.0.1a</span>
<div id="projectname">SERiF<span id="projectnumber">&#160;0.0.1a</span>
</div>
<div id="projectbrief">3+1D Stellar Structure and Evolution</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
@@ -104,6 +101,7 @@ $(function(){initNavTree('class_metadata.html',''); initResizable(true); });
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_metadata-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Metadata Class Reference</div></div>
@@ -117,9 +115,8 @@ $(function(){initNavTree('class_metadata.html',''); initResizable(true); });
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae849560667461008cb72e83919c20be0" id="r_ae849560667461008cb72e83919c20be0"><td class="memItemLeft" align="right" valign="top"><a id="ae849560667461008cb72e83919c20be0" name="ae849560667461008cb72e83919c20be0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Metadata</b> ()=default</td></tr>
<tr class="memdesc:ae849560667461008cb72e83919c20be0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a>. <br /></td></tr>
<tr class="memitem:ae849560667461008cb72e83919c20be0" id="r_ae849560667461008cb72e83919c20be0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae849560667461008cb72e83919c20be0">Metadata</a> ()=default</td></tr>
<tr class="memdesc:ae849560667461008cb72e83919c20be0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a>. <br /></td></tr>
<tr class="separator:ae849560667461008cb72e83919c20be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d56c8c5adee4b8c7d2089802211522b" id="r_a3d56c8c5adee4b8c7d2089802211522b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d56c8c5adee4b8c7d2089802211522b">Metadata</a> (std::size_t byteSize, std::string dataType, std::vector&lt; std::size_t &gt; dimensions, bool debugFlag=false)</td></tr>
<tr class="memdesc:a3d56c8c5adee4b8c7d2089802211522b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to initialize <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> with specific attributes. <br /></td></tr>
@@ -149,6 +146,21 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a365c4594ad65c3b10b40a1cf4f4aea26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the debugging flag. <br /></td></tr>
<tr class="separator:a365c4594ad65c3b10b40a1cf4f4aea26"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ac73a509797c98c0d52fb32e1f93e38bc" id="r_ac73a509797c98c0d52fb32e1f93e38bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac73a509797c98c0d52fb32e1f93e38bc">byteSize_</a> = 0</td></tr>
<tr class="memdesc:ac73a509797c98c0d52fb32e1f93e38bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total size of the data in bytes. <br /></td></tr>
<tr class="separator:ac73a509797c98c0d52fb32e1f93e38bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a290205e5f46416dd0f48bd6ff62888ac" id="r_a290205e5f46416dd0f48bd6ff62888ac"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a290205e5f46416dd0f48bd6ff62888ac">dataType_</a></td></tr>
<tr class="memdesc:a290205e5f46416dd0f48bd6ff62888ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of the data (e.g., "float", "double"). <br /></td></tr>
<tr class="separator:a290205e5f46416dd0f48bd6ff62888ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a163f74d4ef9ecd13a34e7e9cab2e21ce" id="r_a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a163f74d4ef9ecd13a34e7e9cab2e21ce">dimensions_</a></td></tr>
<tr class="memdesc:a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dimensions of the data (e.g., {3, 4} for a 3x4 matrix). <br /></td></tr>
<tr class="separator:a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65fd506f1bd41699d9cd19bc0dfc9701" id="r_a65fd506f1bd41699d9cd19bc0dfc9701"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65fd506f1bd41699d9cd19bc0dfc9701">debugFlag_</a> = false</td></tr>
<tr class="memdesc:a65fd506f1bd41699d9cd19bc0dfc9701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether debugging is enabled. <br /></td></tr>
<tr class="separator:a65fd506f1bd41699d9cd19bc0dfc9701"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a12949a1ea26c4ff1afeb97101c0493c5" id="r_a12949a1ea26c4ff1afeb97101c0493c5"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12949a1ea26c4ff1afeb97101c0493c5">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="class_metadata.html">Metadata</a> &amp;metadata)</td></tr>
@@ -158,9 +170,38 @@ Friends</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents metadata information for data objects in the dobj module. </p>
<p>The <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> class encapsulates details such as data size, type, dimensions, and optional debugging flags. It is designed to provide descriptive attributes in a lightweight and efficient manner. </p>
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00051">51</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae849560667461008cb72e83919c20be0" name="ae849560667461008cb72e83919c20be0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae849560667461008cb72e83919c20be0">&#9670;&#160;</a></span>Metadata() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Metadata::Metadata </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor for <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a>. </p>
</div>
</div>
<a id="a3d56c8c5adee4b8c7d2089802211522b" name="a3d56c8c5adee4b8c7d2089802211522b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d56c8c5adee4b8c7d2089802211522b">&#9670;&#160;</a></span>Metadata()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a3d56c8c5adee4b8c7d2089802211522b">&#9670;&#160;</a></span>Metadata() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -199,6 +240,8 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00040">40</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -230,6 +273,8 @@ Friends</h2></td></tr>
<p>The size is often required for memory allocation and validation in numerical routines.</p>
<dl class="section return"><dt>Returns</dt><dd>The total byte size of the data. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00050">50</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="aeed7f22ccc61d9a3d6425441d381dcdc" name="aeed7f22ccc61d9a3d6425441d381dcdc"></a>
@@ -260,6 +305,8 @@ Friends</h2></td></tr>
<p>The type (e.g., "float", "double") is critical for casting raw data or interfacing with libraries that require specific types.</p>
<dl class="section return"><dt>Returns</dt><dd>A string representing the data type. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00074">74</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="a412c0c0b8754d85f9edbbdcd637f3b20" name="a412c0c0b8754d85f9edbbdcd637f3b20"></a>
@@ -290,6 +337,8 @@ Friends</h2></td></tr>
<p>Dimensions define the shape of the data (e.g., 2D arrays, 3D matrices). This is essential for ensuring that operations (e.g., matrix multiplication) are performed correctly.</p>
<dl class="section return"><dt>Returns</dt><dd>A vector representing the size of each dimension. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00098">98</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="abe52c81e04665628666b4140cd346b69" name="abe52c81e04665628666b4140cd346b69"></a>
@@ -320,6 +369,8 @@ Friends</h2></td></tr>
<p>Debugging flags can be useful for tracking performance metrics or error provenance.</p>
<dl class="section return"><dt>Returns</dt><dd>True if debugging is enabled, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00120">120</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="a07035de7b0c780ef340e1a11c60a4d2b" name="a07035de7b0c780ef340e1a11c60a4d2b"></a>
@@ -360,6 +411,8 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00062">62</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="a88f4f57d443e2b7664e75e57a29dfbf0" name="a88f4f57d443e2b7664e75e57a29dfbf0"></a>
@@ -392,6 +445,8 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00086">86</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="a365c4594ad65c3b10b40a1cf4f4aea26" name="a365c4594ad65c3b10b40a1cf4f4aea26"></a>
@@ -432,6 +487,8 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00132">132</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<a id="af5264d1666839e69c192b565b5cfa606" name="af5264d1666839e69c192b565b5cfa606"></a>
@@ -464,6 +521,8 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00109">109</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
@@ -513,11 +572,118 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the output stream. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00146">146</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac73a509797c98c0d52fb32e1f93e38bc" name="ac73a509797c98c0d52fb32e1f93e38bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac73a509797c98c0d52fb32e1f93e38bc">&#9670;&#160;</a></span>byteSize_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Metadata::byteSize_ = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total size of the data in bytes. </p>
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00126">126</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
</div>
</div>
<a id="a290205e5f46416dd0f48bd6ff62888ac" name="a290205e5f46416dd0f48bd6ff62888ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a290205e5f46416dd0f48bd6ff62888ac">&#9670;&#160;</a></span>dataType_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Metadata::dataType_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of the data (e.g., "float", "double"). </p>
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00127">127</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
</div>
</div>
<a id="a65fd506f1bd41699d9cd19bc0dfc9701" name="a65fd506f1bd41699d9cd19bc0dfc9701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65fd506f1bd41699d9cd19bc0dfc9701">&#9670;&#160;</a></span>debugFlag_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Metadata::debugFlag_ = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether debugging is enabled. </p>
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00129">129</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
</div>
</div>
<a id="a163f74d4ef9ecd13a34e7e9cab2e21ce" name="a163f74d4ef9ecd13a34e7e9cab2e21ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a163f74d4ef9ecd13a34e7e9cab2e21ce">&#9670;&#160;</a></span>dimensions_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::size_t&gt; Metadata::dimensions_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dimensions of the data (e.g., {3, 4} for a 3x4 matrix). </p>
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00128">128</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/dobj/public/<a class="el" href="_metadata_8h_source.html">Metadata.h</a></li>
<li>src/dobj/private/<a class="el" href="_metadata_8cpp.html">Metadata.cpp</a></li>
<li>src/dobj/private/<a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->