LMU/musrfit
5
1
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 6 Activity

Deploy site

Browse Source
This commit is contained in:
Gitea Actions
2026-07-31 18:47:29 +00:00
commit 14cabbd87e
7362 changed files with 1013220 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/technical/html/classPStringUtils.html
+529
View File
@@ -0,0 +1,529 @@
<!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: PStringUtils Class 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('classPStringUtils.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classPStringUtils-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PStringUtils Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Lightweight, dependency-free string utilities (pure C++17).
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PStringUtils_8h_source.html">PStringUtils.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac2b4760e3cc9002a026c67c8c7489e35" id="r_ac2b4760e3cc9002a026c67c8c7489e35"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2b4760e3cc9002a026c67c8c7489e35">Split</a> (const std::string &amp;str, const std::string &amp;delimiters)</td></tr>
<tr class="separator:ac2b4760e3cc9002a026c67c8c7489e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd8838b900f8efe114a368e42562d5d" id="r_acbd8838b900f8efe114a368e42562d5d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbd8838b900f8efe114a368e42562d5d">IsInt</a> (const std::string &amp;str)</td></tr>
<tr class="separator:acbd8838b900f8efe114a368e42562d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a413815c60b44c69ce8cd5b6ddc644a8d" id="r_a413815c60b44c69ce8cd5b6ddc644a8d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a413815c60b44c69ce8cd5b6ddc644a8d">IsFloat</a> (const std::string &amp;str)</td></tr>
<tr class="separator:a413815c60b44c69ce8cd5b6ddc644a8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c616ea1109cd8d04bdb7480ba9d7648" id="r_a7c616ea1109cd8d04bdb7480ba9d7648"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c616ea1109cd8d04bdb7480ba9d7648">ToInt</a> (const std::string &amp;str, bool *ok=nullptr)</td></tr>
<tr class="separator:a7c616ea1109cd8d04bdb7480ba9d7648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac490a54bfa85eb62b8467a4673da861a" id="r_ac490a54bfa85eb62b8467a4673da861a"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac490a54bfa85eb62b8467a4673da861a">ToDouble</a> (const std::string &amp;str, bool *ok=nullptr)</td></tr>
<tr class="separator:ac490a54bfa85eb62b8467a4673da861a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa84dac82be2a41e915c77f30f98292b" id="r_aaa84dac82be2a41e915c77f30f98292b"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa84dac82be2a41e915c77f30f98292b">IsEqualNoCase</a> (const std::string &amp;a, const std::string &amp;b)</td></tr>
<tr class="separator:aaa84dac82be2a41e915c77f30f98292b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b15c9ae5e30d0e17d4aa8ea085bc1b7" id="r_a4b15c9ae5e30d0e17d4aa8ea085bc1b7"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b15c9ae5e30d0e17d4aa8ea085bc1b7">ContainsNoCase</a> (const std::string &amp;haystack, const std::string &amp;needle)</td></tr>
<tr class="separator:a4b15c9ae5e30d0e17d4aa8ea085bc1b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94e4c79eec2da834c4d22f337693359c" id="r_a94e4c79eec2da834c4d22f337693359c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94e4c79eec2da834c4d22f337693359c">BeginsWithNoCase</a> (const std::string &amp;str, const std::string &amp;prefix)</td></tr>
<tr class="separator:a94e4c79eec2da834c4d22f337693359c"><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>Lightweight, dependency-free string utilities (pure C++17). </p>
<p><a class="el" href="classPStringUtils.html" title="Lightweight, dependency-free string utilities (pure C++17).">PStringUtils</a> collects small string helpers used throughout the musrfit suite, in particular for tokenizing and parsing the plain-text MSR file format. The implementation deliberately relies only on the C++ standard library (no ROOT) so that it can be reused freely.</p>
<p>The provided helpers replicate the semantics of the corresponding ROOT TString methods that were previously used:</p><ul>
<li>Split replaces TString::Tokenize() (+ TObjArray/TObjString)</li>
<li>IsInt replaces TString::IsDigit()</li>
<li>IsFloat replaces TString::IsFloat()</li>
<li>ToInt replaces TString::Atoi()</li>
<li>ToDouble replaces TString::Atof()</li>
<li>IsEqualNoCase replaces TString::CompareTo(..., TString::kIgnoreCase)</li>
</ul>
<p>All methods are static; the class is a pure namespace-like utility. </p>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8h_source.html#l00056">56</a> of file <a class="el" href="PStringUtils_8h_source.html">PStringUtils.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a94e4c79eec2da834c4d22f337693359c" name="a94e4c79eec2da834c4d22f337693359c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94e4c79eec2da834c4d22f337693359c">&#9670;&#160;</a></span>BeginsWithNoCase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PStringUtils::BeginsWithNoCase </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>prefix</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Case-insensitive prefix test. Mirrors TString::BeginsWith(..., TString::kIgnoreCase).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be tested </td></tr>
<tr><td class="paramname">prefix</td><td>prefix to be searched for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str starts with prefix ignoring case</dd></dl>
<p>Case-insensitive prefix test, mirroring TString::BeginsWith(..., TString::kIgnoreCase).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be tested </td></tr>
<tr><td class="paramname">prefix</td><td>prefix to be searched for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str starts with prefix ignoring case </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00265">265</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l04521">PMsrHandler::HandlePlotEntry()</a>.</p>
</div>
</div>
<a id="a4b15c9ae5e30d0e17d4aa8ea085bc1b7" name="a4b15c9ae5e30d0e17d4aa8ea085bc1b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b15c9ae5e30d0e17d4aa8ea085bc1b7">&#9670;&#160;</a></span>ContainsNoCase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PStringUtils::ContainsNoCase </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>haystack</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>needle</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Case-insensitive substring search. Mirrors TString::Contains(..., TString::kIgnoreCase).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">haystack</td><td>string to be searched in </td></tr>
<tr><td class="paramname">needle</td><td>substring to be searched for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if needle is contained in haystack ignoring case</dd></dl>
<p>Case-insensitive substring search, mirroring TString::Contains(..., TString::kIgnoreCase).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">haystack</td><td>string to be searched in </td></tr>
<tr><td class="paramname">needle</td><td>substring to be searched for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if needle is contained in haystack ignoring case </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00235">235</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l05993">PMsrHandler::CheckFuncs()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05899">PMsrHandler::CheckMaps()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l04521">PMsrHandler::HandlePlotEntry()</a>.</p>
</div>
</div>
<a id="aaa84dac82be2a41e915c77f30f98292b" name="aaa84dac82be2a41e915c77f30f98292b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa84dac82be2a41e915c77f30f98292b">&#9670;&#160;</a></span>IsEqualNoCase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PStringUtils::IsEqualNoCase </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>b</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Case-insensitive full-string equality. Mirrors TString::CompareTo(..., TString::kIgnoreCase) == 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>first string </td></tr>
<tr><td class="paramname">b</td><td>second string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a and b are equal ignoring case</dd></dl>
<p>Case-insensitive full-string equality, mirroring TString::CompareTo(..., TString::kIgnoreCase) == 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>first string </td></tr>
<tr><td class="paramname">b</td><td>second string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a and b are equal ignoring case </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00212">212</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02835">PMsrHandler::HandleFitParameterEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04246">PMsrHandler::HandleFourierEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03075">PMsrHandler::HandleGlobalEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>, <a class="el" href="PMusrCanvas_8cpp_source.html#l06428">PMusrCanvas::IsScaleN0AndBkg()</a>, and <a class="el" href="PRunSingleHisto_8cpp_source.html#l02416">PRunSingleHisto::IsScaleN0AndBkg()</a>.</p>
</div>
</div>
<a id="a413815c60b44c69ce8cd5b6ddc644a8d" name="a413815c60b44c69ce8cd5b6ddc644a8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413815c60b44c69ce8cd5b6ddc644a8d">&#9670;&#160;</a></span>IsFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PStringUtils::IsFloat </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the string is a complete integer or floating point literal (optionally signed, with decimal point and/or exponent). Mirrors TString::IsFloat() for the relevant cases.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be checked </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str is a valid number</dd></dl>
<p>Returns true if the string is a complete integer or floating point literal (optionally signed, with decimal point and/or exponent). Mirrors the semantics of TString::IsFloat() for the relevant cases.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be checked </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str is a valid number </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00111">111</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l03075">PMsrHandler::HandleGlobalEntry()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>.</p>
</div>
</div>
<a id="acbd8838b900f8efe114a368e42562d5d" name="acbd8838b900f8efe114a368e42562d5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbd8838b900f8efe114a368e42562d5d">&#9670;&#160;</a></span>IsInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PStringUtils::IsInt </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the string is a (possibly signed) integer literal, i.e. a non-empty sequence of decimal digits with an optional single leading sign (+/-). Slightly more permissive than TString::IsDigit(), which rejects a sign, so that e.g. "-5" is also recognised.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be checked </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str is a (possibly signed) integer</dd></dl>
<p>Returns true if the string is an integer literal, i.e. a non-empty sequence of decimal digits with an optional single leading sign (+/-). This is slightly more permissive than TString::IsDigit(), which rejects a sign, so that negative/positive integers such as "-5" or "+42" are also recognised.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be checked </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if str is a (possibly signed) integer </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00077">77</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l05235">PMsrHandler::FillParameterInUse()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05058">PMsrHandler::GetNoOfFitParameters()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>, <a class="el" href="PStartupHandler_8cpp_source.html#l00451">PStartupHandler::OnCharacters()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l00443">PMsrHandler::WriteMsrLogFile()</a>.</p>
</div>
</div>
<a id="ac2b4760e3cc9002a026c67c8c7489e35" name="ac2b4760e3cc9002a026c67c8c7489e35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2b4760e3cc9002a026c67c8c7489e35">&#9670;&#160;</a></span>Split()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; std::string &gt; PStringUtils::Split </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>delimiters</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Splits a string into tokens on any character contained in delimiters, skipping empty tokens. Mirrors TString::Tokenize().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>input string to be tokenized </td></tr>
<tr><td class="paramname">delimiters</td><td>set of delimiter characters </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vector of tokens (without the delimiters)</dd></dl>
<p>Splits a string into tokens on any character contained in delimiters, skipping empty tokens. Mirrors the semantics of TString::Tokenize().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>input string to be tokenized </td></tr>
<tr><td class="paramname">delimiters</td><td>set of delimiter characters </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vector of tokens (without the delimiters) </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00048">48</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFitter_8cpp_source.html#l00931">PFitter::CheckCommands()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05993">PMsrHandler::CheckFuncs()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05899">PMsrHandler::CheckMaps()</a>, <a class="el" href="PFitter_8cpp_source.html#l01571">PFitter::ExecuteFitRange()</a>, <a class="el" href="PFitter_8cpp_source.html#l01637">PFitter::ExecuteFix()</a>, <a class="el" href="PFitter_8cpp_source.html#l01959">PFitter::ExecutePrintLevel()</a>, <a class="el" href="PFitter_8cpp_source.html#l02010">PFitter::ExecuteRelease()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l01245">PRunDataHandler::FileExistsCheck()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l01334">PRunDataHandler::FileExistsCheck()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l01050">PRunDataHandler::FileExistsCheck()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l06351">PRunDataHandler::FileNameFromTemplate()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05235">PMsrHandler::FillParameterInUse()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05058">PMsrHandler::GetNoOfFitParameters()</a>, <a class="el" href="PFitter_8cpp_source.html#l00478">PFitter::GetParFromFun()</a>, <a class="el" href="PFitter_8cpp_source.html#l00389">PFitter::GetPhaseParams()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l02835">PMsrHandler::HandleFitParameterEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04246">PMsrHandler::HandleFourierEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03075">PMsrHandler::HandleGlobalEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04521">PMsrHandler::HandlePlotEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>, <a class="el" href="PMusrCanvas_8cpp_source.html#l06428">PMusrCanvas::IsScaleN0AndBkg()</a>, <a class="el" href="PRunSingleHisto_8cpp_source.html#l02416">PRunSingleHisto::IsScaleN0AndBkg()</a>, <a class="el" href="PTheory_8cpp_source.html#l01011">PTheory::MakeCleanAndTidyPolynom()</a>, <a class="el" href="PTheory_8cpp_source.html#l00922">PTheory::MakeCleanAndTidyTheoryBlock()</a>, <a class="el" href="PTheory_8cpp_source.html#l01064">PTheory::MakeCleanAndTidyUserFcn()</a>, <a class="el" href="msr2msr_8cpp_source.html#l00145">msr2msr_param()</a>, <a class="el" href="msr2msr_8cpp_source.html#l00085">msr2msr_run()</a>, <a class="el" href="msr2msr_8cpp_source.html#l00248">msr2msr_theory()</a>, <a class="el" href="musrFT_8cpp_source.html#l00205">musrFT_filter_histo()</a>, <a class="el" href="PStartupHandler_8cpp_source.html#l00451">PStartupHandler::OnCharacters()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04141">PMsrHandler::ParseFourierPhaseParIterVector()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04046">PMsrHandler::ParseFourierPhaseParVector()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03995">PMsrHandler::ParseFourierPhaseValueVector()</a>, <a class="el" href="PTheory_8cpp_source.html#l00125">PTheory::PTheory()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l03308">PRunDataHandler::ReadAsciiFile()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l03920">PRunDataHandler::ReadDatFile()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l03615">PRunDataHandler::ReadDBFile()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l03026">PRunDataHandler::ReadMduAsciiFile()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l01393">PRunDataHandler::ReadRootFile()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l02129">PRunDataHandler::ReadWkmFile()</a>, <a class="el" href="PRunAsymmetry_8cpp_source.html#l00415">PRunAsymmetry::SetFitRangeBin()</a>, <a class="el" href="PRunAsymmetryBNMR_8cpp_source.html#l00426">PRunAsymmetryBNMR::SetFitRangeBin()</a>, <a class="el" href="PRunAsymmetryRRF_8cpp_source.html#l00415">PRunAsymmetryRRF::SetFitRangeBin()</a>, <a class="el" href="PRunMuMinus_8cpp_source.html#l00450">PRunMuMinus::SetFitRangeBin()</a>, <a class="el" href="PRunSingleHisto_8cpp_source.html#l00846">PRunSingleHisto::SetFitRangeBin()</a>, <a class="el" href="PRunSingleHistoRRF_8cpp_source.html#l00530">PRunSingleHistoRRF::SetFitRangeBin()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l00443">PMsrHandler::WriteMsrLogFile()</a>.</p>
</div>
</div>
<a id="ac490a54bfa85eb62b8467a4673da861a" name="ac490a54bfa85eb62b8467a4673da861a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac490a54bfa85eb62b8467a4673da861a">&#9670;&#160;</a></span>ToDouble()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double PStringUtils::ToDouble </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>ok</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the leading part of the string to a double. Mirrors TString::Atof(). Returns 0.0 if no conversion is possible.</p>
<p>If <em class="arg">ok</em> is non-null it is set to true when a value was parsed and to false on error (no number, or value out of range), allowing callers to distinguish a legitimate 0.0 from a failed conversion.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be converted </td></tr>
<tr><td class="paramname">ok</td><td>optional out-parameter signalling conversion success </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>converted double value (0.0 on error)</dd></dl>
<p>Converts the leading part of the string to a double, mirroring TString::Atof(). Returns 0.0 if no conversion is possible.</p>
<p>Like <a class="el" href="#a7c616ea1109cd8d04bdb7480ba9d7648">ToInt()</a>, conversion errors can be reported through the optional <em class="arg">ok</em> out-parameter: it is set to true when a value was parsed and to false otherwise (no number present, or the value is out of range). This lets callers distinguish a legitimate 0.0 from a failed conversion. strtod() (rather than std::from_chars) is used so that the accepted input set stays identical to TString::Atof() (leading whitespace is skipped, a leading '+' is honoured, trailing characters are ignored). A null <em class="arg">ok</em> preserves the historic fire-and-forget behaviour.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be converted </td></tr>
<tr><td class="paramname">ok</td><td>optional out-parameter signalling conversion success </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>converted double value (0.0 on error) </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00189">189</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02835">PMsrHandler::HandleFitParameterEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04246">PMsrHandler::HandleFourierEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03075">PMsrHandler::HandleGlobalEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04521">PMsrHandler::HandlePlotEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l03995">PMsrHandler::ParseFourierPhaseValueVector()</a>.</p>
</div>
</div>
<a id="a7c616ea1109cd8d04bdb7480ba9d7648" name="a7c616ea1109cd8d04bdb7480ba9d7648"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c616ea1109cd8d04bdb7480ba9d7648">&#9670;&#160;</a></span>ToInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int PStringUtils::ToInt </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>ok</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the leading part of the string to an int (base 10). Mirrors TString::Atoi(). Returns 0 if no conversion is possible.</p>
<p>If <em class="arg">ok</em> is non-null it is set to true when a valid integer was parsed and to false on error (no digits, or value out of int range). This allows callers to distinguish a legitimate 0 from a failed conversion, which the bare return value cannot express.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be converted </td></tr>
<tr><td class="paramname">ok</td><td>optional out-parameter signalling conversion success </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>converted integer value (0 on error)</dd></dl>
<p>Converts the leading part of the string to an int (base 10), mirroring TString::Atoi(). Returns 0 if no conversion is possible.</p>
<p>Uses std::from_chars so that conversion errors can be reported through the optional <em class="arg">ok</em> out-parameter: it is set to true when a valid integer was parsed (leading whitespace is skipped) and to false otherwise (no digits present, or the value is out of int range). Trailing non-numeric characters are ignored, as with TString::Atoi(). A null <em class="arg">ok</em> preserves the historic fire-and-forget behaviour.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>string to be converted </td></tr>
<tr><td class="paramname">ok</td><td>optional out-parameter signalling conversion success </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>converted integer value (0 on error) </dd></dl>
<p class="definition">Definition at line <a class="el" href="PStringUtils_8cpp_source.html#l00152">152</a> of file <a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l05235">PMsrHandler::FillParameterInUse()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l05058">PMsrHandler::GetNoOfFitParameters()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l02835">PMsrHandler::HandleFitParameterEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04246">PMsrHandler::HandleFourierEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03075">PMsrHandler::HandleGlobalEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04521">PMsrHandler::HandlePlotEntry()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l03298">PMsrHandler::HandleRunEntry()</a>, <a class="el" href="PStartupHandler_8cpp_source.html#l00451">PStartupHandler::OnCharacters()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04141">PMsrHandler::ParseFourierPhaseParIterVector()</a>, <a class="el" href="PMsrHandler_8cpp_source.html#l04046">PMsrHandler::ParseFourierPhaseParVector()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l00443">PMsrHandler::WriteMsrLogFile()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/LMU/musrfit/src/include/<a class="el" href="PStringUtils_8h_source.html">PStringUtils.h</a></li>
<li>/workspace/LMU/musrfit/src/classes/<a class="el" href="PStringUtils_8cpp_source.html">PStringUtils.cpp</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="classPStringUtils.html">PStringUtils</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>