Files
musrfit/doc/technical/html/namespacemusrfit.html
T
Gitea Actions b6fac619f9 Deploy site
2026-05-28 07:32:41 +00:00

144 lines
7.7 KiB
HTML

<!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>musrfit: musrfit 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="doxygen.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">musrfit<span id="projectnumber">&#160;1.10.0</span>
</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',true);
});
/* @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&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespacemusrfit.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">musrfit Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Top-level namespace for musrfit components.
<a href="#details">More...</a></p>
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemusrfit_1_1grammar.html">grammar</a></td></tr>
<tr class="memdesc:namespacemusrfit_1_1grammar"><td class="mdescLeft">&#160;</td><td class="mdescRight">Boost.Spirit X3 grammar definitions for parsing function expressions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:afbc128df07f815e520ef1ce4efd123f4" id="r_afbc128df07f815e520ef1ce4efd123f4"><td class="memItemLeft" align="right" valign="top">auto const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afbc128df07f815e520ef1ce4efd123f4">function_grammar</a> ()</td></tr>
<tr class="memdesc:afbc128df07f815e520ef1ce4efd123f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the top-level grammar rule. <br /></td></tr>
<tr class="separator:afbc128df07f815e520ef1ce4efd123f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Top-level namespace for musrfit components. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="afbc128df07f815e520ef1ce4efd123f4" name="afbc128df07f815e520ef1ce4efd123f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc128df07f815e520ef1ce4efd123f4">&#9670;&#160;</a></span>function_grammar()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto const &amp; musrfit::function_grammar </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the top-level grammar rule. </p>
<p>Returns a reference to the assignment rule, which is the entry point for parsing complete function assignment statements (FUN# = expression). Use this function to obtain the grammar for parsing with Spirit X3.</p>
<dl class="section return"><dt>Returns</dt><dd>Constant reference to the assignment grammar rule</dd></dl>
<div class="fragment"><div class="line"><span class="keyword">auto</span> <span class="keyword">const</span>&amp; <a class="code hl_namespace" href="namespacemusrfit_1_1grammar.html">grammar</a> = <a class="code hl_function" href="#afbc128df07f815e520ef1ce4efd123f4">musrfit::function_grammar</a>();</div>
<div class="line"><span class="keywordtype">bool</span> success = x3::phrase_parse(iter, end, <a class="code hl_namespace" href="namespacemusrfit_1_1grammar.html">grammar</a>, x3::space, result);</div>
<div class="ttc" id="anamespacemusrfit_1_1grammar_html"><div class="ttname"><a href="namespacemusrfit_1_1grammar.html">musrfit::grammar</a></div><div class="ttdoc">Boost.Spirit X3 grammar definitions for parsing function expressions.</div></div>
<div class="ttc" id="anamespacemusrfit_html_afbc128df07f815e520ef1ce4efd123f4"><div class="ttname"><a href="#afbc128df07f815e520ef1ce4efd123f4">musrfit::function_grammar</a></div><div class="ttdeci">auto const &amp; function_grammar()</div><div class="ttdoc">Provides access to the top-level grammar rule.</div><div class="ttdef"><b>Definition</b> <a href="PFunctionGrammar_8h_source.html#l00322">PFunctionGrammar.h:322</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="PFunctionGrammar_8h_source.html#l00322">322</a> of file <a class="el" href="PFunctionGrammar_8h_source.html">PFunctionGrammar.h</a>.</p>
<p class="reference">References <a class="el" href="PFunctionGrammar_8h_source.html#l00156">musrfit::grammar::assignment</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFunctionHandler_8cpp_source.html#l00071">PFunctionHandler::DoParse()</a>.</p>
</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="namespacemusrfit.html">musrfit</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>