tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
30da87c74c2b99a0983cb7061d1406d2352132d0
libcomposition/docs/html/classfourdst_1_1composition_1_1_masked_composition.html

1268 lines
79 KiB
HTML
Raw Blame History

<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fourdst::libcomposition: fourdst::composition::MaskedComposition 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">&#160;v2.4.9</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<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&amp;dn=expat.txt MIT */
$(function(){initNavTree('classfourdst_1_1composition_1_1_masked_composition.html',''); initResizable(true); });
/* @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="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classfourdst_1_1composition_1_1_masked_composition-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">fourdst::composition::MaskedComposition Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for fourdst::composition::MaskedComposition:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classfourdst_1_1composition_1_1_masked_composition__inherit__graph.svg" width="171" height="230"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fourdst::composition::MaskedComposition:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classfourdst_1_1composition_1_1_masked_composition__coll__graph.svg" width="100%" height="461"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afe3129b1dbebfbe0578c3a555aa742bf" id="r_afe3129b1dbebfbe0578c3a555aa742bf"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;false&gt;</td></tr>
<tr class="separator:afe3129b1dbebfbe0578c3a555aa742bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd2bbf05d4f5fce5a1146619a0b16b6d" id="r_acd2bbf05d4f5fce5a1146619a0b16b6d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">const_iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;true&gt;</td></tr>
<tr class="separator:acd2bbf05d4f5fce5a1146619a0b16b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classfourdst_1_1composition_1_1_composition_abstract"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_classfourdst_1_1composition_1_1_composition_abstract')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">fourdst::composition::CompositionAbstract</a></td></tr>
<tr class="memitem:abd12f3a9a5b6217498ff19e25ee3ddb0 inherit pub_types_classfourdst_1_1composition_1_1_composition_abstract" id="r_abd12f3a9a5b6217498ff19e25ee3ddb0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;false&gt;</td></tr>
<tr class="separator:abd12f3a9a5b6217498ff19e25ee3ddb0 inherit pub_types_classfourdst_1_1composition_1_1_composition_abstract"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bb9772bc73d637950b6cf2e8e6afeb0 inherit pub_types_classfourdst_1_1composition_1_1_composition_abstract" id="r_a0bb9772bc73d637950b6cf2e8e6afeb0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;true&gt;</td></tr>
<tr class="separator:a0bb9772bc73d637950b6cf2e8e6afeb0 inherit pub_types_classfourdst_1_1composition_1_1_composition_abstract"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a9a0d839e4534494b7adaf353d56e5375" id="r_a9a0d839e4534494b7adaf353d56e5375"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a0d839e4534494b7adaf353d56e5375">MaskedComposition</a> (const <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &amp;baseComposition, const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp;activeSpecies)</td></tr>
<tr class="separator:a9a0d839e4534494b7adaf353d56e5375"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a045cfdf1e771895df872a6da61c53966" id="r_a045cfdf1e771895df872a6da61c53966"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a045cfdf1e771895df872a6da61c53966">contains</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;species) const noexcept override</td></tr>
<tr class="memdesc:a045cfdf1e771895df872a6da61c53966"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:a045cfdf1e771895df872a6da61c53966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83b73b24715d8a0fc29811653bb7c9a6" id="r_a83b73b24715d8a0fc29811653bb7c9a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a83b73b24715d8a0fc29811653bb7c9a6">contains</a> (const std::string &amp;symbol) const override</td></tr>
<tr class="memdesc:a83b73b24715d8a0fc29811653bb7c9a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:a83b73b24715d8a0fc29811653bb7c9a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44fddc3b8d34b76114afafbdc9b0ec6d" id="r_a44fddc3b8d34b76114afafbdc9b0ec6d"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a44fddc3b8d34b76114afafbdc9b0ec6d">getRegisteredSpecies</a> () const noexcept override</td></tr>
<tr class="memdesc:a44fddc3b8d34b76114afafbdc9b0ec6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered atomic species in the composition. <br /></td></tr>
<tr class="separator:a44fddc3b8d34b76114afafbdc9b0ec6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b33507e9820b7fd55209d3624388077" id="r_a9b33507e9820b7fd55209d3624388077"><td class="memItemLeft" align="right" valign="top">std::set&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b33507e9820b7fd55209d3624388077">getRegisteredSymbols</a> () const noexcept override</td></tr>
<tr class="memdesc:a9b33507e9820b7fd55209d3624388077"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered chemical symbols in the composition. <br /></td></tr>
<tr class="separator:a9b33507e9820b7fd55209d3624388077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b6c7a9ad6293558ddc8834d22f4bc62" id="r_a6b6c7a9ad6293558ddc8834d22f4bc62"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b6c7a9ad6293558ddc8834d22f4bc62">size</a> () const noexcept override</td></tr>
<tr class="separator:a6b6c7a9ad6293558ddc8834d22f4bc62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2383b69a4b1dbe1c7be01bb826b06c07" id="r_a2383b69a4b1dbe1c7be01bb826b06c07"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2383b69a4b1dbe1c7be01bb826b06c07">getMassFraction</a> () const noexcept override</td></tr>
<tr class="memdesc:a2383b69a4b1dbe1c7be01bb826b06c07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for all registered symbols. <br /></td></tr>
<tr class="separator:a2383b69a4b1dbe1c7be01bb826b06c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c299c44f385b65202ed0d475402562a" id="r_a2c299c44f385b65202ed0d475402562a"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c299c44f385b65202ed0d475402562a">getNumberFraction</a> () const noexcept override</td></tr>
<tr class="memdesc:a2c299c44f385b65202ed0d475402562a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for all registered symbols. <br /></td></tr>
<tr class="separator:a2c299c44f385b65202ed0d475402562a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2a8d9eb543eb712f9a0bbabcc94383a" id="r_ab2a8d9eb543eb712f9a0bbabcc94383a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2a8d9eb543eb712f9a0bbabcc94383a">getMassFraction</a> (const std::string &amp;symbol) const override</td></tr>
<tr class="memdesc:ab2a8d9eb543eb712f9a0bbabcc94383a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given symbol. <br /></td></tr>
<tr class="separator:ab2a8d9eb543eb712f9a0bbabcc94383a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81cab92e09924db1804e9b943611648a" id="r_a81cab92e09924db1804e9b943611648a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81cab92e09924db1804e9b943611648a">getMassFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;species) const override</td></tr>
<tr class="memdesc:a81cab92e09924db1804e9b943611648a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given species. <br /></td></tr>
<tr class="separator:a81cab92e09924db1804e9b943611648a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f65f7cad735494aa5010cf0832f23b" id="r_af4f65f7cad735494aa5010cf0832f23b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af4f65f7cad735494aa5010cf0832f23b">getNumberFraction</a> (const std::string &amp;symbol) const override</td></tr>
<tr class="memdesc:af4f65f7cad735494aa5010cf0832f23b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given symbol. <br /></td></tr>
<tr class="separator:af4f65f7cad735494aa5010cf0832f23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cbb41a5b9e8d49c85bcbc821c3ff47e" id="r_a7cbb41a5b9e8d49c85bcbc821c3ff47e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cbb41a5b9e8d49c85bcbc821c3ff47e">getNumberFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;species) const override</td></tr>
<tr class="memdesc:a7cbb41a5b9e8d49c85bcbc821c3ff47e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given species. <br /></td></tr>
<tr class="separator:a7cbb41a5b9e8d49c85bcbc821c3ff47e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3064af4fb0b59dce5b484d5657d25506" id="r_a3064af4fb0b59dce5b484d5657d25506"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3064af4fb0b59dce5b484d5657d25506">getMolarAbundance</a> (const std::string &amp;symbol) const override</td></tr>
<tr class="memdesc:a3064af4fb0b59dce5b484d5657d25506"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given symbol. <br /></td></tr>
<tr class="separator:a3064af4fb0b59dce5b484d5657d25506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9766e12e53e504aab985e46dc4e0d6d6" id="r_a9766e12e53e504aab985e46dc4e0d6d6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9766e12e53e504aab985e46dc4e0d6d6">getMolarAbundance</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;species) const override</td></tr>
<tr class="memdesc:a9766e12e53e504aab985e46dc4e0d6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given species. <br /></td></tr>
<tr class="separator:a9766e12e53e504aab985e46dc4e0d6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f50005318f2aa7bf7c3cd5b1d2aef7a" id="r_a3f50005318f2aa7bf7c3cd5b1d2aef7a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f50005318f2aa7bf7c3cd5b1d2aef7a">getMeanParticleMass</a> () const noexcept override</td></tr>
<tr class="memdesc:a3f50005318f2aa7bf7c3cd5b1d2aef7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mean particle mass of the composition. <br /></td></tr>
<tr class="separator:a3f50005318f2aa7bf7c3cd5b1d2aef7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38fc871469f94b3c07ba18a00548085d" id="r_a38fc871469f94b3c07ba18a00548085d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a38fc871469f94b3c07ba18a00548085d">getElectronAbundance</a> () const noexcept override</td></tr>
<tr class="memdesc:a38fc871469f94b3c07ba18a00548085d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the electron abundance of the composition. <br /></td></tr>
<tr class="separator:a38fc871469f94b3c07ba18a00548085d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7655d278224486e762d22d0501187f58" id="r_a7655d278224486e762d22d0501187f58"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7655d278224486e762d22d0501187f58">getMassFractionVector</a> () const noexcept override</td></tr>
<tr class="memdesc:a7655d278224486e762d22d0501187f58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction as a vector. <br /></td></tr>
<tr class="separator:a7655d278224486e762d22d0501187f58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad28b1f5c98bd25378c24c732d74deab4" id="r_ad28b1f5c98bd25378c24c732d74deab4"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad28b1f5c98bd25378c24c732d74deab4">getNumberFractionVector</a> () const noexcept override</td></tr>
<tr class="memdesc:ad28b1f5c98bd25378c24c732d74deab4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction as a vector. <br /></td></tr>
<tr class="separator:ad28b1f5c98bd25378c24c732d74deab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2f827bedae5405ebab7108b2e4397c5" id="r_ac2f827bedae5405ebab7108b2e4397c5"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2f827bedae5405ebab7108b2e4397c5">getMolarAbundanceVector</a> () const noexcept override</td></tr>
<tr class="memdesc:ac2f827bedae5405ebab7108b2e4397c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance as a vector. <br /></td></tr>
<tr class="separator:ac2f827bedae5405ebab7108b2e4397c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7277650debc78e081963663557de73eb" id="r_a7277650debc78e081963663557de73eb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7277650debc78e081963663557de73eb">getSpeciesIndex</a> (const std::string &amp;symbol) const override</td></tr>
<tr class="memdesc:a7277650debc78e081963663557de73eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species by symbol. <br /></td></tr>
<tr class="separator:a7277650debc78e081963663557de73eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a395e5b14cd2a9f9d467fea25542f8ebd" id="r_a395e5b14cd2a9f9d467fea25542f8ebd"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a395e5b14cd2a9f9d467fea25542f8ebd">getSpeciesIndex</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;species) const override</td></tr>
<tr class="memdesc:a395e5b14cd2a9f9d467fea25542f8ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species. <br /></td></tr>
<tr class="separator:a395e5b14cd2a9f9d467fea25542f8ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc9d3af0aad6c6209c9aefd94f86996b" id="r_acc9d3af0aad6c6209c9aefd94f86996b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc9d3af0aad6c6209c9aefd94f86996b">getSpeciesAtIndex</a> (size_t index) const override</td></tr>
<tr class="memdesc:acc9d3af0aad6c6209c9aefd94f86996b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the species at a given index. <br /></td></tr>
<tr class="separator:acc9d3af0aad6c6209c9aefd94f86996b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30f89ba71d9db6ad330c645d0a161164" id="r_a30f89ba71d9db6ad330c645d0a161164"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a30f89ba71d9db6ad330c645d0a161164">clone</a> () const override</td></tr>
<tr class="separator:a30f89ba71d9db6ad330c645d0a161164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa01637b823d0127736cdc767284eb28d" id="r_aa01637b823d0127736cdc767284eb28d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa01637b823d0127736cdc767284eb28d">begin</a> () override</td></tr>
<tr class="separator:aa01637b823d0127736cdc767284eb28d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae6a6799ee6877064728bd880348420d" id="r_aae6a6799ee6877064728bd880348420d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae6a6799ee6877064728bd880348420d">end</a> () override</td></tr>
<tr class="separator:aae6a6799ee6877064728bd880348420d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a047dae84149b92be5849c4294cd481de" id="r_a047dae84149b92be5849c4294cd481de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a047dae84149b92be5849c4294cd481de">begin</a> () const override</td></tr>
<tr class="separator:a047dae84149b92be5849c4294cd481de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a272b2164c1ad6efab7e86ed26efcbb96" id="r_a272b2164c1ad6efab7e86ed26efcbb96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a272b2164c1ad6efab7e86ed26efcbb96">end</a> () const override</td></tr>
<tr class="separator:a272b2164c1ad6efab7e86ed26efcbb96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cff238d7aec2db1f7c509d199b56afb" id="r_a0cff238d7aec2db1f7c509d199b56afb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cff238d7aec2db1f7c509d199b56afb">hash</a> () const override</td></tr>
<tr class="separator:a0cff238d7aec2db1f7c509d199b56afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classfourdst_1_1composition_1_1_composition_decorator"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classfourdst_1_1composition_1_1_composition_decorator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html">fourdst::composition::CompositionDecorator</a></td></tr>
<tr class="memitem:a115e0c194a3dffddc558e0305cc56677 inherit pub_methods_classfourdst_1_1composition_1_1_composition_decorator" id="r_a115e0c194a3dffddc558e0305cc56677"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a115e0c194a3dffddc558e0305cc56677">CompositionDecorator</a> (std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt; decorator)</td></tr>
<tr class="separator:a115e0c194a3dffddc558e0305cc56677 inherit pub_methods_classfourdst_1_1composition_1_1_composition_decorator"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classfourdst_1_1composition_1_1_composition_abstract"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classfourdst_1_1composition_1_1_composition_abstract')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">fourdst::composition::CompositionAbstract</a></td></tr>
<tr class="memitem:a83ff77f3f390bb66c978e157d9bb6394 inherit pub_methods_classfourdst_1_1composition_1_1_composition_abstract" id="r_a83ff77f3f390bb66c978e157d9bb6394"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html#a83ff77f3f390bb66c978e157d9bb6394">~CompositionAbstract</a> ()=default</td></tr>
<tr class="memdesc:a83ff77f3f390bb66c978e157d9bb6394 inherit pub_methods_classfourdst_1_1composition_1_1_composition_abstract"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a83ff77f3f390bb66c978e157d9bb6394 inherit pub_methods_classfourdst_1_1composition_1_1_composition_abstract"><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:a22a5b2ea210bb14a07b6461270631a3b" id="r_a22a5b2ea210bb14a07b6461270631a3b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a22a5b2ea210bb14a07b6461270631a3b">m_activeSpecies</a></td></tr>
<tr class="separator:a22a5b2ea210bb14a07b6461270631a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe4e28b36230fa41c11c22e36aaa15e7" id="r_abe4e28b36230fa41c11c22e36aaa15e7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe4e28b36230fa41c11c22e36aaa15e7">m_molarAbundances</a></td></tr>
<tr class="separator:abe4e28b36230fa41c11c22e36aaa15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classfourdst_1_1composition_1_1_composition_decorator"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classfourdst_1_1composition_1_1_composition_decorator')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html">fourdst::composition::CompositionDecorator</a></td></tr>
<tr class="memitem:a785a5aeddcc68ce3a5b688d956c4d505 inherit pro_attribs_classfourdst_1_1composition_1_1_composition_decorator" id="r_a785a5aeddcc68ce3a5b688d956c4d505"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a785a5aeddcc68ce3a5b688d956c4d505">m_base_composition</a></td></tr>
<tr class="separator:a785a5aeddcc68ce3a5b688d956c4d505 inherit pro_attribs_classfourdst_1_1composition_1_1_composition_decorator"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="composition__masked_8h_source.html#l00015">15</a> of file <a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="acd2bbf05d4f5fce5a1146619a0b16b6d" name="acd2bbf05d4f5fce5a1146619a0b16b6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2bbf05d4f5fce5a1146619a0b16b6d">&#9670;&#160;</a></span>const_iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">fourdst::composition::MaskedComposition::const_iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;true&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition__masked_8h_source.html#l00018">18</a> of file <a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>.</p>
</div>
</div>
<a id="afe3129b1dbebfbe0578c3a555aa742bf" name="afe3129b1dbebfbe0578c3a555aa742bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe3129b1dbebfbe0578c3a555aa742bf">&#9670;&#160;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">fourdst::composition::MaskedComposition::iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;false&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition__masked_8h_source.html#l00017">17</a> of file <a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9a0d839e4534494b7adaf353d56e5375" name="a9a0d839e4534494b7adaf353d56e5375"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a0d839e4534494b7adaf353d56e5375">&#9670;&#160;</a></span>MaskedComposition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">fourdst::composition::MaskedComposition::MaskedComposition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &amp;</td> <td class="paramname"><span class="paramname"><em>baseComposition</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>activeSpecies</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00015">15</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a047dae84149b92be5849c4294cd481de" name="a047dae84149b92be5849c4294cd481de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a047dae84149b92be5849c4294cd481de">&#9670;&#160;</a></span>begin() <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"><a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">MaskedComposition::const_iterator</a> fourdst::composition::MaskedComposition::begin </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a125e06aaf1edfd035d7d102792a120d5">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00226">226</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="aa01637b823d0127736cdc767284eb28d" name="aa01637b823d0127736cdc767284eb28d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa01637b823d0127736cdc767284eb28d">&#9670;&#160;</a></span>begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">MaskedComposition::iterator</a> fourdst::composition::MaskedComposition::begin </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 nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a34e7e9fd25cd4037ba359bc7a7236929">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00218">218</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a30f89ba71d9db6ad330c645d0a161164" name="a30f89ba71d9db6ad330c645d0a161164"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30f89ba71d9db6ad330c645d0a161164">&#9670;&#160;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt; fourdst::composition::MaskedComposition::clone </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html#a81d5a4da267e24662ae90c6a29f3d0a1">fourdst::composition::CompositionAbstract</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00214">214</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a045cfdf1e771895df872a6da61c53966" name="a045cfdf1e771895df872a6da61c53966"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045cfdf1e771895df872a6da61c53966">&#9670;&#160;</a></span>contains() <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">bool fourdst::composition::MaskedComposition::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a811e91b7cc08f19b8c92de43fdb91401">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00037">37</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a83b73b24715d8a0fc29811653bb7c9a6" name="a83b73b24715d8a0fc29811653bb7c9a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b73b24715d8a0fc29811653bb7c9a6">&#9670;&#160;</a></span>contains() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool fourdst::composition::MaskedComposition::contains </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The symbol of the atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#af40ce87fce6fc0fae837bf8f31fec274">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00041">41</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a272b2164c1ad6efab7e86ed26efcbb96" name="a272b2164c1ad6efab7e86ed26efcbb96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a272b2164c1ad6efab7e86ed26efcbb96">&#9670;&#160;</a></span>end() <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"><a class="el" href="#acd2bbf05d4f5fce5a1146619a0b16b6d">MaskedComposition::const_iterator</a> fourdst::composition::MaskedComposition::end </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a56d0561c510efa577dc9a295174827ec">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00230">230</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="aae6a6799ee6877064728bd880348420d" name="aae6a6799ee6877064728bd880348420d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae6a6799ee6877064728bd880348420d">&#9670;&#160;</a></span>end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#afe3129b1dbebfbe0578c3a555aa742bf">MaskedComposition::iterator</a> fourdst::composition::MaskedComposition::end </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 nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#aaf47cdfcb7feb3991d6e151bbf2521ff">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00222">222</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a38fc871469f94b3c07ba18a00548085d" name="a38fc871469f94b3c07ba18a00548085d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38fc871469f94b3c07ba18a00548085d">&#9670;&#160;</a></span>getElectronAbundance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getElectronAbundance </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the electron abundance of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The electron abundance. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a39f1df55aff6650c653e62c0e9a2cc5e">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00149">149</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a2383b69a4b1dbe1c7be01bb826b06c07" name="a2383b69a4b1dbe1c7be01bb826b06c07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2383b69a4b1dbe1c7be01bb826b06c07">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>, double &gt; fourdst::composition::MaskedComposition::getMassFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to mass fraction. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a8c1a4cd69465ef5b65bea547ed919ca5">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00065">65</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a81cab92e09924db1804e9b943611648a" name="a81cab92e09924db1804e9b943611648a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81cab92e09924db1804e9b943611648a">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getMassFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a12a5cdb232ce4ce30980a016d20b4a43">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00097">97</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="ab2a8d9eb543eb712f9a0bbabcc94383a" name="ab2a8d9eb543eb712f9a0bbabcc94383a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2a8d9eb543eb712f9a0bbabcc94383a">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getMassFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the symbol. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a52591cb38ab7712fc459eeb48b9d2eaf">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00089">89</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a7655d278224486e762d22d0501187f58" name="a7655d278224486e762d22d0501187f58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7655d278224486e762d22d0501187f58">&#9670;&#160;</a></span>getMassFractionVector()</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; double &gt; fourdst::composition::MaskedComposition::getMassFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of mass fractions for all species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a4d2795fa73ec3f5185232d4cca5684a6">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00159">159</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a3f50005318f2aa7bf7c3cd5b1d2aef7a" name="a3f50005318f2aa7bf7c3cd5b1d2aef7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f50005318f2aa7bf7c3cd5b1d2aef7a">&#9670;&#160;</a></span>getMeanParticleMass()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getMeanParticleMass </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mean particle mass of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The mean particle mass. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a3b8f0f8fd75888d001177deff39f7405">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00137">137</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a9766e12e53e504aab985e46dc4e0d6d6" name="a9766e12e53e504aab985e46dc4e0d6d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9766e12e53e504aab985e46dc4e0d6d6">&#9670;&#160;</a></span>getMolarAbundance() <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">double fourdst::composition::MaskedComposition::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a57a1cc37e96234477b21866881fbdbaa">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00129">129</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a3064af4fb0b59dce5b484d5657d25506" name="a3064af4fb0b59dce5b484d5657d25506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3064af4fb0b59dce5b484d5657d25506">&#9670;&#160;</a></span>getMolarAbundance() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the symbol. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0c46d440cafd9ae2d04589ece5fd41fb">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00121">121</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="ac2f827bedae5405ebab7108b2e4397c5" name="ac2f827bedae5405ebab7108b2e4397c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2f827bedae5405ebab7108b2e4397c5">&#9670;&#160;</a></span>getMolarAbundanceVector()</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; double &gt; fourdst::composition::MaskedComposition::getMolarAbundanceVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of molar abundances for all species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a80e528239b4a197985e6993c8b6dab48">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00177">177</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a2c299c44f385b65202ed0d475402562a" name="a2c299c44f385b65202ed0d475402562a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c299c44f385b65202ed0d475402562a">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>, double &gt; fourdst::composition::MaskedComposition::getNumberFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to number fraction. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a66724877d66017bac3dc3cc784dda57c">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00077">77</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a7cbb41a5b9e8d49c85bcbc821c3ff47e" name="a7cbb41a5b9e8d49c85bcbc821c3ff47e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cbb41a5b9e8d49c85bcbc821c3ff47e">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a92c3d23d632f242e8b5526b343617f67">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00113">113</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="af4f65f7cad735494aa5010cf0832f23b" name="af4f65f7cad735494aa5010cf0832f23b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4f65f7cad735494aa5010cf0832f23b">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::MaskedComposition::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the symbol. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0ff3454e625043c76131a1206d9293c6">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00105">105</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="ad28b1f5c98bd25378c24c732d74deab4" name="ad28b1f5c98bd25378c24c732d74deab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad28b1f5c98bd25378c24c732d74deab4">&#9670;&#160;</a></span>getNumberFractionVector()</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; double &gt; fourdst::composition::MaskedComposition::getNumberFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of number fractions for all species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a72ffd49c3b3e7f3f22ed28ceb2169cb5">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00168">168</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a44fddc3b8d34b76114afafbdc9b0ec6d" name="a44fddc3b8d34b76114afafbdc9b0ec6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44fddc3b8d34b76114afafbdc9b0ec6d">&#9670;&#160;</a></span>getRegisteredSpecies()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp; fourdst::composition::MaskedComposition::getRegisteredSpecies </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered atomic species in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered atomic species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0cdc50a57e09bf8461839d08eb4ae212">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00049">49</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a9b33507e9820b7fd55209d3624388077" name="a9b33507e9820b7fd55209d3624388077"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b33507e9820b7fd55209d3624388077">&#9670;&#160;</a></span>getRegisteredSymbols()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::set&lt; std::string &gt; fourdst::composition::MaskedComposition::getRegisteredSymbols </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered chemical symbols in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered chemical symbols. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a85acea9a107432dfefcbfffe4c3c7c62">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00053">53</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="acc9d3af0aad6c6209c9aefd94f86996b" name="acc9d3af0aad6c6209c9aefd94f86996b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc9d3af0aad6c6209c9aefd94f86996b">&#9670;&#160;</a></span>getSpeciesAtIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> fourdst::composition::MaskedComposition::getSpeciesAtIndex </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the species at a given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index of the species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The atomic species at the specified index. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a996066b4bf67e415eb2dd3ea7aed68bd">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00205">205</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a395e5b14cd2a9f9d467fea25542f8ebd" name="a395e5b14cd2a9f9d467fea25542f8ebd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a395e5b14cd2a9f9d467fea25542f8ebd">&#9670;&#160;</a></span>getSpeciesIndex() <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">size_t fourdst::composition::MaskedComposition::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#ab02b459d8ce7f36a0a1c6058c013a75c">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00198">198</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a7277650debc78e081963663557de73eb" name="a7277650debc78e081963663557de73eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7277650debc78e081963663557de73eb">&#9670;&#160;</a></span>getSpeciesIndex() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t fourdst::composition::MaskedComposition::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species by symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a9b7e6388d9a73c05ddd34660bde43867">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00186">186</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a0cff238d7aec2db1f7c509d199b56afb" name="a0cff238d7aec2db1f7c509d199b56afb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cff238d7aec2db1f7c509d199b56afb">&#9670;&#160;</a></span>hash()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t fourdst::composition::MaskedComposition::hash </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html#a2d5472a63e2dbfc94d7e4617b5660e23">fourdst::composition::CompositionAbstract</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00234">234</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<a id="a6b6c7a9ad6293558ddc8834d22f4bc62" name="a6b6c7a9ad6293558ddc8834d22f4bc62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b6c7a9ad6293558ddc8834d22f4bc62">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t fourdst::composition::MaskedComposition::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#af70b703b6b946d959cdd5cd15e853a9d">fourdst::composition::CompositionDecorator</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition__masked_8cpp_source.html#l00061">61</a> of file <a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a22a5b2ea210bb14a07b6461270631a3b" name="a22a5b2ea210bb14a07b6461270631a3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22a5b2ea210bb14a07b6461270631a3b">&#9670;&#160;</a></span>m_activeSpecies</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;<a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&gt; fourdst::composition::MaskedComposition::m_activeSpecies</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 class="definition">Definition at line <a class="el" href="composition__masked_8h_source.html#l00065">65</a> of file <a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>.</p>
</div>
</div>
<a id="abe4e28b36230fa41c11c22e36aaa15e7" name="abe4e28b36230fa41c11c22e36aaa15e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe4e28b36230fa41c11c22e36aaa15e7">&#9670;&#160;</a></span>m_molarAbundances</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;double&gt; fourdst::composition::MaskedComposition::m_molarAbundances</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 class="definition">Definition at line <a class="el" href="composition__masked_8h_source.html#l00066">66</a> of file <a class="el" href="composition__masked_8h_source.html">composition_masked.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/composition/include/fourdst/composition/decorators/<a class="el" href="composition__masked_8h_source.html">composition_masked.h</a></li>
<li>src/composition/lib/decorators/<a class="el" href="composition__masked_8cpp_source.html">composition_masked.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacefourdst.html">fourdst</a></li><li class="navelem"><a class="el" href="namespacefourdst_1_1composition.html">composition</a></li><li class="navelem"><a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html">MaskedComposition</a></li>
<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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink