File: index.html

package info (click to toggle)
faust 2.30.5~ds0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 279,348 kB
  • sloc: cpp: 239,368; javascript: 32,310; ansic: 17,442; sh: 11,925; java: 5,903; objc: 3,879; makefile: 3,030; cs: 1,139; python: 987; ruby: 951; xml: 693; yacc: 537; lex: 239; lisp: 201; awk: 110
file content (574 lines) | stat: -rw-r--r-- 23,905 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        
        
        
        <link rel="shortcut icon" href="../../img/favicon.ico">
        <title> interpolators  - Faust Libraries</title>
        <link href="../../css/bootstrap.min.css" rel="stylesheet">
        <link href="../../css/font-awesome.min.css" rel="stylesheet">
        <link href="../../css/base.css" rel="stylesheet">
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
        <link href="../../css/extra.css" rel="stylesheet">

        <script src="../../js/jquery-1.10.2.min.js" defer></script>
        <script src="../../js/bootstrap.min.js" defer></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
        <script>hljs.initHighlightingOnLoad();</script> 
    </head>

    <body>
        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
            <div class="container">
                <a class="navbar-brand" href="../.."><img src="../../img/faustText.svg" width="150px"> Libraries</a>
                <!-- Expander button -->
                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                    <span class="navbar-toggler-icon"></span>
                </button>

                <!-- Expanded navigation -->
                <div id="navbar-collapse" class="navbar-collapse collapse">
                        <!-- Main navigation -->
                        <ul class="nav navbar-nav">
                            <li class="dropdown">
                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
                                <ul class="dropdown-menu">
                                    
<li>
    <a href="../../organization/" class="dropdown-item"> Organization </a>
</li>
                                    
<li>
    <a href="../../standardFunctions/" class="dropdown-item"> Standard Functions </a>
</li>
                                    
<li>
    <a href="../../contributing/" class="dropdown-item"> Contributing </a>
</li>
                                    
<li>
    <a href="../../copyright/" class="dropdown-item"> Copyright/License </a>
</li>
                                </ul>
                            </li>
                            <li class="navitem">
                                <a href="../" class="nav-link">Index</a>
                            </li>
                            <li class="dropdown active">
                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Libraries <b class="caret"></b></a>
                                <ul class="dropdown-menu">
                                    
<li>
    <a href="../analyzers/" class="dropdown-item"> analyzers </a>
</li>
                                    
<li>
    <a href="../basics/" class="dropdown-item"> basics </a>
</li>
                                    
<li>
    <a href="../compressors/" class="dropdown-item"> compressors </a>
</li>
                                    
<li>
    <a href="../delays/" class="dropdown-item"> delays </a>
</li>
                                    
<li>
    <a href="../demos/" class="dropdown-item"> demos </a>
</li>
                                    
<li>
    <a href="../dx7/" class="dropdown-item"> dx7 </a>
</li>
                                    
<li>
    <a href="../envelopes/" class="dropdown-item"> envelopes </a>
</li>
                                    
<li>
    <a href="../filters/" class="dropdown-item"> filters </a>
</li>
                                    
<li>
    <a href="../hoa/" class="dropdown-item"> hoa </a>
</li>
                                    
<li>
    <a href="./" class="dropdown-item active"> interpolators </a>
</li>
                                    
<li>
    <a href="../maths/" class="dropdown-item"> maths </a>
</li>
                                    
<li>
    <a href="../mi/" class="dropdown-item"> mi </a>
</li>
                                    
<li>
    <a href="../misceffects/" class="dropdown-item"> misceffects </a>
</li>
                                    
<li>
    <a href="../oscillators/" class="dropdown-item"> oscillators </a>
</li>
                                    
<li>
    <a href="../noises/" class="dropdown-item"> noises </a>
</li>
                                    
<li>
    <a href="../phaflangers/" class="dropdown-item"> phaflangers </a>
</li>
                                    
<li>
    <a href="../physmodels/" class="dropdown-item"> physmodels </a>
</li>
                                    
<li>
    <a href="../quantizer/" class="dropdown-item"> quantizer </a>
</li>
                                    
<li>
    <a href="../reducemaps/" class="dropdown-item"> reducemaps </a>
</li>
                                    
<li>
    <a href="../reverbs/" class="dropdown-item"> reverbs </a>
</li>
                                    
<li>
    <a href="../routes/" class="dropdown-item"> routes </a>
</li>
                                    
<li>
    <a href="../signals/" class="dropdown-item"> signals </a>
</li>
                                    
<li>
    <a href="../soundfiles/" class="dropdown-item"> soundfiles </a>
</li>
                                    
<li>
    <a href="../spats/" class="dropdown-item"> spats </a>
</li>
                                    
<li>
    <a href="../synths/" class="dropdown-item"> synths </a>
</li>
                                    
<li>
    <a href="../vaeffects/" class="dropdown-item"> vaeffects </a>
</li>
                                    
<li>
    <a href="../wavedigitalfilters/" class="dropdown-item"> wavedigitalfilters </a>
</li>
                                    
<li>
    <a href="../webaudio/" class="dropdown-item"> webaudio </a>
</li>
                                </ul>
                            </li>
                            <li class="navitem">
                                <a href="../../about/" class="nav-link">About</a>
                            </li>
                        </ul>

                    <ul class="nav navbar-nav ml-auto">
                        <li class="nav-item">
                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
                                <i class="fa fa-search"></i> Search
                            </a>
                        </li>
                    </ul>
                </div>
            </div>
        </div>
        
        

        <div class="container">
            <div class="row"><div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
    <div class="navbar-header">
        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
            <span class="fa fa-angle-down"></span>
        </button>
    </div>

    
    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
        <ul class="nav flex-column">
            
            <li class="nav-item" data-level="1"><a href="#interpolatorslib" class="nav-link">interpolators.lib</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="2"><a href="#two-points-interpolation-functions" class="nav-link">Two points interpolation functions</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="3"><a href="#itinterpolate_linear" class="nav-link">(it.)interpolate_linear</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="3"><a href="#itinterpolate_cosine" class="nav-link">(it.)interpolate_cosine</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#four-points-interpolation-functions" class="nav-link">Four points interpolation functions</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="3"><a href="#itinterpolate_cubic" class="nav-link">(it.)interpolate_cubic</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#two-points-interpolators" class="nav-link">Two points interpolators</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="3"><a href="#itinterpolator_two_points" class="nav-link">(it.)interpolator_two_points</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="3"><a href="#itinterpolator_linear" class="nav-link">(it.)interpolator_linear</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="3"><a href="#itinterpolator_cosine" class="nav-link">(it.)interpolator_cosine</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#four-points-interpolators" class="nav-link">Four points interpolators</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="3"><a href="#itinterpolator_two_points_1" class="nav-link">(it.)interpolator_two_points</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="3"><a href="#itinterpolator_cubic" class="nav-link">(it.)interpolator_cubic</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="3"><a href="#itinterpolator_select" class="nav-link">(it.)interpolator_select</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
              </ul>
            </li>
        </ul>
    </div>
</div></div>
                    <div class="col-md-9 main-container" role="main">

<h1 id="interpolatorslib">interpolators.lib</h1>
<p>A library to handle interpolation. Its official prefix is <code>it</code>.</p>
<p>This library provides several basic interpolation functions as well as interpolators 
taking a <code>gen</code> circuit of N outputs producing values to be interpolated, triggered
by a <code>idv</code> read index signal. Two points and four points interpolations are implemented.</p>
<p>The <code>idv</code> parameter is to be used as a read index. In float (= singleprecision) mode, 
a technique based on 2 signals with the pure integer index and a fractional part in the [0,1] 
range is used to avoid accumulating errors. In -double (= doubleprecision)/-quad (= quadprecision) modes, 
a standard implementation with a single fractional index signal is used. 
Three functions <code>int_part</code>, <code>frac_part</code> and <code>mak_idv</code> are available to manipule the read index signal.</p>
<p>Use-case with <code>waveform</code>. Here the signal given to <code>interpolator_XXX</code> uses the <code>idv</code> model.</p>
<pre><code>waveform_interpolator(wf, step, interp) = interp(gen, idv)
with {
   gen(idx) = wf, (idx:max(0):min(size-1)) : rdtable with { size = wf:(_,!); };   /* waveform size */
   index = (+(step)~_)-step;  /* starting from 0 */
   idv = it.make_idv(index);  /* build the signal for interpolation in a generic way */
};

waveform_linear(wf, step) = waveform_interpolator(wf, step, it.interpolator_linear);
waveform_cosine(wf, step) = waveform_interpolator(wf, step, it.interpolator_cosine);
waveform_cubic(wf, step) = waveform_interpolator(wf, step, it.interpolator_cubic);

waveform_interp(wf, step, selector) = waveform_interpolator(wf, step, interp_select(selector))
with {
   /* adapts the argument order */
   interp_select(sel, gen, idv) = it.interpolator_select(gen, idv, sel);
};

waveform and index 
waveform_interpolator1(wf, idv, interp) = interp(gen, idv)
with {
   gen(idx) = wf, (idx:max(0):min(size-1)) : rdtable with { size = wf:(_,!); };   /* waveform size */
};

waveform_linear1(wf, idv) = waveform_interpolator1(wf, idv, it.interpolator_linear);
waveform_cosine1(wf, idv) = waveform_interpolator1(wf, idv, it.interpolator_cosine);
waveform_cubic1(wf, idv) = waveform_interpolator1(wf, idv, it.interpolator_cubic);

waveform_interp1(wf, idv, selector) = waveform_interpolator1(wf, idv, interp_select(selector))
with {
   /* adapts the argument order */
   interp_select(sel, gen, idv) = it.interpolator_select(gen, idv, sel);
};
</code></pre>

<p>Some tests here:</p>
<pre><code>wf = waveform {0.0, 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 50.0, 40.0, 30.0, 20.0, 10.0, 0.0};

process = waveform_linear(wf, step), waveform_cosine(wf, step), waveform_cubic(wf, step) with { step = 0.25; };

process = waveform_interp(wf, 0.25, nentry(&quot;algo&quot;, 0, 0, 3, 1));

process = waveform_interp1(wf, idv, nentry(&quot;algo&quot;, 0, 0, 3, 1))
with {
   step = 0.1;
   idv_aux = (+(step)~_)-step;  /* starting from 0 */
   idv = it.make_idv(idv_aux);  /* build the signal for interpolation in a generic way */
};

/* Test linear interpolation between 2 samples with a `(idx,dv)` signal built using a waveform */
linear_test = (idx,dv), it.interpolator_linear(gen, (idx,dv))
with {
   /* signal to interpolate (only 2 points here) */
   gen(id) = waveform {3.0, -1.0}, (id:max(0)) : rdtable;
   dv = waveform {0.0, 0.25, 0.50, 0.75, 1.0}, index : rdtable;
   idx = 0; 
   /* test index signal */
   index = (+(1)~_)-1;   /* starting from 0 */
};

/* Test cosine interpolation between 2 samples with a `(idx,dv)` signal built using a waveform */
cosine_test = (idx,dv), it.interpolator_cosine(gen, (idx,dv))
with {
   /* signal to interpolate (only 2 points here) */
   gen(id) = waveform {3.0, -1.0}, (id:max(0)) : rdtable;
   dv = waveform {0.0, 0.25, 0.50, 0.75, 1.0}, index : rdtable;
   idx = 0;
   /* test index signal */
   index = (+(1)~_)-1;   /* starting from 0 */
};

/* Test cubic interpolation between 4 samples with a `(idx,dv)` signal built using a waveform */
cubic_test = (idx,dv), it.interpolator_cubic(gen, (idx,dv))
with {
   /* signal to interpolate (only 4 points here) */
   gen(id) = waveform {-1.0, 2.0, 1.0, 4.0}, (id:max(0)) : rdtable;
   dv = waveform {0.0, 0.25, 0.50, 0.75, 1.0}, index : rdtable;
   idx = 0;
   /* test index signal */
   index = (+(1)~_)-1;   /* starting from 0 */
};
</code></pre>

<h2 id="two-points-interpolation-functions">Two points interpolation functions</h2>
<hr />
<h3 id="itinterpolate_linear"><code>(it.)interpolate_linear</code></h3>
<p>Linear interpolation between 2 values.</p>
<h4 id="usage">Usage</h4>
<pre><code>interpolate_linear(dv,v0,v1) : _
</code></pre>

<p>Where:</p>
<ul>
<li><code>dv</code>: in the fractional value in [0..1] range</li>
<li><code>v0</code>: is the first value</li>
<li><code>v1</code>: is the second value</li>
</ul>
<h4 id="reference">Reference:</h4>
<ul>
<li><a href="https://github.com/jamoma/JamomaCore/blob/master/Foundation/library/includes/TTInterpolate.h">https://github.com/jamoma/JamomaCore/blob/master/Foundation/library/includes/TTInterpolate.h</a></li>
</ul>
<hr />
<h3 id="itinterpolate_cosine"><code>(it.)interpolate_cosine</code></h3>
<p>Cosine interpolation between 2 values.</p>
<h4 id="usage_1">Usage</h4>
<pre><code>interpolate_cosine(dv,v0,v1) : _
</code></pre>

<p>Where:</p>
<ul>
<li><code>dv</code>: in the fractional value in [0..1] range</li>
<li><code>v0</code>: is the first value</li>
<li><code>v1</code>: is the second value</li>
</ul>
<h4 id="reference_1">Reference:</h4>
<ul>
<li><a href="https://github.com/jamoma/JamomaCore/blob/master/Foundation/library/includes/TTInterpolate.h">https://github.com/jamoma/JamomaCore/blob/master/Foundation/library/includes/TTInterpolate.h</a></li>
</ul>
<h2 id="four-points-interpolation-functions">Four points interpolation functions</h2>
<hr />
<h3 id="itinterpolate_cubic"><code>(it.)interpolate_cubic</code></h3>
<p>Cubic interpolation between 4 values.</p>
<h4 id="usage_2">Usage</h4>
<pre><code>interpolate_cubic(dv,v0,v1,v2,v3) : _
</code></pre>

<p>Where:</p>
<ul>
<li><code>dv</code>: in the fractional value in [0..1] range</li>
<li><code>v0</code>: is the first value</li>
<li><code>v1</code>: is the second value</li>
<li><code>v2</code>: is the third value</li>
<li><code>v3</code>: is the fourth value</li>
</ul>
<h4 id="reference_2">Reference:</h4>
<ul>
<li><a href="https://www.paulinternet.nl/?page=bicubic">https://www.paulinternet.nl/?page=bicubic</a></li>
</ul>
<h2 id="two-points-interpolators">Two points interpolators</h2>
<hr />
<h3 id="itinterpolator_two_points"><code>(it.)interpolator_two_points</code></h3>
<p>Generic interpolator on two points (current and next index), assuming an increasing index.</p>
<h4 id="usage_3">Usage</h4>
<pre><code>interpolator_two_points(gen, idv, interpolate_two_points) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
<li><code>interpolate_two_points</code>: a two points interpolation function</li>
</ul>
<hr />
<h3 id="itinterpolator_linear"><code>(it.)interpolator_linear</code></h3>
<p>Linear interpolator for a 'gen' circuit triggered by an 'idv' input to generate values.</p>
<h4 id="usage_4">Usage</h4>
<pre><code>interpolator_linear(gen, idv) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
</ul>
<hr />
<h3 id="itinterpolator_cosine"><code>(it.)interpolator_cosine</code></h3>
<p>Cosine interpolator for a 'gen' circuit triggered by an 'idv' input to generate values.</p>
<h4 id="usage_5">Usage</h4>
<pre><code>interpolator_cosine(gen, idv) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
</ul>
<h2 id="four-points-interpolators">Four points interpolators</h2>
<hr />
<h3 id="itinterpolator_two_points_1"><code>(it.)interpolator_two_points</code></h3>
<p>Generic interpolator on interpolator_four_points points (previous, current and two next indexes), assuming an increasing index.</p>
<h4 id="usage_6">Usage</h4>
<pre><code>interpolator_four_points(gen, idv, interpolate_four_points) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
<li><code>interpolate_four_points</code>: a four points interpolation function</li>
</ul>
<hr />
<h3 id="itinterpolator_cubic"><code>(it.)interpolator_cubic</code></h3>
<p>Cubic interpolator for a 'gen' circuit triggered by an 'idv' input to generate values</p>
<h4 id="usage_7">Usage</h4>
<pre><code>interpolator_cubic(gen, idv) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
</ul>
<hr />
<h3 id="itinterpolator_select"><code>(it.)interpolator_select</code></h3>
<p>Generic configurable interpolator (with selector between in [0..3]). The value 3 is used for no interpolation.</p>
<h4 id="usage_8">Usage</h4>
<pre><code>interpolator_select(gen, idv, sel) : _,_... (equal to N = outputs(gen))
</code></pre>

<p>Where:</p>
<ul>
<li><code>gen</code>: a circuit with an 'idv' reader input that produces N outputs</li>
<li><code>idv</code>: a fractional read index expressed as a float value, or a (int,frac) pair</li>
<li><code>sel</code>: an interpolation algorithm selector in [0..3] (0 = linear, 1 = cosine, 2 = cubic, 3 = nointerp)</li>
</ul></div>
            </div>
        </div>

        <footer class="col-md-12">
            <hr>
                <p>Copyright &copy; 2019-2020 <a href="https://www.grame.fr">Grame-CNCM</a></p>
        </footer>
        <script>
            var base_url = "../..",
                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
        </script>
        <script src="../../js/base.js" defer></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" defer></script>
        <script src="../../search/main.js" defer></script>

        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
    <div class="modal-dialog modal-lg">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="searchModalLabel">Search</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
                <p>
                    From here you can search these documents. Enter
                    your search terms below.
                </p>
                <form>
                    <div class="form-group">
                        <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
                    </div>
                </form>
                <div id="mkdocs-search-results"></div>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
    <div class="modal-dialog">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
              <table class="table">
                <thead>
                  <tr>
                    <th style="width: 20%;">Keys</th>
                    <th>Action</th>
                  </tr>
                </thead>
                <tbody>
                  <tr>
                    <td class="help shortcut"><kbd>?</kbd></td>
                    <td>Open this help</td>
                  </tr>
                  <tr>
                    <td class="next shortcut"><kbd>n</kbd></td>
                    <td>Next page</td>
                  </tr>
                  <tr>
                    <td class="prev shortcut"><kbd>p</kbd></td>
                    <td>Previous page</td>
                  </tr>
                  <tr>
                    <td class="search shortcut"><kbd>s</kbd></td>
                    <td>Search</td>
                  </tr>
                </tbody>
              </table>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div>

    </body>
</html>