add Doxygen documentation
[o-du/phy.git] / docs / API / structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html
diff --git a/docs/API/structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html b/docs/API/structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html
new file mode 100644 (file)
index 0000000..ad29647
--- /dev/null
@@ -0,0 +1,200 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum 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>
+<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" />
+</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 style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- 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">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a></li><li class="navelem"><b>lexer</b></li><li class="navelem"><a class="el" href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html">strtonum</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>parse string into a built-in arithmetic type as if the current locale is POSIX.  
+ <a href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="json_8hpp_source.html">json.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum__coll__graph.png" border="0" usemap="#basic__json_3_01_object_type_00_01_array_type_00_01_string_type_00_01_boolean_type_00_01_number_integer_type_00_01_number_unsigned_type_00_01_number_float_type_00_01_allocator_type_00_01_j_s_o_n_serializer_01_4_1_1lexer_1_1strtonum_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:ad1858c576c5f6050dd45cc9825a16bb9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html#ad1858c576c5f6050dd45cc9825a16bb9">strtonum</a> (const char *start, const char *<a class="el" href="classnlohmann_1_1basic__json.html#afc5380afa64b233d0df01a147616974b">end</a>)</td></tr>
+<tr class="separator:ad1858c576c5f6050dd45cc9825a16bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab6b353b5dc68fe4151d9d20edecd162c"><td class="memTemplParams" colspan="2">template&lt;typename T , typename  = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </td></tr>
+<tr class="memitem:ab6b353b5dc68fe4151d9d20edecd162c"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html#ab6b353b5dc68fe4151d9d20edecd162c">to</a> (T &amp;val) const</td></tr>
+<tr class="separator:ab6b353b5dc68fe4151d9d20edecd162c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><h3>template&lt;template&lt; typename U, typename V, typename... Args &gt; class ObjectType = std::map, template&lt; typename U, typename... Args &gt; class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template&lt; typename U &gt; class AllocatorType = std::allocator, template&lt; typename T, typename SFINAE=void &gt; class JSONSerializer = adl_serializer&gt;<br />
+struct nlohmann::basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum</h3>
+
+<p>parse string into a built-in arithmetic type as if the current locale is POSIX. </p>
+<dl class="section note"><dt>Note</dt><dd>in floating-point case strtod may parse past the token's end - this is not an error</dd>
+<dd>
+any leading blanks are not handled </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11077">11077</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="ad1858c576c5f6050dd45cc9825a16bb9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad1858c576c5f6050dd45cc9825a16bb9">&#9670;&nbsp;</a></span>strtonum()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html">strtonum</a> </td>
+          <td>(</td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>start</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>end</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11080">11080</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="ab6b353b5dc68fe4151d9d20edecd162c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab6b353b5dc68fe4151d9d20edecd162c">&#9670;&nbsp;</a></span>to()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool to </td>
+          <td>(</td>
+          <td class="paramtype">T &amp;&#160;</td>
+          <td class="paramname"><em>val</em></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<dl class="section return"><dt>Returns</dt><dd>true iff parsed successfully as number of type T</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">val</td><td>shall contain parsed value, or undefined value if could not parse </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11091">11091</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph.png" border="0" usemap="#structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph" alt=""/></div>
+<map name="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph" id="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph">
+<area shape="rect" id="node2" href="classnlohmann_1_1basic__json.html#aa3755192d05bc50d680919b259b69305" title="return whether value is discarded " alt="" coords="99,22,247,63"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_icgraph.png" border="0" usemap="#structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_icgraph" alt=""/></div>
+</div>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="json_8hpp_source.html">json.hpp</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>