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

14
docs/latex/annotated.tex
View File

@@ -3,20 +3,12 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{fourdst\+::composition\+::\+Canonical\+Composition}} \\*Represents the canonical (X, Y, Z) composition of stellar material }{\pageref{structfourdst_1_1composition_1_1_canonical_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst\+::composition\+::\+Composition}} \\*Manages a collection of chemical species and their abundances }{\pageref{classfourdst_1_1composition_1_1_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_composition_abstract}{Composition\+Abstract}} \\*Abstract base class for chemical composition representations }{\pageref{class_composition_abstract}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}} }{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{fourdst\+::composition\+::\+Composition\+Entry}} \\*Represents a single entry (an isotope) within a composition }{\pageref{structfourdst_1_1composition_1_1_composition_entry}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}} \\*Base class for exceptions related to individual entries within a composition }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}} \\*Caches computed properties of the composition to avoid redundant calculations }{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}} \\*Base class for exceptions related to composition objects }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Mode\+Error}} \\*Exception thrown due to a conflict in composition modes at the entry level }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Not\+Finalized\+Error}} \\*Exception thrown when an operation is attempted on a composition that has not been finalized }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{fourdst\+::composition\+::exceptions\+::\+Entry\+Already\+Initialized\+Error}} \\*Exception thrown when attempting to initialize a composition entry that has already been initialized }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{fourdst\+::composition\+::exceptions\+::\+Failed\+To\+Finalize\+Composition\+Error}} \\*Exception thrown when the finalization process of a composition fails }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{fourdst\+::composition\+::\+Global\+Composition}} \\*Represents global properties of a finalized composition }{\pageref{structfourdst_1_1composition_1_1_global_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}{std\+::hash$<$ fourdst\+::atomic\+::\+Species $>$}} \\*Specialization of {\ttfamily std\+::hash} for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} }{\pageref{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Composition\+Error}} \\*Exception thrown when a composition is in an invalid or inconsistent state }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Mixing\+Mode}} \\*Exception thrown for an invalid or unsupported mixing mode }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Species\+Symbol\+Error}} \\*Exception thrown for an invalid chemical species symbol in a composition entry }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Symbol\+Error}} \\*Exception thrown when a symbol used in a composition is invalid }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \\*Represents an atomic species (isotope) with its fundamental physical properties }{\pageref{structfourdst_1_1atomic_1_1_species}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error}{fourdst\+::composition\+::exceptions\+::\+Species\+Error}} \\*Base class for exceptions related to atomic species }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_species_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unknown\+Symbol\+Error}} \\*Exception thrown when an unknown symbol is encountered }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unregistered\+Symbol\+Error}} \\*Exception thrown when a symbol is used that has not been registered }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}}{}
\end{DoxyCompactList}