Files
musrfit/doc/technical/html/PUserFcn_8cpp.html
2026-10-29 15:47:56 +00:00

151 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.17.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>musrfit: /workspace/LMU/musrfit/src/classes/PUserFcn.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.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="cookie.js"></script>
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
mermaid.initialize({ startOnLoad: true, theme: theme });
</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.12.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.17.0 -->
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', () => {
initMenu('',true);
});
</script>
<div id="main-nav-mobile">
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2" style="float:right">
</li>
</ul>
</div><!-- main-nav -->
</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">
document.addEventListener('DOMContentLoaded',() => { initNavTree('PUserFcn_8cpp.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">PUserFcn.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &quot;<a class="el" href="PUserFcn_8h_source.html">PUserFcn.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for PUserFcn.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="PUserFcn_8cpp__incl.png" border="0" usemap="#a_2workspace_2LMU_2musrfit_2src_2classes_2PUserFcn_8cpp" loading="lazy" alt=""/></div>
<map name="a_2workspace_2LMU_2musrfit_2src_2classes_2PUserFcn_8cpp" id="a_2workspace_2LMU_2musrfit_2src_2classes_2PUserFcn_8cpp">
<area shape="rect" title=" " alt="" coords="5,5,183,50"/>
<area shape="rect" title=" " alt="" coords="13,98,76,126"/>
<area shape="poly" title=" " alt="" coords="83,52,63,86,58,83,79,49"/>
<area shape="rect" href="PUserFcn_8h.html" title=" " alt="" coords="100,98,189,126"/>
<area shape="poly" title=" " alt="" coords="110,49,131,83,126,86,105,52"/>
<area shape="rect" title=" " alt="" coords="69,249,127,277"/>
<area shape="poly" title=" " alt="" coords="142,127,125,174,107,235,102,234,119,173,137,125"/>
<area shape="rect" href="PUserFcnBase_8h.html" title=" " alt="" coords="134,174,251,201"/>
<area shape="poly" title=" " alt="" coords="155,125,178,159,174,162,151,128"/>
<area shape="poly" title=" " alt="" coords="177,204,128,242,125,238,174,200"/>
<area shape="rect" title=" " alt="" coords="152,249,231,277"/>
<area shape="poly" title=" " alt="" coords="195,202,195,234,189,234,190,202"/>
<area shape="rect" title=" " alt="" coords="255,249,357,277"/>
<area shape="poly" title=" " alt="" coords="214,200,275,239,272,243,211,204"/>
</map>
</div>
</div>
<p><a href="PUserFcn_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad27e2eca13709d3e44196a3aa4ac9d1b" id="r_ad27e2eca13709d3e44196a3aa4ac9d1b"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#ad27e2eca13709d3e44196a3aa4ac9d1b">ClassImp</a> (<a class="el" href="classPUserFcn.html">PUserFcn</a>) <a class="el" href="classPUserFcn.html">PUserFcn</a></td></tr>
<tr class="memdesc:ad27e2eca13709d3e44196a3aa4ac9d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for <a class="el" href="classPUserFcn.html" title="Example user function implementing a third-order polynomial.">PUserFcn</a>. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ad27e2eca13709d3e44196a3aa4ac9d1b" name="ad27e2eca13709d3e44196a3aa4ac9d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad27e2eca13709d3e44196a3aa4ac9d1b">&#9670;&#160;</a></span>ClassImp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ClassImp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPUserFcn.html">PUserFcn</a></td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor for <a class="el" href="classPUserFcn.html" title="Example user function implementing a third-order polynomial.">PUserFcn</a>. </p>
<p>Initializes a third-order polynomial user function. This implementation requires no special initialization as it has no internal state - all computation is done directly in the operator() method.</p>
<dl class="section note"><dt>Note</dt><dd>This simple constructor serves as a template for more complex user functions. Functions requiring initialization (e.g., loading lookup tables, precomputing constants) should perform that work here or in SetGlobalPart(). </dd></dl>
<p class="definition">Definition at line <a class="el" href="PUserFcn_8cpp_source.html#l00034">34</a> of file <a class="el" href="PUserFcn_8cpp_source.html">PUserFcn.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="dir_018e9aafb459e6e1a4953404cb0c0b1d.html">classes</a></li><li class="navelem"><a href="PUserFcn_8cpp.html">PUserFcn.cpp</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.17.0 </li>
</ul>
</div>
</body>
</html>