tboudreaux/libcomposition
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
2026-06-12 10:49:27 -04:00
parent 997c845b3d
commit 30da87c74c
387 changed files with 6889 additions and 8739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/html/hierarchy.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.3.1</span>
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.4.9</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
@@ -108,23 +108,26 @@ This inheritance list is sorted roughly, but not completely, alphabetically:</di
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy.html" target="_self">fourdst::composition::detail::CompositionIterator&lt; IsConst &gt;::ArrowProxy</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1_canonical_composition.html" target="_self">fourdst::composition::CanonicalComposition</a></td><td class="desc">Represents the canonical (X, Y, Z) composition of stellar material </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="dynsection.toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html" target="_self">fourdst::composition::CompositionAbstract</a></td><td class="desc">Abstract base class for chemical composition representations </td></tr>
<tr id="row_2_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition.html" target="_self">fourdst::composition::Composition</a></td><td class="desc">Manages a collection of chemical species and their abundances </td></tr>
<tr id="row_2_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_2_1_" class="arrow" onclick="dynsection.toggleFolder('2_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html" target="_self">fourdst::composition::CompositionDecorator</a></td><td class="desc"></td></tr>
<tr id="row_2_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html" target="_self">fourdst::composition::MaskedComposition</a></td><td class="desc"></td></tr>
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html" target="_self">fourdst::composition::Composition::CompositionCache</a></td><td class="desc">Caches computed properties of the composition to avoid redundant calculations </td></tr>
<tr id="row_4_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1utils_1_1_composition_hash.html" target="_self">fourdst::composition::utils::CompositionHash</a></td><td class="desc"></td></tr>
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html" target="_self">fourdst::composition::detail::CompositionIterator&lt; IsConst &gt;</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_6_" class="arrow" onclick="dynsection.toggleFolder('6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>std::exception</b></td><td class="desc">STL class </td></tr>
<tr id="row_6_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_6_0_" class="arrow" onclick="dynsection.toggleFolder('6_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html" target="_self">fourdst::composition::exceptions::CompositionError</a></td><td class="desc">Base class for exceptions related to composition objects </td></tr>
<tr id="row_6_0_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" target="_self">fourdst::composition::exceptions::InvalidCompositionError</a></td><td class="desc">Exception thrown when a composition is in an invalid or inconsistent state </td></tr>
<tr id="row_6_0_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" target="_self">fourdst::composition::exceptions::UnregisteredSymbolError</a></td><td class="desc">Exception thrown when a symbol is used that has not been registered </td></tr>
<tr id="row_6_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_6_1_" class="arrow" onclick="dynsection.toggleFolder('6_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_species_error.html" target="_self">fourdst::composition::exceptions::SpeciesError</a></td><td class="desc">Base class for exceptions related to atomic species </td></tr>
<tr id="row_6_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html" target="_self">fourdst::composition::exceptions::UnknownSymbolError</a></td><td class="desc">Exception thrown when an unknown symbol is encountered </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4.html" target="_self">std::hash&lt; fourdst::atomic::Species &gt;</a></td><td class="desc">Specialization of <code>std::hash</code> for <code><a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">fourdst::atomic::Species</a></code> </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4.html" target="_self">std::hash&lt; fourdst::composition::Composition &gt;</a></td><td class="desc"></td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4.html" target="_self">std::hash&lt; fourdst::composition::CompositionAbstract &gt;</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1atomic_1_1_species.html" target="_self">fourdst::atomic::Species</a></td><td class="desc">Represents an atomic species (isotope) with its fundamental physical properties </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1io_1_1_chemical_file_parser.html" target="_self">fourdst::composition::io::ChemicalFileParser</a></td><td class="desc">Parser for the tagged flat-text chemical composition data format </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="dynsection.toggleFolder('3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html" target="_self">fourdst::composition::CompositionAbstract</a></td><td class="desc">Abstract base class for chemical composition representations </td></tr>
<tr id="row_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition.html" target="_self">fourdst::composition::Composition</a></td><td class="desc">Manages a collection of chemical species and their abundances </td></tr>
<tr id="row_3_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_3_1_" class="arrow" onclick="dynsection.toggleFolder('3_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html" target="_self">fourdst::composition::CompositionDecorator</a></td><td class="desc"></td></tr>
<tr id="row_3_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html" target="_self">fourdst::composition::MaskedComposition</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html" target="_self">fourdst::composition::Composition::CompositionCache</a></td><td class="desc">Caches computed properties of the composition to avoid redundant calculations </td></tr>
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1io_1_1_composition_data.html" target="_self">fourdst::composition::io::CompositionData</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1utils_1_1_composition_hash.html" target="_self">fourdst::composition::utils::CompositionHash</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html" target="_self">fourdst::composition::detail::CompositionIterator&lt; IsConst &gt;</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_8_" class="arrow" onclick="dynsection.toggleFolder('8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>std::exception</b></td><td class="desc">STL class </td></tr>
<tr id="row_8_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_8_0_" class="arrow" onclick="dynsection.toggleFolder('8_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html" target="_self">fourdst::composition::exceptions::CompositionError</a></td><td class="desc">Base class for exceptions related to composition objects </td></tr>
<tr id="row_8_0_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" target="_self">fourdst::composition::exceptions::InvalidCompositionError</a></td><td class="desc">Exception thrown when a composition is in an invalid or inconsistent state </td></tr>
<tr id="row_8_0_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" target="_self">fourdst::composition::exceptions::UnregisteredSymbolError</a></td><td class="desc">Exception thrown when a symbol is used that has not been registered </td></tr>
<tr id="row_8_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_8_1_" class="arrow" onclick="dynsection.toggleFolder('8_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_species_error.html" target="_self">fourdst::composition::exceptions::SpeciesError</a></td><td class="desc">Base class for exceptions related to atomic species </td></tr>
<tr id="row_8_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html" target="_self">fourdst::composition::exceptions::UnknownSymbolError</a></td><td class="desc">Exception thrown when an unknown symbol is encountered </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4.html" target="_self">std::hash&lt; fourdst::atomic::Species &gt;</a></td><td class="desc">Specialization of <code>std::hash</code> for <code><a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">fourdst::atomic::Species</a></code> </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4.html" target="_self">std::hash&lt; fourdst::composition::Composition &gt;</a></td><td class="desc"></td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4.html" target="_self">std::hash&lt; fourdst::composition::CompositionAbstract &gt;</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1composition_1_1io_1_1_isotopic_percentage.html" target="_self">fourdst::composition::io::IsotopicPercentage</a></td><td class="desc"></td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1atomic_1_1_species.html" target="_self">fourdst::atomic::Species</a></td><td class="desc">Represents an atomic species (isotope) with its fundamental physical properties </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->