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
2025-10-12 10:22:43 -04:00
parent 51dba31a44
commit 8be8ac3b65
202 changed files with 24039 additions and 161918 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
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;v1.5.2</span>
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.9.0</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
@@ -105,23 +105,25 @@ $(function(){initNavTree('hierarchy.html',''); initResizable(true); });
<div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
<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_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_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="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_" 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_entry.html" target="_self">fourdst::composition::CompositionEntry</a></td><td class="desc">Represents a single entry (an isotope) within a composition </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><b>std::exception</b></td><td class="desc">STL class </td></tr>
<tr id="row_3_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_3_0_" class="arrow" onclick="dynsection.toggleFolder('3_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error.html" target="_self">fourdst::composition::exceptions::CompositionEntryError</a></td><td class="desc">Base class for exceptions related to individual entries within a composition </td></tr>
<tr id="row_3_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_composition_mode_error.html" target="_self">fourdst::composition::exceptions::CompositionModeError</a></td><td class="desc">Exception thrown due to a conflict in composition modes at the entry level </td></tr>
<tr id="row_3_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_entry_already_initialized_error.html" target="_self">fourdst::composition::exceptions::EntryAlreadyInitializedError</a></td><td class="desc">Exception thrown when attempting to initialize a composition entry that has already been initialized </td></tr>
<tr id="row_3_0_2_" 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_species_symbol_error.html" target="_self">fourdst::composition::exceptions::InvalidSpeciesSymbolError</a></td><td class="desc">Exception thrown for an invalid chemical species symbol in a composition entry </td></tr>
<tr id="row_3_1_" class="even"><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_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_3_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_1exceptions_1_1_composition_not_finalized_error.html" target="_self">fourdst::composition::exceptions::CompositionNotFinalizedError</a></td><td class="desc">Exception thrown when an operation is attempted on a composition that has not been finalized </td></tr>
<tr id="row_3_1_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_failed_to_finalize_composition_error.html" target="_self">fourdst::composition::exceptions::FailedToFinalizeCompositionError</a></td><td class="desc">Exception thrown when the finalization process of a composition fails </td></tr>
<tr id="row_3_1_2_" 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_3_1_3_" 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_invalid_mixing_mode.html" target="_self">fourdst::composition::exceptions::InvalidMixingMode</a></td><td class="desc">Exception thrown for an invalid or unsupported mixing mode </td></tr>
<tr id="row_3_1_4_" 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_symbol_error.html" target="_self">fourdst::composition::exceptions::InvalidSymbolError</a></td><td class="desc">Exception thrown when a symbol used in a composition is invalid </td></tr>
<tr id="row_3_1_5_" 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_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_global_composition.html" target="_self">fourdst::composition::GlobalComposition</a></td><td class="desc">Represents global properties of a finalized composition </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="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_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_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_1_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_composition_abstract.html" target="_self">CompositionAbstract</a></td><td class="desc">Abstract base class for chemical composition representations </td></tr>
<tr id="row_1_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_2_" 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"></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_entry.html" target="_self">fourdst::composition::CompositionEntry</a></td><td class="desc">Represents a single entry (an isotope) within a composition </td></tr>
<tr id="row_4_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="dynsection.toggleFolder('4_')">&#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_4_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_0_" class="arrow" onclick="dynsection.toggleFolder('4_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error.html" target="_self">fourdst::composition::exceptions::CompositionEntryError</a></td><td class="desc">Base class for exceptions related to individual entries within a composition </td></tr>
<tr id="row_4_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_composition_mode_error.html" target="_self">fourdst::composition::exceptions::CompositionModeError</a></td><td class="desc">Exception thrown due to a conflict in composition modes at the entry level </td></tr>
<tr id="row_4_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_entry_already_initialized_error.html" target="_self">fourdst::composition::exceptions::EntryAlreadyInitializedError</a></td><td class="desc">Exception thrown when attempting to initialize a composition entry that has already been initialized </td></tr>
<tr id="row_4_0_2_" 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_species_symbol_error.html" target="_self">fourdst::composition::exceptions::InvalidSpeciesSymbolError</a></td><td class="desc">Exception thrown for an invalid chemical species symbol in a composition entry </td></tr>
<tr id="row_4_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_1_" class="arrow" onclick="dynsection.toggleFolder('4_1_')">&#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_4_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_1exceptions_1_1_composition_not_finalized_error.html" target="_self">fourdst::composition::exceptions::CompositionNotFinalizedError</a></td><td class="desc">Exception thrown when an operation is attempted on a composition that has not been finalized </td></tr>
<tr id="row_4_1_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_failed_to_finalize_composition_error.html" target="_self">fourdst::composition::exceptions::FailedToFinalizeCompositionError</a></td><td class="desc">Exception thrown when the finalization process of a composition fails </td></tr>
<tr id="row_4_1_2_" 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_4_1_3_" 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_invalid_mixing_mode.html" target="_self">fourdst::composition::exceptions::InvalidMixingMode</a></td><td class="desc">Exception thrown for an invalid or unsupported mixing mode </td></tr>
<tr id="row_4_1_4_" 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_symbol_error.html" target="_self">fourdst::composition::exceptions::InvalidSymbolError</a></td><td class="desc">Exception thrown when a symbol used in a composition is invalid </td></tr>
<tr id="row_4_1_5_" 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_5_" 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_global_composition.html" target="_self">fourdst::composition::GlobalComposition</a></td><td class="desc">Represents global properties of a finalized composition </td></tr>
<tr id="row_6_" 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_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_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="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 -->