xref: /freebsd/contrib/lyaml/doc/modules/lyaml.functional.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<li><a href="#Tables">Tables</a></li>
37*2bc180efSBaptiste Daroussin</ul>
38*2bc180efSBaptiste Daroussin
39*2bc180efSBaptiste Daroussin
40*2bc180efSBaptiste Daroussin<h2>Modules</h2>
41*2bc180efSBaptiste Daroussin<ul class="nowrap">
42*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.html">lyaml</a></li>
43*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li>
44*2bc180efSBaptiste Daroussin  <li><strong>lyaml.functional</strong></li>
45*2bc180efSBaptiste Daroussin  <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li>
46*2bc180efSBaptiste Daroussin</ul>
47*2bc180efSBaptiste Daroussin
48*2bc180efSBaptiste Daroussin</div>
49*2bc180efSBaptiste Daroussin
50*2bc180efSBaptiste Daroussin<div id="content">
51*2bc180efSBaptiste Daroussin
52*2bc180efSBaptiste Daroussin<h1>Module <code>lyaml.functional</code></h1>
53*2bc180efSBaptiste Daroussin<p>
54*2bc180efSBaptiste Daroussin
55*2bc180efSBaptiste Daroussin</p>
56*2bc180efSBaptiste Daroussin<p>
57*2bc180efSBaptiste Daroussin
58*2bc180efSBaptiste Daroussin</p>
59*2bc180efSBaptiste Daroussin
60*2bc180efSBaptiste Daroussin
61*2bc180efSBaptiste Daroussin<h2><a href="#Functions">Functions</a></h2>
62*2bc180efSBaptiste Daroussin<table class="function_list">
63*2bc180efSBaptiste Daroussin	<tr>
64*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#isnull">isnull (x)</a></td>
65*2bc180efSBaptiste Daroussin	<td class="summary"><code>lyaml.null</code> predicate.</td>
66*2bc180efSBaptiste Daroussin	</tr>
67*2bc180efSBaptiste Daroussin	<tr>
68*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#iscallable">iscallable (x)</a></td>
69*2bc180efSBaptiste Daroussin	<td class="summary">Callable predicate.</td>
70*2bc180efSBaptiste Daroussin	</tr>
71*2bc180efSBaptiste Daroussin	<tr>
72*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#anyof">anyof (fns)</a></td>
73*2bc180efSBaptiste Daroussin	<td class="summary">Compose a function to try each callable with supplied args.</td>
74*2bc180efSBaptiste Daroussin	</tr>
75*2bc180efSBaptiste Daroussin	<tr>
76*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#id">id (...)</a></td>
77*2bc180efSBaptiste Daroussin	<td class="summary">Return arguments unchanged.</td>
78*2bc180efSBaptiste Daroussin	</tr>
79*2bc180efSBaptiste Daroussin</table>
80*2bc180efSBaptiste Daroussin<h2><a href="#Tables">Tables</a></h2>
81*2bc180efSBaptiste Daroussin<table class="function_list">
82*2bc180efSBaptiste Daroussin	<tr>
83*2bc180efSBaptiste Daroussin	<td class="name" nowrap><a href="#NULL">NULL</a></td>
84*2bc180efSBaptiste Daroussin	<td class="summary"><code>lyaml.null</code> value.</td>
85*2bc180efSBaptiste Daroussin	</tr>
86*2bc180efSBaptiste Daroussin</table>
87*2bc180efSBaptiste Daroussin
88*2bc180efSBaptiste Daroussin<br/>
89*2bc180efSBaptiste Daroussin<br/>
90*2bc180efSBaptiste Daroussin
91*2bc180efSBaptiste Daroussin
92*2bc180efSBaptiste Daroussin    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
93*2bc180efSBaptiste Daroussin
94*2bc180efSBaptiste Daroussin    <dl class="function">
95*2bc180efSBaptiste Daroussin    <dt>
96*2bc180efSBaptiste Daroussin    <a name = "isnull"></a>
97*2bc180efSBaptiste Daroussin    <strong>isnull (x)</strong>
98*2bc180efSBaptiste Daroussin    </dt>
99*2bc180efSBaptiste Daroussin    <dd>
100*2bc180efSBaptiste Daroussin    <code>lyaml.null</code> predicate.
101*2bc180efSBaptiste Daroussin
102*2bc180efSBaptiste Daroussin
103*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
104*2bc180efSBaptiste Daroussin    <ul>
105*2bc180efSBaptiste Daroussin        <li><span class="parameter">x</span>
106*2bc180efSBaptiste Daroussin         operand
107*2bc180efSBaptiste Daroussin        </li>
108*2bc180efSBaptiste Daroussin    </ul>
109*2bc180efSBaptiste Daroussin
110*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
111*2bc180efSBaptiste Daroussin    <ol>
112*2bc180efSBaptiste Daroussin
113*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">bool</span></span>
114*2bc180efSBaptiste Daroussin        <code>true</code> if <em>x</em> is <code>lyaml.null</code>.
115*2bc180efSBaptiste Daroussin    </ol>
116*2bc180efSBaptiste Daroussin
117*2bc180efSBaptiste Daroussin
118*2bc180efSBaptiste Daroussin
119*2bc180efSBaptiste Daroussin
120*2bc180efSBaptiste Daroussin</dd>
121*2bc180efSBaptiste Daroussin    <dt>
122*2bc180efSBaptiste Daroussin    <a name = "iscallable"></a>
123*2bc180efSBaptiste Daroussin    <strong>iscallable (x)</strong>
124*2bc180efSBaptiste Daroussin    </dt>
125*2bc180efSBaptiste Daroussin    <dd>
126*2bc180efSBaptiste Daroussin    Callable predicate.
127*2bc180efSBaptiste Daroussin
128*2bc180efSBaptiste Daroussin
129*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
130*2bc180efSBaptiste Daroussin    <ul>
131*2bc180efSBaptiste Daroussin        <li><span class="parameter">x</span>
132*2bc180efSBaptiste Daroussin         operand
133*2bc180efSBaptiste Daroussin        </li>
134*2bc180efSBaptiste Daroussin    </ul>
135*2bc180efSBaptiste Daroussin
136*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
137*2bc180efSBaptiste Daroussin    <ol>
138*2bc180efSBaptiste Daroussin
139*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">bool</span></span>
140*2bc180efSBaptiste Daroussin        <code>true</code> if <em>x</em> is a function has a __call metamethod
141*2bc180efSBaptiste Daroussin    </ol>
142*2bc180efSBaptiste Daroussin
143*2bc180efSBaptiste Daroussin
144*2bc180efSBaptiste Daroussin
145*2bc180efSBaptiste Daroussin    <h3>Usage:</h3>
146*2bc180efSBaptiste Daroussin    <ul>
147*2bc180efSBaptiste Daroussin        <pre class="example">r = iscallable(x) <span class="keyword">and</span> x(...)</pre>
148*2bc180efSBaptiste Daroussin    </ul>
149*2bc180efSBaptiste Daroussin
150*2bc180efSBaptiste Daroussin</dd>
151*2bc180efSBaptiste Daroussin    <dt>
152*2bc180efSBaptiste Daroussin    <a name = "anyof"></a>
153*2bc180efSBaptiste Daroussin    <strong>anyof (fns)</strong>
154*2bc180efSBaptiste Daroussin    </dt>
155*2bc180efSBaptiste Daroussin    <dd>
156*2bc180efSBaptiste Daroussin    Compose a function to try each callable with supplied args.
157*2bc180efSBaptiste Daroussin
158*2bc180efSBaptiste Daroussin
159*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
160*2bc180efSBaptiste Daroussin    <ul>
161*2bc180efSBaptiste Daroussin        <li><span class="parameter">fns</span>
162*2bc180efSBaptiste Daroussin            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
163*2bc180efSBaptiste Daroussin         list of functions to try
164*2bc180efSBaptiste Daroussin        </li>
165*2bc180efSBaptiste Daroussin    </ul>
166*2bc180efSBaptiste Daroussin
167*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
168*2bc180efSBaptiste Daroussin    <ol>
169*2bc180efSBaptiste Daroussin
170*2bc180efSBaptiste Daroussin           <span class="types"><span class="type">function</span></span>
171*2bc180efSBaptiste Daroussin
172*2bc180efSBaptiste Daroussin<p>a new function to call <em>...</em> functions, stopping</p>
173*2bc180efSBaptiste Daroussin<pre><code>and returning the first non-nil result, if any
174*2bc180efSBaptiste Daroussin</code></pre>
175*2bc180efSBaptiste Daroussin
176*2bc180efSBaptiste Daroussin    </ol>
177*2bc180efSBaptiste Daroussin
178*2bc180efSBaptiste Daroussin
179*2bc180efSBaptiste Daroussin
180*2bc180efSBaptiste Daroussin
181*2bc180efSBaptiste Daroussin</dd>
182*2bc180efSBaptiste Daroussin    <dt>
183*2bc180efSBaptiste Daroussin    <a name = "id"></a>
184*2bc180efSBaptiste Daroussin    <strong>id (...)</strong>
185*2bc180efSBaptiste Daroussin    </dt>
186*2bc180efSBaptiste Daroussin    <dd>
187*2bc180efSBaptiste Daroussin    Return arguments unchanged.
188*2bc180efSBaptiste Daroussin
189*2bc180efSBaptiste Daroussin
190*2bc180efSBaptiste Daroussin    <h3>Parameters:</h3>
191*2bc180efSBaptiste Daroussin    <ul>
192*2bc180efSBaptiste Daroussin        <li><span class="parameter">...</span>
193*2bc180efSBaptiste Daroussin         arguments
194*2bc180efSBaptiste Daroussin        </li>
195*2bc180efSBaptiste Daroussin    </ul>
196*2bc180efSBaptiste Daroussin
197*2bc180efSBaptiste Daroussin    <h3>Returns:</h3>
198*2bc180efSBaptiste Daroussin    <ol>
199*2bc180efSBaptiste Daroussin
200*2bc180efSBaptiste Daroussin        <em>...</em>
201*2bc180efSBaptiste Daroussin    </ol>
202*2bc180efSBaptiste Daroussin
203*2bc180efSBaptiste Daroussin
204*2bc180efSBaptiste Daroussin
205*2bc180efSBaptiste Daroussin
206*2bc180efSBaptiste Daroussin</dd>
207*2bc180efSBaptiste Daroussin</dl>
208*2bc180efSBaptiste Daroussin    <h2 class="section-header "><a name="Tables"></a>Tables</h2>
209*2bc180efSBaptiste Daroussin
210*2bc180efSBaptiste Daroussin    <dl class="function">
211*2bc180efSBaptiste Daroussin    <dt>
212*2bc180efSBaptiste Daroussin    <a name = "NULL"></a>
213*2bc180efSBaptiste Daroussin    <strong>NULL</strong>
214*2bc180efSBaptiste Daroussin    </dt>
215*2bc180efSBaptiste Daroussin    <dd>
216*2bc180efSBaptiste Daroussin    <code>lyaml.null</code> value.
217*2bc180efSBaptiste Daroussin
218*2bc180efSBaptiste Daroussin
219*2bc180efSBaptiste Daroussin
220*2bc180efSBaptiste Daroussin
221*2bc180efSBaptiste Daroussin
222*2bc180efSBaptiste Daroussin
223*2bc180efSBaptiste Daroussin
224*2bc180efSBaptiste Daroussin</dd>
225*2bc180efSBaptiste Daroussin</dl>
226*2bc180efSBaptiste Daroussin
227*2bc180efSBaptiste Daroussin
228*2bc180efSBaptiste Daroussin</div> <!-- id="content" -->
229*2bc180efSBaptiste Daroussin</div> <!-- id="main" -->
230*2bc180efSBaptiste Daroussin<div id="about">
231*2bc180efSBaptiste Daroussin<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
232*2bc180efSBaptiste Daroussin<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
233*2bc180efSBaptiste Daroussin</div> <!-- id="about" -->
234*2bc180efSBaptiste Daroussin</div> <!-- id="container" -->
235*2bc180efSBaptiste Daroussin</body>
236*2bc180efSBaptiste Daroussin</html>
237