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

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-08 06:42:51 -05:00
parent 7a303b8d3a
commit d68808666e
219 changed files with 8429 additions and 10585 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/html/annotated.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.9.0</span>
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.0.0</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
@@ -105,26 +105,18 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span><span onclick="javascript:dynsection.toggleLevel(4);">4</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst.html" target="_self">fourdst</a></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="dynsection.toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1atomic.html" target="_self">atomic</a></td><td class="desc">Contains classes and functions related to atomic data, such as properties of atomic species </td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="dynsection.toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1atomic.html" target="_self">atomic</a></td><td class="desc">Contains canonical information about atomic species and elements used by 4D-STAR </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfourdst_1_1atomic_1_1_species.html" target="_self">Species</a></td><td class="desc">Represents an atomic species (isotope) with its fundamental physical properties </td></tr>
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="dynsection.toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition.html" target="_self">composition</a></td><td class="desc"></td></tr>
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="dynsection.toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition.html" target="_self">composition</a></td><td class="desc">Utilities and types for representing and manipulating chemical compositions </td></tr>
<tr id="row_0_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_1_0_" class="arrow" onclick="dynsection.toggleFolder('0_1_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefourdst_1_1composition_1_1exceptions.html" target="_self">exceptions</a></td><td class="desc"></td></tr>
<tr id="row_0_1_0_0_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</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">CompositionEntryError</a></td><td class="desc">Base class for exceptions related to individual entries within a composition </td></tr>
<tr id="row_0_1_0_1_" class="even"><td class="entry"><span style="width:64px;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_error.html" target="_self">CompositionError</a></td><td class="desc">Base class for exceptions related to composition objects </td></tr>
<tr id="row_0_1_0_2_" class="odd"><td class="entry"><span style="width:64px;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">CompositionModeError</a></td><td class="desc">Exception thrown due to a conflict in composition modes at the entry level </td></tr>
<tr id="row_0_1_0_3_" class="even"><td class="entry"><span style="width:64px;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">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_0_1_0_4_" class="odd"><td class="entry"><span style="width:64px;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">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_0_1_0_5_" class="even"><td class="entry"><span style="width:64px;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">FailedToFinalizeCompositionError</a></td><td class="desc">Exception thrown when the finalization process of a composition fails </td></tr>
<tr id="row_0_1_0_6_" class="odd"><td class="entry"><span style="width:64px;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">InvalidCompositionError</a></td><td class="desc">Exception thrown when a composition is in an invalid or inconsistent state </td></tr>
<tr id="row_0_1_0_7_" class="even"><td class="entry"><span style="width:64px;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">InvalidMixingMode</a></td><td class="desc">Exception thrown for an invalid or unsupported mixing mode </td></tr>
<tr id="row_0_1_0_8_" class="odd"><td class="entry"><span style="width:64px;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">InvalidSpeciesSymbolError</a></td><td class="desc">Exception thrown for an invalid chemical species symbol in a composition entry </td></tr>
<tr id="row_0_1_0_9_" class="even"><td class="entry"><span style="width:64px;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">InvalidSymbolError</a></td><td class="desc">Exception thrown when a symbol used in a composition is invalid </td></tr>
<tr id="row_0_1_0_10_" class="odd"><td class="entry"><span style="width:64px;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">UnregisteredSymbolError</a></td><td class="desc">Exception thrown when a symbol is used that has not been registered </td></tr>
<tr id="row_0_1_0_0_" class="odd"><td class="entry"><span style="width:64px;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_error.html" target="_self">CompositionError</a></td><td class="desc">Base class for exceptions related to composition objects </td></tr>
<tr id="row_0_1_0_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#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">InvalidCompositionError</a></td><td class="desc">Exception thrown when a composition is in an invalid or inconsistent state </td></tr>
<tr id="row_0_1_0_2_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</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">SpeciesError</a></td><td class="desc">Base class for exceptions related to atomic species </td></tr>
<tr id="row_0_1_0_3_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#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">UnknownSymbolError</a></td><td class="desc">Exception thrown when an unknown symbol is encountered </td></tr>
<tr id="row_0_1_0_4_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;">&#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">UnregisteredSymbolError</a></td><td class="desc">Exception thrown when a symbol is used that has not been registered </td></tr>
<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;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">CanonicalComposition</a></td><td class="desc">Represents the canonical (X, Y, Z) composition of stellar material </td></tr>
<tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_1_2_" class="arrow" onclick="dynsection.toggleFolder('0_1_2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfourdst_1_1composition_1_1_composition.html" target="_self">Composition</a></td><td class="desc">Manages a collection of chemical species and their abundances </td></tr>
<tr id="row_0_1_2_0_" class="even"><td class="entry"><span style="width:64px;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">CompositionCache</a></td><td class="desc"></td></tr>
<tr id="row_0_1_3_" 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="structfourdst_1_1composition_1_1_composition_entry.html" target="_self">CompositionEntry</a></td><td class="desc">Represents a single entry (an isotope) within a composition </td></tr>
<tr id="row_0_1_4_" 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="structfourdst_1_1composition_1_1_global_composition.html" target="_self">GlobalComposition</a></td><td class="desc">Represents global properties of a finalized composition </td></tr>
<tr id="row_0_1_2_0_" class="even"><td class="entry"><span style="width:64px;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">CompositionCache</a></td><td class="desc">Caches computed properties of the composition to avoid redundant calculations </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">N</span></span><b>std</b></td><td class="desc">STL namespace </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="structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4.html" target="_self">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_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="class_composition_abstract.html" target="_self">CompositionAbstract</a></td><td class="desc">Abstract base class for chemical composition representations </td></tr>