2026-05-18 10:04:49 -04:00
<!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" / >
2026-06-12 10:49:27 -04:00
< title > fourdst::libcomposition: src/composition/include/fourdst/composition/utils/utils.h Source File< / title >
2026-05-18 10:04:49 -04:00
< 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" >
2026-06-12 10:49:27 -04:00
< div id = "projectname" > fourdst::libcomposition< span id = "projectnumber" >   v2.4.9< / span >
2026-05-18 10:04:49 -04:00
< / 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& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& 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& 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& dn=expat.txt MIT */
$(function(){initNavTree('utils_8h_source.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 = "headertitle" > < div class = "title" > utils.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "utils_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #include " < a class = "code" href = "composition_8h.html" > fourdst/composition/composition.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < span class = "preprocessor" > #include " < a class = "code" href = "atomic_species_8h.html" > fourdst/atomic/atomicSpecies.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < span class = "preprocessor" > #include < vector> < / span > < / div >
2026-05-18 10:08:43 -04:00
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "preprocessor" > #include < optional> < / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "preprocessor" > #include < string> < / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacefourdst_1_1composition.html" > fourdst::composition< / a > {< / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "keyword" > const< / span > std::vector< std::string> & symbols,< / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "keyword" > const< / span > std::vector< double> & massFractions< / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > );< / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "keyword" > const< / span > std::vector< atomic::Species> & species,< / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "keyword" > const< / span > std::vector< double> & massFractions< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > );< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > 48< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > 49< / span > < span class = "keyword" > const< / span > std::set< atomic::Species> & species,< / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > 50< / span > < span class = "keyword" > const< / span > std::vector< double> & massFractions< / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > );< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > < / div >
< div class = "line" > < a id = "l00059" name = "l00059" > < / a > < span class = "lineno" > 59< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00060" name = "l00060" > < / a > < span class = "lineno" > 60< / span > < span class = "keyword" > const< / span > std::unordered_map< atomic::Species, double> & massFractionsMap< / div >
< div class = "line" > < a id = "l00061" name = "l00061" > < / a > < span class = "lineno" > 61< / span > );< / div >
< div class = "line" > < a id = "l00062" name = "l00062" > < / a > < span class = "lineno" > 62< / span > < / div >
< div class = "line" > < a id = "l00069" name = "l00069" > < / a > < span class = "lineno" > 69< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00070" name = "l00070" > < / a > < span class = "lineno" > 70< / span > < span class = "keyword" > const< / span > std::unordered_map< std::string, double> & massFractions< / div >
< div class = "line" > < a id = "l00071" name = "l00071" > < / a > < span class = "lineno" > 71< / span > );< / div >
< div class = "line" > < a id = "l00072" name = "l00072" > < / a > < span class = "lineno" > 72< / span > < / div >
< div class = "line" > < a id = "l00079" name = "l00079" > < / a > < span class = "lineno" > 79< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00080" name = "l00080" > < / a > < span class = "lineno" > 80< / span > std::map< atomic::Species, double> massFractions< / div >
< div class = "line" > < a id = "l00081" name = "l00081" > < / a > < span class = "lineno" > 81< / span > );< / div >
< div class = "line" > < a id = "l00082" name = "l00082" > < / a > < span class = "lineno" > 82< / span > < / div >
< div class = "line" > < a id = "l00089" name = "l00089" > < / a > < span class = "lineno" > 89< / span > < a class = "code hl_class" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > buildCompositionFromMassFractions< / a > (< / div >
< div class = "line" > < a id = "l00090" name = "l00090" > < / a > < span class = "lineno" > 90< / span > std::map< std::string, double> massFractions< / div >
< div class = "line" > < a id = "l00091" name = "l00091" > < / a > < span class = "lineno" > 91< / span > );< / div >
< div class = "line" > < a id = "l00092" name = "l00092" > < / a > < span class = "lineno" > 92< / span > < / div >
< div class = "line" > < a id = "l00093" name = "l00093" > < / a > < span class = "lineno" > 93< / span > std::optional< fourdst::atomic::Species> < a class = "code hl_function" href = "namespacefourdst_1_1composition.html#adcc2e4ca25ab7b93983730fc78f4deea" > getSpecies< / a > (< span class = "keyword" > const< / span > std::string& symbol);< / div >
< div class = "line" > < a id = "l00094" name = "l00094" > < / a > < span class = "lineno" > 94< / span > }< / div >
2026-05-18 10:04:49 -04:00
< div class = "ttc" id = "aatomic_species_8h_html" > < div class = "ttname" > < a href = "atomic_species_8h.html" > atomicSpecies.h< / a > < / div > < / div >
2026-05-18 10:08:43 -04:00
< div class = "ttc" id = "aclassfourdst_1_1composition_1_1_composition_html" > < div class = "ttname" > < a href = "classfourdst_1_1composition_1_1_composition.html" > fourdst::composition::Composition< / a > < / div > < div class = "ttdoc" > Manages a collection of chemical species and their abundances.< / div > < div class = "ttdef" > < b > Definition< / b > < a href = "composition_8h_source.html#l00099" > composition.h:99< / a > < / div > < / div >
2026-05-18 10:04:49 -04:00
< div class = "ttc" id = "acomposition_8h_html" > < div class = "ttname" > < a href = "composition_8h.html" > composition.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespacefourdst_1_1composition_html" > < div class = "ttname" > < a href = "namespacefourdst_1_1composition.html" > fourdst::composition< / a > < / div > < div class = "ttdoc" > Utilities and types for representing and manipulating chemical compositions.< / div > < / div >
2026-05-18 10:08:43 -04:00
< div class = "ttc" id = "anamespacefourdst_1_1composition_html_aa90b1ef07d607c0c829bedccf381cf54" > < div class = "ttname" > < a href = "namespacefourdst_1_1composition.html#aa90b1ef07d607c0c829bedccf381cf54" > fourdst::composition::buildCompositionFromMassFractions< / a > < / div > < div class = "ttdeci" > Composition buildCompositionFromMassFractions(const std::vector< std::string > & symbols, const std::vector< double > & massFractions)< / div > < div class = "ttdoc" > Build a Composition object from symbols and their corresponding mass fractions.< / div > < div class = "ttdef" > < b > Definition< / b > < a href = "utils_8cpp_source.html#l00077" > utils.cpp:77< / a > < / div > < / div >
< div class = "ttc" id = "anamespacefourdst_1_1composition_html_adcc2e4ca25ab7b93983730fc78f4deea" > < div class = "ttname" > < a href = "namespacefourdst_1_1composition.html#adcc2e4ca25ab7b93983730fc78f4deea" > fourdst::composition::getSpecies< / a > < / div > < div class = "ttdeci" > std::optional< fourdst::atomic::Species > getSpecies(const std::string & symbol)< / div > < div class = "ttdef" > < b > Definition< / b > < a href = "utils_8cpp_source.html#l00189" > utils.cpp:189< / a > < / div > < / div >
2026-05-18 10:04:49 -04:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2026-06-12 10:49:27 -04:00
< li class = "navelem" > < a class = "el" href = "dir_68267d1309a1af8e8297ef4c3efbcdba.html" > src< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_425afc2e69e55565110382214454a15b.html" > composition< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_cb6fc2f7165eff3b2362b2440dfaea8e.html" > include< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_3c9efac6790a3720e63e1a08c00d11f2.html" > fourdst< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.html" > composition< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_d6630bab6c58db28bc1f1c304498b57d.html" > utils< / a > < / li > < li class = "navelem" > < a class = "el" href = "utils_8h.html" > utils.h< / a > < / li >
2026-05-18 10:04:49 -04:00
< 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 >
