add Doxygen documentation
[o-du/phy.git] / docs / API / structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 <div id="nav-path" class="navpath">
61   <ul>
62 <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>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="summary">
67 <a href="#pub-methods">Public Member Functions</a>  </div>
68   <div class="headertitle">
69 <div class="title">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum Struct Reference</div>  </div>
70 </div><!--header-->
71 <div class="contents">
72
73 <p>parse string into a built-in arithmetic type as if the current locale is POSIX.  
74  <a href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html#details">More...</a></p>
75
76 <p><code>#include &lt;<a class="el" href="json_8hpp_source.html">json.hpp</a>&gt;</code></p>
77 <div class="dynheader">
78 Collaboration diagram for basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum:</div>
79 <div class="dyncontent">
80 <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>
81 </div>
82 <table class="memberdecls">
83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
84 Public Member Functions</h2></td></tr>
85 <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>
86 <tr class="separator:ad1858c576c5f6050dd45cc9825a16bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <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>
88 <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>
89 <tr class="separator:ab6b353b5dc68fe4151d9d20edecd162c"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 </table>
91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92 <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 />
93 struct nlohmann::basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::lexer::strtonum</h3>
94
95 <p>parse string into a built-in arithmetic type as if the current locale is POSIX. </p>
96 <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>
97 <dd>
98 any leading blanks are not handled </dd></dl>
99
100 <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>
101 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
102 <a id="ad1858c576c5f6050dd45cc9825a16bb9"></a>
103 <h2 class="memtitle"><span class="permalink"><a href="#ad1858c576c5f6050dd45cc9825a16bb9">&#9670;&nbsp;</a></span>strtonum()</h2>
104
105 <div class="memitem">
106 <div class="memproto">
107 <table class="mlabels">
108   <tr>
109   <td class="mlabels-left">
110       <table class="memname">
111         <tr>
112           <td class="memname"><a class="el" href="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum.html">strtonum</a> </td>
113           <td>(</td>
114           <td class="paramtype">const char *&#160;</td>
115           <td class="paramname"><em>start</em>, </td>
116         </tr>
117         <tr>
118           <td class="paramkey"></td>
119           <td></td>
120           <td class="paramtype">const char *&#160;</td>
121           <td class="paramname"><em>end</em>&#160;</td>
122         </tr>
123         <tr>
124           <td></td>
125           <td>)</td>
126           <td></td><td></td>
127         </tr>
128       </table>
129   </td>
130   <td class="mlabels-right">
131 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
132   </tr>
133 </table>
134 </div><div class="memdoc">
135
136 <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>
137
138 </div>
139 </div>
140 <h2 class="groupheader">Member Function Documentation</h2>
141 <a id="ab6b353b5dc68fe4151d9d20edecd162c"></a>
142 <h2 class="memtitle"><span class="permalink"><a href="#ab6b353b5dc68fe4151d9d20edecd162c">&#9670;&nbsp;</a></span>to()</h2>
143
144 <div class="memitem">
145 <div class="memproto">
146 <table class="mlabels">
147   <tr>
148   <td class="mlabels-left">
149       <table class="memname">
150         <tr>
151           <td class="memname">bool to </td>
152           <td>(</td>
153           <td class="paramtype">T &amp;&#160;</td>
154           <td class="paramname"><em>val</em></td><td>)</td>
155           <td> const</td>
156         </tr>
157       </table>
158   </td>
159   <td class="mlabels-right">
160 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
161   </tr>
162 </table>
163 </div><div class="memdoc">
164 <dl class="section return"><dt>Returns</dt><dd>true iff parsed successfully as number of type T</dd></dl>
165 <dl class="params"><dt>Parameters</dt><dd>
166   <table class="params">
167     <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>
168   </table>
169   </dd>
170 </dl>
171
172 <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>
173 <div class="dynheader">
174 Here is the call graph for this function:</div>
175 <div class="dyncontent">
176 <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>
177 <map name="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph" id="structnlohmann_1_1basic__json_1_1lexer_1_1strtonum_ab6b353b5dc68fe4151d9d20edecd162c_cgraph">
178 <area shape="rect" id="node2" href="classnlohmann_1_1basic__json.html#aa3755192d05bc50d680919b259b69305" title="return whether value is discarded " alt="" coords="99,22,247,63"/>
179 </map>
180 </div>
181 <div class="dynheader">
182 Here is the caller graph for this function:</div>
183 <div class="dyncontent">
184 <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>
185 </div>
186
187 </div>
188 </div>
189 <hr/>The documentation for this struct was generated from the following file:<ul>
190 <li><a class="el" href="json_8hpp_source.html">json.hpp</a></li>
191 </ul>
192 </div><!-- contents -->
193 <!-- start footer part -->
194 <hr class="footer"/><address class="footer"><small>
195 Generated by &#160;<a href="http://www.doxygen.org/index.html">
196 <img class="footer" src="doxygen.png" alt="doxygen"/>
197 </a> 1.8.13
198 </small></address>
199 </body>
200 </html>