133 lines
12 KiB
HTML
133 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>fourdst::libcomposition: Class List</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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<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>
|
|
<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! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">fourdst::libcomposition<span id="projectnumber"> v2.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">Robust atomic species information library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(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">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Class List</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
|
|
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst.html" target="_self">fourdst</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1atomic.html" target="_self">atomic</a></td><td class="desc">Contains canonical information about atomic species and elements used by 4D-STAR </td></tr>
|
|
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1atomic_1_1Species.html" target="_self">Species</a></td><td class="desc">Represents an atomic species (isotope) with its fundamental physical properties </td></tr>
|
|
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition.html" target="_self">composition</a></td><td class="desc">Utilities and types for representing and manipulating chemical compositions </td></tr>
|
|
<tr id="row_0_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_0_1_0_" class="arrow" onclick="toggleFolder('0_1_0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition_1_1exceptions.html" target="_self">exceptions</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_0_0_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html" target="_self">CompositionError</a></td><td class="desc">Base class for exceptions related to composition objects </td></tr>
|
|
<tr id="row_0_1_0_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1InvalidCompositionError.html" target="_self">InvalidCompositionError</a></td><td class="desc">Exception thrown when a composition is in an invalid or inconsistent state </td></tr>
|
|
<tr id="row_0_1_0_2_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html" target="_self">SpeciesError</a></td><td class="desc">Base class for exceptions related to atomic species </td></tr>
|
|
<tr id="row_0_1_0_3_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1UnknownSymbolError.html" target="_self">UnknownSymbolError</a></td><td class="desc">Exception thrown when an unknown symbol is encountered </td></tr>
|
|
<tr id="row_0_1_0_4_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1UnregisteredSymbolError.html" target="_self">UnregisteredSymbolError</a></td><td class="desc">Exception thrown when a symbol is used that has not been registered </td></tr>
|
|
<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_0_1_1_" class="arrow" onclick="toggleFolder('0_1_1_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition_1_1utils.html" target="_self">utils</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_1_0_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1utils_1_1CompositionHash.html" target="_self">CompositionHash</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1CanonicalComposition.html" target="_self">CanonicalComposition</a></td><td class="desc">Represents the canonical (X, Y, Z) composition of stellar material </td></tr>
|
|
<tr id="row_0_1_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_0_1_3_" class="arrow" onclick="toggleFolder('0_1_3_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1Composition.html" target="_self">Composition</a></td><td class="desc">Manages a collection of chemical species and their abundances </td></tr>
|
|
<tr id="row_0_1_3_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html" target="_self">CompositionCache</a></td><td class="desc">Caches computed properties of the composition to avoid redundant calculations </td></tr>
|
|
<tr id="row_0_1_4_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1CompositionAbstract.html" target="_self">CompositionAbstract</a></td><td class="desc">Abstract base class for chemical composition representations </td></tr>
|
|
<tr id="row_0_1_5_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1CompositionDecorator.html" target="_self">CompositionDecorator</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_6_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1MaskedComposition.html" target="_self">MaskedComposition</a></td><td class="desc"></td></tr>
|
|
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacestd.html" target="_self">std</a></td><td class="desc">STL namespace </td></tr>
|
|
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1atomic_1_1Species_01_4.html" target="_self">hash< fourdst::atomic::Species ></a></td><td class="desc">Specialization of <code>std::hash</code> for <code><a class="el" href="structfourdst_1_1atomic_1_1Species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">fourdst::atomic::Species</a></code> </td></tr>
|
|
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1composition_1_1Composition_01_4.html" target="_self">hash< fourdst::composition::Composition ></a></td><td class="desc"></td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|