Files
musrfit/doc/technical/html/structtheo__data__base.html
Gitea Actions 8a8eac55b7 Deploy site
2025-12-27 12:57:44 +00:00

253 lines
13 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: theo_data_base Struct 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.9.9</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('structtheo__data__base.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structtheo__data__base-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">theo_data_base Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="PTheory_8h_source.html">PTheory.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4e1847b39a2ca069127310441bbff843" id="r_a4e1847b39a2ca069127310441bbff843"><td class="memItemLeft" align="right" valign="top">UInt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e1847b39a2ca069127310441bbff843">fType</a></td></tr>
<tr class="memdesc:a4e1847b39a2ca069127310441bbff843"><td class="mdescLeft">&#160;</td><td class="mdescRight">Theory function type tag (THEORY_CONST, THEORY_SIMPLE_EXP, etc.) <br /></td></tr>
<tr class="separator:a4e1847b39a2ca069127310441bbff843"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9452abbff02621100e345bfe7251373f" id="r_a9452abbff02621100e345bfe7251373f"><td class="memItemLeft" align="right" valign="top">UInt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9452abbff02621100e345bfe7251373f">fNoOfParam</a></td></tr>
<tr class="memdesc:a9452abbff02621100e345bfe7251373f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of parameters (excluding optional time shift) <br /></td></tr>
<tr class="separator:a9452abbff02621100e345bfe7251373f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a869db8cea9b0d40e636a60cd572510e5" id="r_a869db8cea9b0d40e636a60cd572510e5"><td class="memItemLeft" align="right" valign="top">Bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a869db8cea9b0d40e636a60cd572510e5">fTable</a></td></tr>
<tr class="memdesc:a869db8cea9b0d40e636a60cd572510e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if function requires pre-calculated lookup table (e.g., LF Kubo-Toyabe) <br /></td></tr>
<tr class="separator:a869db8cea9b0d40e636a60cd572510e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff8f521d668be62ab901efd980f40921" id="r_aff8f521d668be62ab901efd980f40921"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff8f521d668be62ab901efd980f40921">fName</a></td></tr>
<tr class="memdesc:aff8f521d668be62ab901efd980f40921"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full function name for MSR files (e.g., "simplExpo", "statGssKt") <br /></td></tr>
<tr class="separator:aff8f521d668be62ab901efd980f40921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba5f7b28920de0d479693998f8e7754" id="r_aaba5f7b28920de0d479693998f8e7754"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaba5f7b28920de0d479693998f8e7754">fAbbrev</a></td></tr>
<tr class="memdesc:aaba5f7b28920de0d479693998f8e7754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short abbreviation (e.g., "se", "stg") <br /></td></tr>
<tr class="separator:aaba5f7b28920de0d479693998f8e7754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab333f584c14a313226f289665c5806fc" id="r_ab333f584c14a313226f289665c5806fc"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab333f584c14a313226f289665c5806fc">fComment</a></td></tr>
<tr class="memdesc:ab333f584c14a313226f289665c5806fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter list shown as help text in MSR file. <br /></td></tr>
<tr class="separator:ab333f584c14a313226f289665c5806fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73641f8051552e07e96e72d3434ecfba" id="r_a73641f8051552e07e96e72d3434ecfba"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73641f8051552e07e96e72d3434ecfba">fCommentTimeShift</a></td></tr>
<tr class="memdesc:a73641f8051552e07e96e72d3434ecfba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter list with time shift included. <br /></td></tr>
<tr class="separator:a73641f8051552e07e96e72d3434ecfba"><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>Database entry for a theory function definition.</p>
<p>This structure stores metadata about each built-in theory function, including its identifier, parameter count, name, abbreviation, and help text. The database is used for:</p><ul>
<li>Parsing THEORY block entries in MSR files</li>
<li>Validating parameter counts</li>
<li>Generating help text and documentation</li>
<li>Writing theory blocks with correct syntax </li>
</ul>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00226">226</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aaba5f7b28920de0d479693998f8e7754" name="aaba5f7b28920de0d479693998f8e7754"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba5f7b28920de0d479693998f8e7754">&#9670;&#160;</a></span>fAbbrev</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TString theo_data_base::fAbbrev</td>
</tr>
</table>
</div><div class="memdoc">
<p>Short abbreviation (e.g., "se", "stg") </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00231">231</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="ab333f584c14a313226f289665c5806fc" name="ab333f584c14a313226f289665c5806fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab333f584c14a313226f289665c5806fc">&#9670;&#160;</a></span>fComment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TString theo_data_base::fComment</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter list shown as help text in MSR file. </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00232">232</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="a73641f8051552e07e96e72d3434ecfba" name="a73641f8051552e07e96e72d3434ecfba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73641f8051552e07e96e72d3434ecfba">&#9670;&#160;</a></span>fCommentTimeShift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TString theo_data_base::fCommentTimeShift</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter list with time shift included. </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00233">233</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="aff8f521d668be62ab901efd980f40921" name="aff8f521d668be62ab901efd980f40921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8f521d668be62ab901efd980f40921">&#9670;&#160;</a></span>fName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TString theo_data_base::fName</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full function name for MSR files (e.g., "simplExpo", "statGssKt") </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00230">230</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="a9452abbff02621100e345bfe7251373f" name="a9452abbff02621100e345bfe7251373f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9452abbff02621100e345bfe7251373f">&#9670;&#160;</a></span>fNoOfParam</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UInt_t theo_data_base::fNoOfParam</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of parameters (excluding optional time shift) </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00228">228</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="a869db8cea9b0d40e636a60cd572510e5" name="a869db8cea9b0d40e636a60cd572510e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a869db8cea9b0d40e636a60cd572510e5">&#9670;&#160;</a></span>fTable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t theo_data_base::fTable</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if function requires pre-calculated lookup table (e.g., LF Kubo-Toyabe) </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00229">229</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<a id="a4e1847b39a2ca069127310441bbff843" name="a4e1847b39a2ca069127310441bbff843"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e1847b39a2ca069127310441bbff843">&#9670;&#160;</a></span>fType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UInt_t theo_data_base::fType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Theory function type tag (THEORY_CONST, THEORY_SIMPLE_EXP, etc.) </p>
<p class="definition">Definition at line <a class="el" href="PTheory_8h_source.html#l00227">227</a> of file <a class="el" href="PTheory_8h_source.html">PTheory.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/workspace/LMU/musrfit/src/include/<a class="el" href="PTheory_8h_source.html">PTheory.h</a></li>
</ul>
</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="structtheo__data__base.html">theo_data_base</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>