xref: /freebsd/contrib/lyaml/doc/modules/lyaml.implicit.html (revision 2bc180ef045e5911cce0cea1c2a139cffd2b577a)
1*2bc180efSBaptiste Daroussin<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2*2bc180efSBaptiste Daroussin   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3*2bc180efSBaptiste Daroussin<html>
4*2bc180efSBaptiste Daroussin<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5*2bc180efSBaptiste Daroussin<head>
6*2bc180efSBaptiste Daroussin    <title>lyaml 6.2.8 Reference</title>
7*2bc180efSBaptiste Daroussin    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8*2bc180efSBaptiste Daroussin</head>
9*2bc180efSBaptiste Daroussin<body>
10*2bc180efSBaptiste Daroussin
11*2bc180efSBaptiste Daroussin<div id="container">
12*2bc180efSBaptiste Daroussin
13*2bc180efSBaptiste Daroussin<div id="product">
14*2bc180efSBaptiste Daroussin	<div id="product_logo"></div>
15*2bc180efSBaptiste Daroussin	<div id="product_name"><big><b></b></big></div>
16*2bc180efSBaptiste Daroussin	<div id="product_description"></div>
17*2bc180efSBaptiste Daroussin</div> <!-- id="product" -->
18*2bc180efSBaptiste Daroussin
19*2bc180efSBaptiste Daroussin
20*2bc180efSBaptiste Daroussin<div id="main">
21*2bc180efSBaptiste Daroussin
22*2bc180efSBaptiste Daroussin
23*2bc180efSBaptiste Daroussin<!-- Menu -->
24*2bc180efSBaptiste Daroussin
25*2bc180efSBaptiste Daroussin<div id="navigation">
26*2bc180efSBaptiste Daroussin<br/>
27*2bc180efSBaptiste Daroussin<h1>lyaml 6.2.8</h1>
28*2bc180efSBaptiste Daroussin
29*2bc180efSBaptiste Daroussin<ul>
30*2bc180efSBaptiste Daroussin  <li><a href="../index.html">Index</a></li>
31*2bc180efSBaptiste Daroussin</ul>
32*2bc180efSBaptiste Daroussin
33*2bc180efSBaptiste Daroussin<h2>Contents</h2>
34*2bc180efSBaptiste Daroussin<ul>
35*2bc180efSBaptiste Daroussin<li><a href="#Functions">Functions</a></li>
36*2bc180efSBaptiste Daroussin</ul>
37*2bc180efSBaptiste Daroussin
38*2bc180efSBaptiste Daroussin
39*2bc180efSBaptiste Daroussin<h2>Modules</h2>
40*2bc180efSBaptiste Daroussin<ul class="nowrap">
41*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.html">lyaml</a></li>
42*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li>
43*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li>
44*2bc180efSBaptiste Daroussin  <li><strong>lyaml.implicit</strong></li>
45*2bc180efSBaptiste Daroussin</ul>
46*2bc180efSBaptiste Daroussin
47*2bc180efSBaptiste Daroussin</div>
48*2bc180efSBaptiste Daroussin
49*2bc180efSBaptiste Daroussin<div id="content">
50*2bc180efSBaptiste Daroussin
51*2bc180efSBaptiste Daroussin<h1>Module <code>lyaml.implicit</code></h1>
52*2bc180efSBaptiste Daroussin<p>
53*2bc180efSBaptiste Daroussin
54*2bc180efSBaptiste Daroussin</p>
55*2bc180efSBaptiste Daroussin<p>
56*2bc180efSBaptiste Daroussin
57*2bc180efSBaptiste Daroussin</p>
58*2bc180efSBaptiste Daroussin
59*2bc180efSBaptiste Daroussin
60*2bc180efSBaptiste Daroussin<h2><a href="#Functions">Functions</a></h2>
61*2bc180efSBaptiste Daroussin<table class="function_list">
62*2bc180efSBaptiste Daroussin	<tr>
63*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#null">null (value)</a></td>
64*2bc180efSBaptiste Daroussin	<td class="summary">Parse a null token to a null value.</td>
65*2bc180efSBaptiste Daroussin	</tr>
66*2bc180efSBaptiste Daroussin	<tr>
67*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#bool">bool (value)</a></td>
68*2bc180efSBaptiste Daroussin	<td class="summary">Parse a boolean token to the equivalent value.</td>
69*2bc180efSBaptiste Daroussin	</tr>
70*2bc180efSBaptiste Daroussin	<tr>
71*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#binary">binary (value)</a></td>
72*2bc180efSBaptiste Daroussin	<td class="summary">Parse a binary token, such as '0b1010_0111_0100_1010_1110'.</td>
73*2bc180efSBaptiste Daroussin	</tr>
74*2bc180efSBaptiste Daroussin	<tr>
75*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#octal">octal (value)</a></td>
76*2bc180efSBaptiste Daroussin	<td class="summary">Parse an octal token, such as '012345'.</td>
77*2bc180efSBaptiste Daroussin	</tr>
78*2bc180efSBaptiste Daroussin	<tr>
79*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#decimal">decimal (value)</a></td>
80*2bc180efSBaptiste Daroussin	<td class="summary">Parse a decimal token, such as '0' or '12345'.</td>
81*2bc180efSBaptiste Daroussin	</tr>
82*2bc180efSBaptiste Daroussin	<tr>
83*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#hexadecimal">hexadecimal (value)</a></td>
84*2bc180efSBaptiste Daroussin	<td class="summary">Parse a hexadecimal token, such as '0xdeadbeef'.</td>
85*2bc180efSBaptiste Daroussin	</tr>
86*2bc180efSBaptiste Daroussin	<tr>
87*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#sexagesimal">sexagesimal (value)</a></td>
88*2bc180efSBaptiste Daroussin	<td class="summary">Parse a sexagesimal token, such as '190:20:30'.</td>
89*2bc180efSBaptiste Daroussin	</tr>
90*2bc180efSBaptiste Daroussin	<tr>
91*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#nan">nan (value)</a></td>
92*2bc180efSBaptiste Daroussin	<td class="summary">Parse a <code>nan</code> token.</td>
93*2bc180efSBaptiste Daroussin	</tr>
94*2bc180efSBaptiste Daroussin	<tr>
95*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#inf">inf (value)</a></td>
96*2bc180efSBaptiste Daroussin	<td class="summary">Parse a signed <code>inf</code> token.</td>
97*2bc180efSBaptiste Daroussin	</tr>
98*2bc180efSBaptiste Daroussin	<tr>
99*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#float">float (value)</a></td>
100*2bc180efSBaptiste Daroussin	<td class="summary">Parse a floating point number token, such as '1e-3' or '-0.12'.</td>
101*2bc180efSBaptiste Daroussin	</tr>
102*2bc180efSBaptiste Daroussin	<tr>
103*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#sexfloat">sexfloat (value)</a></td>
104*2bc180efSBaptiste Daroussin	<td class="summary">Parse a sexagesimal float, such as '190:20:30.15'.</td>
105*2bc180efSBaptiste Daroussin	</tr>
106*2bc180efSBaptiste Daroussin</table>
107*2bc180efSBaptiste Daroussin
108*2bc180efSBaptiste Daroussin<br/>
109*2bc180efSBaptiste Daroussin<br/>
110*2bc180efSBaptiste Daroussin
111*2bc180efSBaptiste Daroussin
112*2bc180efSBaptiste Daroussin    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
113*2bc180efSBaptiste Daroussin
114*2bc180efSBaptiste Daroussin    <dl class="function">
115*2bc180efSBaptiste Daroussin    <dt>
116*2bc180efSBaptiste Daroussin    <a name = "null"></a>
117*2bc180efSBaptiste Daroussin    <strong>null (value)</strong>
118*2bc180efSBaptiste Daroussin    </dt>
119*2bc180efSBaptiste Daroussin    <dd>
120*2bc180efSBaptiste Daroussin    Parse a null token to a null value.
121*2bc180efSBaptiste Daroussin
122*2bc180efSBaptiste Daroussin
123*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
124*2bc180efSBaptiste Daroussin    <ul>
125*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
126*2bc180efSBaptiste Daroussin         token
127*2bc180efSBaptiste Daroussin        </li>
128*2bc180efSBaptiste Daroussin    </ul>
129*2bc180efSBaptiste Daroussin
130*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
131*2bc180efSBaptiste Daroussin    <ol>
132*2bc180efSBaptiste Daroussin
133*2bc180efSBaptiste Daroussin        lyaml.null, for an empty string or literal ~
134*2bc180efSBaptiste Daroussin    </ol>
135*2bc180efSBaptiste Daroussin     <h3>Or</h3>
136*2bc180efSBaptiste Daroussin    <ol>
137*2bc180efSBaptiste Daroussin
138*2bc180efSBaptiste Daroussin        nil otherwise, nil
139*2bc180efSBaptiste Daroussin    </ol>
140*2bc180efSBaptiste Daroussin
141*2bc180efSBaptiste Daroussin
142*2bc180efSBaptiste Daroussin
143*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
144*2bc180efSBaptiste Daroussin    <ul>
145*2bc180efSBaptiste Daroussin        <pre class="example">maybe_null = implicit.null(token)</pre>
146*2bc180efSBaptiste Daroussin    </ul>
147*2bc180efSBaptiste Daroussin
148*2bc180efSBaptiste Daroussin</dd>
149*2bc180efSBaptiste Daroussin    <dt>
150*2bc180efSBaptiste Daroussin    <a name = "bool"></a>
151*2bc180efSBaptiste Daroussin    <strong>bool (value)</strong>
152*2bc180efSBaptiste Daroussin    </dt>
153*2bc180efSBaptiste Daroussin    <dd>
154*2bc180efSBaptiste Daroussin    Parse a boolean token to the equivalent value.
155*2bc180efSBaptiste Daroussin Treats capilalized, lower and upper-cased variants of true/false,
156*2bc180efSBaptiste Daroussin yes/no or on/off tokens as boolean <code>true</code> and <code>false</code> values.
157*2bc180efSBaptiste Daroussin
158*2bc180efSBaptiste Daroussin
159*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
160*2bc180efSBaptiste Daroussin    <ul>
161*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
162*2bc180efSBaptiste Daroussin         token
163*2bc180efSBaptiste Daroussin        </li>
164*2bc180efSBaptiste Daroussin    </ul>
165*2bc180efSBaptiste Daroussin
166*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
167*2bc180efSBaptiste Daroussin    <ol>
168*2bc180efSBaptiste Daroussin
169*2bc180efSBaptiste Daroussin           <span class="types"><a class="type" href="../modules/lyaml.implicit.html#bool">bool</a></span>
170*2bc180efSBaptiste Daroussin        if a valid boolean token was recognized
171*2bc180efSBaptiste Daroussin    </ol>
172*2bc180efSBaptiste Daroussin     <h3>Or</h3>
173*2bc180efSBaptiste Daroussin    <ol>
174*2bc180efSBaptiste Daroussin
175*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
176*2bc180efSBaptiste Daroussin        otherwise, nil
177*2bc180efSBaptiste Daroussin    </ol>
178*2bc180efSBaptiste Daroussin
179*2bc180efSBaptiste Daroussin
180*2bc180efSBaptiste Daroussin
181*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
182*2bc180efSBaptiste Daroussin    <ul>
183*2bc180efSBaptiste Daroussin        <pre class="example">maybe_bool = implicit.bool(token)</pre>
184*2bc180efSBaptiste Daroussin    </ul>
185*2bc180efSBaptiste Daroussin
186*2bc180efSBaptiste Daroussin</dd>
187*2bc180efSBaptiste Daroussin    <dt>
188*2bc180efSBaptiste Daroussin    <a name = "binary"></a>
189*2bc180efSBaptiste Daroussin    <strong>binary (value)</strong>
190*2bc180efSBaptiste Daroussin    </dt>
191*2bc180efSBaptiste Daroussin    <dd>
192*2bc180efSBaptiste Daroussin    Parse a binary token, such as '0b1010_0111_0100_1010_1110'.
193*2bc180efSBaptiste Daroussin
194*2bc180efSBaptiste Daroussin
195*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
196*2bc180efSBaptiste Daroussin    <ul>
197*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
198*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
199*2bc180efSBaptiste Daroussin         token
200*2bc180efSBaptiste Daroussin        </li>
201*2bc180efSBaptiste Daroussin    </ul>
202*2bc180efSBaptiste Daroussin
203*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
204*2bc180efSBaptiste Daroussin    <ol>
205*2bc180efSBaptiste Daroussin
206*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">int</span></span>
207*2bc180efSBaptiste Daroussin        integer equivalent, if a valid token was recognized
208*2bc180efSBaptiste Daroussin    </ol>
209*2bc180efSBaptiste Daroussin     <h3>Or</h3>
210*2bc180efSBaptiste Daroussin    <ol>
211*2bc180efSBaptiste Daroussin
212*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
213*2bc180efSBaptiste Daroussin        otherwise, nil
214*2bc180efSBaptiste Daroussin    </ol>
215*2bc180efSBaptiste Daroussin
216*2bc180efSBaptiste Daroussin
217*2bc180efSBaptiste Daroussin
218*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
219*2bc180efSBaptiste Daroussin    <ul>
220*2bc180efSBaptiste Daroussin        <pre class="example">maybe_int = implicit.binary(value)</pre>
221*2bc180efSBaptiste Daroussin    </ul>
222*2bc180efSBaptiste Daroussin
223*2bc180efSBaptiste Daroussin</dd>
224*2bc180efSBaptiste Daroussin    <dt>
225*2bc180efSBaptiste Daroussin    <a name = "octal"></a>
226*2bc180efSBaptiste Daroussin    <strong>octal (value)</strong>
227*2bc180efSBaptiste Daroussin    </dt>
228*2bc180efSBaptiste Daroussin    <dd>
229*2bc180efSBaptiste Daroussin    Parse an octal token, such as '012345'.
230*2bc180efSBaptiste Daroussin
231*2bc180efSBaptiste Daroussin
232*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
233*2bc180efSBaptiste Daroussin    <ul>
234*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
235*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
236*2bc180efSBaptiste Daroussin         token
237*2bc180efSBaptiste Daroussin        </li>
238*2bc180efSBaptiste Daroussin    </ul>
239*2bc180efSBaptiste Daroussin
240*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
241*2bc180efSBaptiste Daroussin    <ol>
242*2bc180efSBaptiste Daroussin
243*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">int</span></span>
244*2bc180efSBaptiste Daroussin        integer equivalent, if a valid token was recognized
245*2bc180efSBaptiste Daroussin    </ol>
246*2bc180efSBaptiste Daroussin     <h3>Or</h3>
247*2bc180efSBaptiste Daroussin    <ol>
248*2bc180efSBaptiste Daroussin
249*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
250*2bc180efSBaptiste Daroussin        otherwise, nil
251*2bc180efSBaptiste Daroussin    </ol>
252*2bc180efSBaptiste Daroussin
253*2bc180efSBaptiste Daroussin
254*2bc180efSBaptiste Daroussin
255*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
256*2bc180efSBaptiste Daroussin    <ul>
257*2bc180efSBaptiste Daroussin        <pre class="example">maybe_int = implicit.octal(value)</pre>
258*2bc180efSBaptiste Daroussin    </ul>
259*2bc180efSBaptiste Daroussin
260*2bc180efSBaptiste Daroussin</dd>
261*2bc180efSBaptiste Daroussin    <dt>
262*2bc180efSBaptiste Daroussin    <a name = "decimal"></a>
263*2bc180efSBaptiste Daroussin    <strong>decimal (value)</strong>
264*2bc180efSBaptiste Daroussin    </dt>
265*2bc180efSBaptiste Daroussin    <dd>
266*2bc180efSBaptiste Daroussin    Parse a decimal token, such as '0' or '12345'.
267*2bc180efSBaptiste Daroussin
268*2bc180efSBaptiste Daroussin
269*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
270*2bc180efSBaptiste Daroussin    <ul>
271*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
272*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
273*2bc180efSBaptiste Daroussin         token
274*2bc180efSBaptiste Daroussin        </li>
275*2bc180efSBaptiste Daroussin    </ul>
276*2bc180efSBaptiste Daroussin
277*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
278*2bc180efSBaptiste Daroussin    <ol>
279*2bc180efSBaptiste Daroussin
280*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">int</span></span>
281*2bc180efSBaptiste Daroussin        integer equivalent, if a valid token was recognized
282*2bc180efSBaptiste Daroussin    </ol>
283*2bc180efSBaptiste Daroussin     <h3>Or</h3>
284*2bc180efSBaptiste Daroussin    <ol>
285*2bc180efSBaptiste Daroussin
286*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
287*2bc180efSBaptiste Daroussin        otherwise, nil
288*2bc180efSBaptiste Daroussin    </ol>
289*2bc180efSBaptiste Daroussin
290*2bc180efSBaptiste Daroussin
291*2bc180efSBaptiste Daroussin
292*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
293*2bc180efSBaptiste Daroussin    <ul>
294*2bc180efSBaptiste Daroussin        <pre class="example">maybe_int = implicit.decimal(value)</pre>
295*2bc180efSBaptiste Daroussin    </ul>
296*2bc180efSBaptiste Daroussin
297*2bc180efSBaptiste Daroussin</dd>
298*2bc180efSBaptiste Daroussin    <dt>
299*2bc180efSBaptiste Daroussin    <a name = "hexadecimal"></a>
300*2bc180efSBaptiste Daroussin    <strong>hexadecimal (value)</strong>
301*2bc180efSBaptiste Daroussin    </dt>
302*2bc180efSBaptiste Daroussin    <dd>
303*2bc180efSBaptiste Daroussin    Parse a hexadecimal token, such as '0xdeadbeef'.
304*2bc180efSBaptiste Daroussin
305*2bc180efSBaptiste Daroussin
306*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
307*2bc180efSBaptiste Daroussin    <ul>
308*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
309*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
310*2bc180efSBaptiste Daroussin         token
311*2bc180efSBaptiste Daroussin        </li>
312*2bc180efSBaptiste Daroussin    </ul>
313*2bc180efSBaptiste Daroussin
314*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
315*2bc180efSBaptiste Daroussin    <ol>
316*2bc180efSBaptiste Daroussin
317*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">int</span></span>
318*2bc180efSBaptiste Daroussin        integer equivalent, if a valid token was recognized
319*2bc180efSBaptiste Daroussin    </ol>
320*2bc180efSBaptiste Daroussin     <h3>Or</h3>
321*2bc180efSBaptiste Daroussin    <ol>
322*2bc180efSBaptiste Daroussin
323*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
324*2bc180efSBaptiste Daroussin        otherwise, nil
325*2bc180efSBaptiste Daroussin    </ol>
326*2bc180efSBaptiste Daroussin
327*2bc180efSBaptiste Daroussin
328*2bc180efSBaptiste Daroussin
329*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
330*2bc180efSBaptiste Daroussin    <ul>
331*2bc180efSBaptiste Daroussin        <pre class="example">maybe_int = implicit.hexadecimal(value)</pre>
332*2bc180efSBaptiste Daroussin    </ul>
333*2bc180efSBaptiste Daroussin
334*2bc180efSBaptiste Daroussin</dd>
335*2bc180efSBaptiste Daroussin    <dt>
336*2bc180efSBaptiste Daroussin    <a name = "sexagesimal"></a>
337*2bc180efSBaptiste Daroussin    <strong>sexagesimal (value)</strong>
338*2bc180efSBaptiste Daroussin    </dt>
339*2bc180efSBaptiste Daroussin    <dd>
340*2bc180efSBaptiste Daroussin    Parse a sexagesimal token, such as '190:20:30'.
341*2bc180efSBaptiste Daroussin Useful for times and angles.
342*2bc180efSBaptiste Daroussin
343*2bc180efSBaptiste Daroussin
344*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
345*2bc180efSBaptiste Daroussin    <ul>
346*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
347*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
348*2bc180efSBaptiste Daroussin         token
349*2bc180efSBaptiste Daroussin        </li>
350*2bc180efSBaptiste Daroussin    </ul>
351*2bc180efSBaptiste Daroussin
352*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
353*2bc180efSBaptiste Daroussin    <ol>
354*2bc180efSBaptiste Daroussin
355*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">int</span></span>
356*2bc180efSBaptiste Daroussin        integer equivalent, if a valid token was recognized
357*2bc180efSBaptiste Daroussin    </ol>
358*2bc180efSBaptiste Daroussin     <h3>Or</h3>
359*2bc180efSBaptiste Daroussin    <ol>
360*2bc180efSBaptiste Daroussin
361*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
362*2bc180efSBaptiste Daroussin        otherwise, nil
363*2bc180efSBaptiste Daroussin    </ol>
364*2bc180efSBaptiste Daroussin
365*2bc180efSBaptiste Daroussin
366*2bc180efSBaptiste Daroussin
367*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
368*2bc180efSBaptiste Daroussin    <ul>
369*2bc180efSBaptiste Daroussin        <pre class="example">maybe_int = implicit.sexagesimal(value)</pre>
370*2bc180efSBaptiste Daroussin    </ul>
371*2bc180efSBaptiste Daroussin
372*2bc180efSBaptiste Daroussin</dd>
373*2bc180efSBaptiste Daroussin    <dt>
374*2bc180efSBaptiste Daroussin    <a name = "nan"></a>
375*2bc180efSBaptiste Daroussin    <strong>nan (value)</strong>
376*2bc180efSBaptiste Daroussin    </dt>
377*2bc180efSBaptiste Daroussin    <dd>
378*2bc180efSBaptiste Daroussin    Parse a <code>nan</code> token.
379*2bc180efSBaptiste Daroussin
380*2bc180efSBaptiste Daroussin
381*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
382*2bc180efSBaptiste Daroussin    <ul>
383*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
384*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
385*2bc180efSBaptiste Daroussin         token
386*2bc180efSBaptiste Daroussin        </li>
387*2bc180efSBaptiste Daroussin    </ul>
388*2bc180efSBaptiste Daroussin
389*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
390*2bc180efSBaptiste Daroussin    <ol>
391*2bc180efSBaptiste Daroussin
392*2bc180efSBaptiste Daroussin           <span class="types"><a class="type" href="../modules/lyaml.implicit.html#nan">nan</a></span>
393*2bc180efSBaptiste Daroussin        not-a-number, if a valid token was recognized
394*2bc180efSBaptiste Daroussin    </ol>
395*2bc180efSBaptiste Daroussin     <h3>Or</h3>
396*2bc180efSBaptiste Daroussin    <ol>
397*2bc180efSBaptiste Daroussin
398*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
399*2bc180efSBaptiste Daroussin        otherwise, nil
400*2bc180efSBaptiste Daroussin    </ol>
401*2bc180efSBaptiste Daroussin
402*2bc180efSBaptiste Daroussin
403*2bc180efSBaptiste Daroussin
404*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
405*2bc180efSBaptiste Daroussin    <ul>
406*2bc180efSBaptiste Daroussin        <pre class="example">maybe_nan = implicit.nan(value)</pre>
407*2bc180efSBaptiste Daroussin    </ul>
408*2bc180efSBaptiste Daroussin
409*2bc180efSBaptiste Daroussin</dd>
410*2bc180efSBaptiste Daroussin    <dt>
411*2bc180efSBaptiste Daroussin    <a name = "inf"></a>
412*2bc180efSBaptiste Daroussin    <strong>inf (value)</strong>
413*2bc180efSBaptiste Daroussin    </dt>
414*2bc180efSBaptiste Daroussin    <dd>
415*2bc180efSBaptiste Daroussin    Parse a signed <code>inf</code> token.
416*2bc180efSBaptiste Daroussin
417*2bc180efSBaptiste Daroussin
418*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
419*2bc180efSBaptiste Daroussin    <ul>
420*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
421*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
422*2bc180efSBaptiste Daroussin         token
423*2bc180efSBaptiste Daroussin        </li>
424*2bc180efSBaptiste Daroussin    </ul>
425*2bc180efSBaptiste Daroussin
426*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
427*2bc180efSBaptiste Daroussin    <ol>
428*2bc180efSBaptiste Daroussin
429*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">number</span></span>
430*2bc180efSBaptiste Daroussin        plus/minus-infinity, if a valid token was recognized
431*2bc180efSBaptiste Daroussin    </ol>
432*2bc180efSBaptiste Daroussin     <h3>Or</h3>
433*2bc180efSBaptiste Daroussin    <ol>
434*2bc180efSBaptiste Daroussin
435*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
436*2bc180efSBaptiste Daroussin        otherwise, nil
437*2bc180efSBaptiste Daroussin    </ol>
438*2bc180efSBaptiste Daroussin
439*2bc180efSBaptiste Daroussin
440*2bc180efSBaptiste Daroussin
441*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
442*2bc180efSBaptiste Daroussin    <ul>
443*2bc180efSBaptiste Daroussin        <pre class="example">maybe_inf = implicit.inf(value)</pre>
444*2bc180efSBaptiste Daroussin    </ul>
445*2bc180efSBaptiste Daroussin
446*2bc180efSBaptiste Daroussin</dd>
447*2bc180efSBaptiste Daroussin    <dt>
448*2bc180efSBaptiste Daroussin    <a name = "float"></a>
449*2bc180efSBaptiste Daroussin    <strong>float (value)</strong>
450*2bc180efSBaptiste Daroussin    </dt>
451*2bc180efSBaptiste Daroussin    <dd>
452*2bc180efSBaptiste Daroussin    Parse a floating point number token, such as '1e-3' or '-0.12'.
453*2bc180efSBaptiste Daroussin
454*2bc180efSBaptiste Daroussin
455*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
456*2bc180efSBaptiste Daroussin    <ul>
457*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
458*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
459*2bc180efSBaptiste Daroussin         token
460*2bc180efSBaptiste Daroussin        </li>
461*2bc180efSBaptiste Daroussin    </ul>
462*2bc180efSBaptiste Daroussin
463*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
464*2bc180efSBaptiste Daroussin    <ol>
465*2bc180efSBaptiste Daroussin
466*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">number</span></span>
467*2bc180efSBaptiste Daroussin        float equivalent, if a valid token was recognized
468*2bc180efSBaptiste Daroussin    </ol>
469*2bc180efSBaptiste Daroussin     <h3>Or</h3>
470*2bc180efSBaptiste Daroussin    <ol>
471*2bc180efSBaptiste Daroussin
472*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
473*2bc180efSBaptiste Daroussin        otherwise, nil
474*2bc180efSBaptiste Daroussin    </ol>
475*2bc180efSBaptiste Daroussin
476*2bc180efSBaptiste Daroussin
477*2bc180efSBaptiste Daroussin
478*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
479*2bc180efSBaptiste Daroussin    <ul>
480*2bc180efSBaptiste Daroussin        <pre class="example">maybe_float = implicit.float(value)</pre>
481*2bc180efSBaptiste Daroussin    </ul>
482*2bc180efSBaptiste Daroussin
483*2bc180efSBaptiste Daroussin</dd>
484*2bc180efSBaptiste Daroussin    <dt>
485*2bc180efSBaptiste Daroussin    <a name = "sexfloat"></a>
486*2bc180efSBaptiste Daroussin    <strong>sexfloat (value)</strong>
487*2bc180efSBaptiste Daroussin    </dt>
488*2bc180efSBaptiste Daroussin    <dd>
489*2bc180efSBaptiste Daroussin    Parse a sexagesimal float, such as '190:20:30.15'.
490*2bc180efSBaptiste Daroussin Useful for times and angles.
491*2bc180efSBaptiste Daroussin
492*2bc180efSBaptiste Daroussin
493*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
494*2bc180efSBaptiste Daroussin    <ul>
495*2bc180efSBaptiste Daroussin        <li><span class="parameter">value</span>
496*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
497*2bc180efSBaptiste Daroussin         token
498*2bc180efSBaptiste Daroussin        </li>
499*2bc180efSBaptiste Daroussin    </ul>
500*2bc180efSBaptiste Daroussin
501*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
502*2bc180efSBaptiste Daroussin    <ol>
503*2bc180efSBaptiste Daroussin
504*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">number</span></span>
505*2bc180efSBaptiste Daroussin        float equivalent, if a valid token was recognized
506*2bc180efSBaptiste Daroussin    </ol>
507*2bc180efSBaptiste Daroussin     <h3>Or</h3>
508*2bc180efSBaptiste Daroussin    <ol>
509*2bc180efSBaptiste Daroussin
510*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">nil</span></span>
511*2bc180efSBaptiste Daroussin        otherwise, nil
512*2bc180efSBaptiste Daroussin    </ol>
513*2bc180efSBaptiste Daroussin
514*2bc180efSBaptiste Daroussin
515*2bc180efSBaptiste Daroussin
516*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
517*2bc180efSBaptiste Daroussin    <ul>
518*2bc180efSBaptiste Daroussin        <pre class="example">maybe_float = implicit.sexfloat(value)</pre>
519*2bc180efSBaptiste Daroussin    </ul>
520*2bc180efSBaptiste Daroussin
521*2bc180efSBaptiste Daroussin</dd>
522*2bc180efSBaptiste Daroussin</dl>
523*2bc180efSBaptiste Daroussin
524*2bc180efSBaptiste Daroussin
525*2bc180efSBaptiste Daroussin</div> <!-- id="content" -->
526*2bc180efSBaptiste Daroussin</div> <!-- id="main" -->
527*2bc180efSBaptiste Daroussin<div id="about">
528*2bc180efSBaptiste Daroussin<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
529*2bc180efSBaptiste Daroussin<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
530*2bc180efSBaptiste Daroussin</div> <!-- id="about" -->
531*2bc180efSBaptiste Daroussin</div> <!-- id="container" -->
532*2bc180efSBaptiste Daroussin</body>
533*2bc180efSBaptiste Daroussin</html>
534