2025-07-24 09:35:52 -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" / >
< title > fourdst::libcomposition: fourdst::composition Namespace Reference< / title >
< 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" >
< div id = "projectname" > fourdst::libcomposition< span id = "projectnumber" >   v1.5.2< / span >
< / 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('namespacefourdst_1_1composition.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 = "summary" >
< a href = "#namespaces" > Namespaces< / a > |
< a href = "#nested-classes" > Classes< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" > < div class = "title" > fourdst::composition Namespace Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "namespaces" name = "namespaces" > < / a >
Namespaces< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacefourdst_1_1composition_1_1exceptions.html" > exceptions< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "nested-classes" name = "nested-classes" > < / a >
Classes< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfourdst_1_1composition_1_1_canonical_composition.html" > CanonicalComposition< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Represents the canonical (X, Y, Z) composition of stellar material. < a href = "structfourdst_1_1composition_1_1_canonical_composition.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Manages a collection of chemical species and their abundances. < a href = "classfourdst_1_1composition_1_1_composition.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfourdst_1_1composition_1_1_composition_entry.html" > CompositionEntry< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Represents a single entry (an isotope) within a composition. < a href = "structfourdst_1_1composition_1_1_composition_entry.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfourdst_1_1composition_1_1_global_composition.html" > GlobalComposition< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Represents global properties of a finalized composition. < a href = "structfourdst_1_1composition_1_1_global_composition.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a8468dde1b148c0583b8a9f85b8d0ce9a" id = "r_a8468dde1b148c0583b8a9f85b8d0ce9a" > < td class = "memItemLeft" align = "right" valign = "top" > std::ostream &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a8468dde1b148c0583b8a9f85b8d0ce9a" > operator< < < / a > (std::ostream & os, const < a class = "el" href = "structfourdst_1_1composition_1_1_global_composition.html" > GlobalComposition< / a > & comp)< / td > < / tr >
< tr class = "separator:a8468dde1b148c0583b8a9f85b8d0ce9a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a676f771864958c4db4ed2a82cc0e85dd" id = "r_a676f771864958c4db4ed2a82cc0e85dd" > < td class = "memItemLeft" align = "right" valign = "top" > std::ostream &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a676f771864958c4db4ed2a82cc0e85dd" > operator< < < / a > (std::ostream & os, const < a class = "el" href = "structfourdst_1_1composition_1_1_composition_entry.html" > CompositionEntry< / a > & entry)< / td > < / tr >
< tr class = "separator:a676f771864958c4db4ed2a82cc0e85dd" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5e8ccc2bd9e91eebcd3ef5fe470163a1" id = "r_a5e8ccc2bd9e91eebcd3ef5fe470163a1" > < td class = "memItemLeft" align = "right" valign = "top" > std::ostream &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a5e8ccc2bd9e91eebcd3ef5fe470163a1" > operator< < < / a > (std::ostream & os, const < a class = "el" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > & composition)< / td > < / tr >
< tr class = "separator:a5e8ccc2bd9e91eebcd3ef5fe470163a1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "a5e8ccc2bd9e91eebcd3ef5fe470163a1" name = "a5e8ccc2bd9e91eebcd3ef5fe470163a1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5e8ccc2bd9e91eebcd3ef5fe470163a1" > ◆   < / a > < / span > operator< < () < span class = "overload" > [1/3]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::ostream & fourdst::composition::operator< < < / td >
< td > (< / td >
< td class = "paramtype" > std::ostream & < / td > < td class = "paramname" > < span class = "paramname" > < em > os< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "classfourdst_1_1composition_1_1_composition.html" > Composition< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > composition< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > os< / td > < td > The output stream. < / td > < / tr >
< tr > < td class = "paramname" > composition< / td > < td > The < a class = "el" href = "classfourdst_1_1composition_1_1_composition.html" title = "Manages a collection of chemical species and their abundances." > Composition< / a > to output. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > The output stream. < / dd > < / dl >
2025-09-16 11:24:28 -04:00
< p class = "definition" > Definition at line < a class = "el" href = "composition_8cpp_source.html#l00937" > 937< / a > of file < a class = "el" href = "composition_8cpp_source.html" > composition.cpp< / a > .< / p >
2025-07-24 09:35:52 -04:00
< / div >
< / div >
< a id = "a676f771864958c4db4ed2a82cc0e85dd" name = "a676f771864958c4db4ed2a82cc0e85dd" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a676f771864958c4db4ed2a82cc0e85dd" > ◆   < / a > < / span > operator< < () < span class = "overload" > [2/3]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::ostream & fourdst::composition::operator< < < / td >
< td > (< / td >
< td class = "paramtype" > std::ostream & < / td > < td class = "paramname" > < span class = "paramname" > < em > os< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "structfourdst_1_1composition_1_1_composition_entry.html" > CompositionEntry< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > entry< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > os< / td > < td > The output stream. < / td > < / tr >
< tr > < td class = "paramname" > entry< / td > < td > The < a class = "el" href = "structfourdst_1_1composition_1_1_composition_entry.html" title = "Represents a single entry (an isotope) within a composition." > CompositionEntry< / a > to output. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > The output stream. < / dd > < / dl >
2025-09-16 11:24:28 -04:00
< p class = "definition" > Definition at line < a class = "el" href = "composition_8cpp_source.html#l00932" > 932< / a > of file < a class = "el" href = "composition_8cpp_source.html" > composition.cpp< / a > .< / p >
2025-07-24 09:35:52 -04:00
< / div >
< / div >
< a id = "a8468dde1b148c0583b8a9f85b8d0ce9a" name = "a8468dde1b148c0583b8a9f85b8d0ce9a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8468dde1b148c0583b8a9f85b8d0ce9a" > ◆   < / a > < / span > operator< < () < span class = "overload" > [3/3]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::ostream & fourdst::composition::operator< < < / td >
< td > (< / td >
< td class = "paramtype" > std::ostream & < / td > < td class = "paramname" > < span class = "paramname" > < em > os< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "structfourdst_1_1composition_1_1_global_composition.html" > GlobalComposition< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > comp< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-09-16 11:24:28 -04:00
< p class = "definition" > Definition at line < a class = "el" href = "composition_8cpp_source.html#l00925" > 925< / a > of file < a class = "el" href = "composition_8cpp_source.html" > composition.cpp< / a > .< / p >
2025-07-24 09:35:52 -04:00
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "namespacefourdst.html" > fourdst< / a > < / li > < li class = "navelem" > < a class = "el" href = "namespacefourdst_1_1composition.html" > composition< / a > < / li >
< 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 >
