forked from joao-alegria/RI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
680 lines (579 loc) · 45.1 KB
/
index.html
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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Welcome to RI-Indexer’s documentation! — RI-Indexer 1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-ri-indexer-s-documentation">
<h1>Welcome to RI-Indexer’s documentation!<a class="headerlink" href="#welcome-to-ri-indexer-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-CreateIndex">
<span id="index-creator-script"></span><h2>Index Creator Script<a class="headerlink" href="#module-CreateIndex" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="CreateIndex.assignment1">
<code class="sig-prename descclassname">CreateIndex.</code><code class="sig-name descname">assignment1</code><span class="sig-paren">(</span><em class="sig-param">tokenizer</em>, <em class="sig-param">outputFolder</em>, <em class="sig-param">inputFolder</em>, <em class="sig-param">limit</em>, <em class="sig-param">weightCalc</em>, <em class="sig-param">positionCalc</em><span class="sig-paren">)</span><a class="headerlink" href="#CreateIndex.assignment1" title="Permalink to this definition">¶</a></dt>
<dd><p>Follows the execution flow specific for the first assignment.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tokenizer</strong> (<a class="reference internal" href="#Tokenizer.Tokenizer" title="Tokenizer.Tokenizer"><em>Tokenizer</em></a>) – class instance to be used in the tokenization process</p></li>
<li><p><strong>outputFolder</strong> (<em>str</em>) – name of the folder where the final index will be written to</p></li>
<li><p><strong>inputFiles</strong> (<em>list<str></em>) – list of the names of the files containing the textual information to be indexed</p></li>
<li><p><strong>limit</strong> (<em>int</em>) – limit number of documents to have in consideration, None if no limit</p></li>
<li><p><strong>weightCalc</strong> (<em>bool</em>) – True if the term weights are to be calculated, False if not</p></li>
<li><p><strong>positionCalc</strong> (<em>bool</em>) – True if the term positions are to be calculated, False if not</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="CreateIndex.assignment2">
<code class="sig-prename descclassname">CreateIndex.</code><code class="sig-name descname">assignment2</code><span class="sig-paren">(</span><em class="sig-param">tokenizer</em>, <em class="sig-param">outputFolder</em>, <em class="sig-param">inputFolder</em>, <em class="sig-param">limit</em>, <em class="sig-param">weightCalc</em>, <em class="sig-param">positionCalc</em>, <em class="sig-param">maximumRAM</em><span class="sig-paren">)</span><a class="headerlink" href="#CreateIndex.assignment2" title="Permalink to this definition">¶</a></dt>
<dd><p>Follows the execution flow specific for the second assignment.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tokenizer</strong> (<a class="reference internal" href="#Tokenizer.Tokenizer" title="Tokenizer.Tokenizer"><em>Tokenizer</em></a>) – class instance to be used in the tokenization process</p></li>
<li><p><strong>outputFolder</strong> (<em>str</em>) – name of the folder where the final index will be written to</p></li>
<li><p><strong>inputFolder</strong> (<em>list<str></em>) – list of one element representing the name of the folder that contains the files with the textual information to be indexed</p></li>
<li><p><strong>limit</strong> (<em>int</em>) – limit number of documents to have in consideration, None if no limit</p></li>
<li><p><strong>weightCalc</strong> (<em>bool</em>) – True if the term weights are to be calculated, False if not</p></li>
<li><p><strong>positionCalc</strong> (<em>bool</em>) – True if the term positions are to be calculated, False if not</p></li>
<li><p><strong>maximumRAM</strong> (<em>int</em>) – maximum amount of RAM (in Gb) allowed for the program execution</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="CreateIndex.isMemoryAvailable">
<code class="sig-prename descclassname">CreateIndex.</code><code class="sig-name descname">isMemoryAvailable</code><span class="sig-paren">(</span><em class="sig-param">maximumRAM</em><span class="sig-paren">)</span><a class="headerlink" href="#CreateIndex.isMemoryAvailable" title="Permalink to this definition">¶</a></dt>
<dd><p>Auxiliary function used to determine whether there is still memory available to keep reading information from the input files or not.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>maximumRAM</strong> (<em>int</em>) – maximum amount of RAM (in Gb) allowed for the program execution</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the memory usage is under 85% of the maximum RAM allowed, false if not</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="CreateIndex.main">
<code class="sig-prename descclassname">CreateIndex.</code><code class="sig-name descname">main</code><span class="sig-paren">(</span><em class="sig-param">argv</em><span class="sig-paren">)</span><a class="headerlink" href="#CreateIndex.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Main script for all of the discipline’s assignments. This script is responsable for calling the correct classes and for creating the data flow necessary for the index to be created and persisted.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>argv</strong> (<em>list<str></em>) – receives the arguments passed to the program during execution</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-FileParser">
<span id="file-parser-module"></span><h2>File Parser Module<a class="headerlink" href="#module-FileParser" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="FileParser.FileParser">
<em class="property">class </em><code class="sig-prename descclassname">FileParser.</code><code class="sig-name descname">FileParser</code><span class="sig-paren">(</span><em class="sig-param">inputFolder</em>, <em class="sig-param">limit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.FileParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>Abstract class that serves as template and interface for future instances and implementations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>files</strong> – list of file names to be processed</p></li>
<li><p><strong>limit</strong> (<em>int</em>) – limit number of documents to have in consideration, None if no limit</p></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="FileParser.FileParser.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.FileParser.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="FileParser.FileParser.getContent">
<em class="property">abstract </em><code class="sig-name descname">getContent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.FileParser.getContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that processes the files passed to the object during it’s creation.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="FileParser.GZipFileParser">
<em class="property">class </em><code class="sig-prename descclassname">FileParser.</code><code class="sig-name descname">GZipFileParser</code><span class="sig-paren">(</span><em class="sig-param">inputFolder</em>, <em class="sig-param">limit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.GZipFileParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#FileParser.FileParser" title="FileParser.FileParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileParser.FileParser</span></code></a></p>
<p>Implementation of a file parser dedicated to the current context of RI. Processing of one or varios zip files.</p>
<dl class="method">
<dt id="FileParser.GZipFileParser.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.GZipFileParser.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="FileParser.GZipFileParser.getContent">
<code class="sig-name descname">getContent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.GZipFileParser.getContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the function defined by the abstract class. Fetches the PMID and the TI.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dictionary where the key is the sequencial ID of the document and the value the TI</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>map<str, str></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="FileParser.LimitedRamFileParser">
<em class="property">class </em><code class="sig-prename descclassname">FileParser.</code><code class="sig-name descname">LimitedRamFileParser</code><span class="sig-paren">(</span><em class="sig-param">files</em>, <em class="sig-param">limit</em><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.LimitedRamFileParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#FileParser.FileParser" title="FileParser.FileParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileParser.FileParser</span></code></a></p>
<dl class="method">
<dt id="FileParser.LimitedRamFileParser.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.LimitedRamFileParser.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="FileParser.LimitedRamFileParser.getContent">
<code class="sig-name descname">getContent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FileParser.LimitedRamFileParser.getContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the function defined by the abstract class. Fetches the PMID and the TI.
Differs from the implementation in GZipFileParser as it reads each line in the input file separately for memory usage reduction purposes.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dictionary where the key is the sequential ID of the document and the value the TI</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>map<str, str></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-IndexAnalyzer">
<span id="index-analyzer-auxiliar-script"></span><h2>Index Analyzer Auxiliar Script<a class="headerlink" href="#module-IndexAnalyzer" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="IndexAnalyzer.buildDict">
<code class="sig-prename descclassname">IndexAnalyzer.</code><code class="sig-name descname">buildDict</code><span class="sig-paren">(</span><em class="sig-param">outputFileName</em><span class="sig-paren">)</span><a class="headerlink" href="#IndexAnalyzer.buildDict" title="Permalink to this definition">¶</a></dt>
<dd><p>Reads index output file and builds dictionary with terms as keys and number of occurrences as values</p>
<dl class="field-list simple">
<dt class="field-odd">Param</dt>
<dd class="field-odd"><p>outputFileName: name of the file to be processed</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="IndexAnalyzer.filterByOccur">
<code class="sig-prename descclassname">IndexAnalyzer.</code><code class="sig-name descname">filterByOccur</code><span class="sig-paren">(</span><em class="sig-param">n</em><span class="sig-paren">)</span><a class="headerlink" href="#IndexAnalyzer.filterByOccur" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds the subset of the dictionary where the values are equal to value passed to the function.</p>
<dl class="field-list simple">
<dt class="field-odd">Param</dt>
<dd class="field-odd"><p>n: value that the user wants to find</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>subset of the dictionary that contains the value passed</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>map<str, int></p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="IndexAnalyzer.main">
<code class="sig-prename descclassname">IndexAnalyzer.</code><code class="sig-name descname">main</code><span class="sig-paren">(</span><em class="sig-param">args</em><span class="sig-paren">)</span><a class="headerlink" href="#IndexAnalyzer.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that answers to some of the assignments’ questions by calculating some properties of the output files.</p>
<dl class="field-list simple">
<dt class="field-odd">Param</dt>
<dd class="field-odd"><p>args: the list of arguments passed to the script when executed</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-Indexer">
<span id="indexer-module"></span><h2>Indexer Module<a class="headerlink" href="#module-Indexer" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="Indexer.FileIndexer">
<em class="property">class </em><code class="sig-prename descclassname">Indexer.</code><code class="sig-name descname">FileIndexer</code><span class="sig-paren">(</span><em class="sig-param">tokenizer</em>, <em class="sig-param">positions</em>, <em class="sig-param">fileParser=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.FileIndexer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Indexer.Indexer" title="Indexer.Indexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Indexer.Indexer</span></code></a></p>
<p>Implementation of a indexer dedicated to the first assignment.</p>
<dl class="method">
<dt id="Indexer.FileIndexer.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.FileIndexer.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="Indexer.FileIndexer.createIndex">
<code class="sig-name descname">createIndex</code><span class="sig-paren">(</span><em class="sig-param">content=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.FileIndexer.createIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the function defined by the abstract class.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Indexer.Indexer">
<em class="property">class </em><code class="sig-prename descclassname">Indexer.</code><code class="sig-name descname">Indexer</code><span class="sig-paren">(</span><em class="sig-param">tokenizer</em>, <em class="sig-param">positions</em>, <em class="sig-param">fileParser=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.Indexer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>Abstract class and interface for several types of index persistances implementations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fileParser</strong> (<a class="reference internal" href="#FileParser.FileParser" title="FileParser.FileParser"><em>FileParser</em></a>) – instance of the file parser used in the context to retrieve the data from the corpus</p></li>
<li><p><strong>tokenizer</strong> (<em>boolean</em>) – instance of the tokenizer used in the context to process the content of the corpus</p></li>
<li><p><strong>tokenizer</strong> – flag that indicates if it’s necessary process positions</p></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="Indexer.Indexer.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.Indexer.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="Indexer.Indexer.createIndex">
<em class="property">abstract </em><code class="sig-name descname">createIndex</code><span class="sig-paren">(</span><em class="sig-param">content=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Indexer.Indexer.createIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that creates the entire index by iterating over the corpus content and with the help of the tokenizer process and create the token index</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-PersistIndex">
<span id="index-persistance-module"></span><h2>Index Persistance Module<a class="headerlink" href="#module-PersistIndex" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="PersistIndex.PersistCSV">
<em class="property">class </em><code class="sig-prename descclassname">PersistIndex.</code><code class="sig-name descname">PersistCSV</code><span class="sig-paren">(</span><em class="sig-param">outputFolder</em>, <em class="sig-param">indexer=None</em>, <em class="sig-param">totalNumDocs=1</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSV" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#PersistIndex.PersistIndex" title="PersistIndex.PersistIndex"><code class="xref py py-class docutils literal notranslate"><span class="pre">PersistIndex.PersistIndex</span></code></a></p>
<dl class="simple">
<dt>Implementation of the index persister dedicated to first assignment. This instance persists the index in a text file, following a CSV-like format, such as:</dt><dd><p>token1,docID1:numOcur,docID2:numOcur,…
token2,docID1:numOcur,docID2:numOcur,…</p>
</dd>
</dl>
<dl class="method">
<dt id="PersistIndex.PersistCSV.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSV.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistCSV.persist">
<code class="sig-name descname">persist</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">overrideFile=None</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSV.persist" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that effectively persists the data in a CSV format.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="PersistIndex.PersistCSVPosition">
<em class="property">class </em><code class="sig-prename descclassname">PersistIndex.</code><code class="sig-name descname">PersistCSVPosition</code><span class="sig-paren">(</span><em class="sig-param">outputFolder</em>, <em class="sig-param">indexer=None</em>, <em class="sig-param">totalNumDocs=1</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVPosition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#PersistIndex.PersistIndex" title="PersistIndex.PersistIndex"><code class="xref py py-class docutils literal notranslate"><span class="pre">PersistIndex.PersistIndex</span></code></a></p>
<dl class="simple">
<dt>Implementation of the index persister dedicated to the second assignment. This instance persists the index in a text file, following a CSV-like format, such as:</dt><dd><p>token1,docID1:docFreq1:pos1,pos2,…; docID2:docFreq2:pos1,pos2,…; …
token2,docID1:docFreq1:pos1,pos2,…; docID2:docFreq1:pos1,pos2,…; …</p>
</dd>
</dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVPosition.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVPosition.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVPosition.persist">
<code class="sig-name descname">persist</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">overrideFile=None</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVPosition.persist" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that effectively persists the data.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="PersistIndex.PersistCSVWeighted">
<em class="property">class </em><code class="sig-prename descclassname">PersistIndex.</code><code class="sig-name descname">PersistCSVWeighted</code><span class="sig-paren">(</span><em class="sig-param">outputFolder</em>, <em class="sig-param">indexer=None</em>, <em class="sig-param">totalNumDocs=1</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeighted" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#PersistIndex.PersistIndex" title="PersistIndex.PersistIndex"><code class="xref py py-class docutils literal notranslate"><span class="pre">PersistIndex.PersistIndex</span></code></a></p>
<dl class="simple">
<dt>Implementation of the index persister dedicated to the second assignment. This instance persists the index in a text file, following a CSV-like format, such as:</dt><dd><p>token1:idf1; docID1:tfw1; docID2:tfw2;…
token2:idf2; docID1:tfw1; docID2:tfw2;…</p>
</dd>
</dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVWeighted.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeighted.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVWeighted.persist">
<code class="sig-name descname">persist</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">overrideFile=None</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeighted.persist" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that effectively persists the data.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="PersistIndex.PersistCSVWeightedPosition">
<em class="property">class </em><code class="sig-prename descclassname">PersistIndex.</code><code class="sig-name descname">PersistCSVWeightedPosition</code><span class="sig-paren">(</span><em class="sig-param">outputFolder</em>, <em class="sig-param">indexer=None</em>, <em class="sig-param">totalNumDocs=1</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeightedPosition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#PersistIndex.PersistIndex" title="PersistIndex.PersistIndex"><code class="xref py py-class docutils literal notranslate"><span class="pre">PersistIndex.PersistIndex</span></code></a></p>
<dl class="simple">
<dt>Implementation of the index persister dedicated to the second assignment. This instance persists the index in a text file, following a CSV-like format, such as:</dt><dd><p>token1:idf1; docID1:tfw1:pos1,pos2,…; docID2:tfw2:…; …
token2:idf2; docID1:tfw1:pos1,pos2,…; docID2:tfw2:…; …</p>
</dd>
</dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVWeightedPosition.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeightedPosition.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistCSVWeightedPosition.persist">
<code class="sig-name descname">persist</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">overrideFile=None</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistCSVWeightedPosition.persist" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that effectively persists the data.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="PersistIndex.PersistIndex">
<em class="property">class </em><code class="sig-prename descclassname">PersistIndex.</code><code class="sig-name descname">PersistIndex</code><span class="sig-paren">(</span><em class="sig-param">outputFolder</em>, <em class="sig-param">indexer=None</em>, <em class="sig-param">totalNumDocs=1</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>Abstract class and interface for several types of index persistance implementations, due to file format or processing method</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>outputFolder</strong> (<em>str</em>) – name of the folder were the information should be written too</p></li>
<li><p><strong>indexer</strong> (<a class="reference internal" href="#Indexer.Indexer" title="Indexer.Indexer"><em>Indexer</em></a>) – instance of the indexer used in the context to create the corpus index</p></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="PersistIndex.PersistIndex.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistIndex.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistIndex.persist">
<em class="property">abstract </em><code class="sig-name descname">persist</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">overrideFile=None</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistIndex.persist" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that effectively persists the data.</p>
</dd></dl>
<dl class="method">
<dt id="PersistIndex.PersistIndex.setTotalNumDocs">
<em class="property">classmethod </em><code class="sig-name descname">setTotalNumDocs</code><span class="sig-paren">(</span><em class="sig-param">totalNumDocs</em><span class="sig-paren">)</span><a class="headerlink" href="#PersistIndex.PersistIndex.setTotalNumDocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Setter function for the variable totalNumDocs.</p>
<dl class="field-list simple">
<dt class="field-odd">Param</dt>
<dd class="field-odd"><p>totalNumDocs: number of documents to be processed.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-Tokenizer">
<span id="tokenizer-module"></span><h2>Tokenizer Module<a class="headerlink" href="#module-Tokenizer" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="Tokenizer.ComplexTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">Tokenizer.</code><code class="sig-name descname">ComplexTokenizer</code><a class="headerlink" href="#Tokenizer.ComplexTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Tokenizer.Tokenizer" title="Tokenizer.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer.Tokenizer</span></code></a></p>
<p>Implementation of a tokenizer dedicated to the current context of RI. This instance is the complex implementation porposed in 2.2. This version uses the PorterStemmer, eliminates stop words and implements some personal rules in relation to special characters(split by [ -_], keeps dates, emails, money, digits, … ; eliminates majority of the punctuantion)</p>
<dl class="method">
<dt id="Tokenizer.ComplexTokenizer.clearTokens">
<code class="sig-name descname">clearTokens</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.ComplexTokenizer.clearTokens" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees memory by emptying the tokens list.</p>
</dd></dl>
<dl class="method">
<dt id="Tokenizer.ComplexTokenizer.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.ComplexTokenizer.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="Tokenizer.ComplexTokenizer.tokenize">
<code class="sig-name descname">tokenize</code><span class="sig-paren">(</span><em class="sig-param">processText</em><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.ComplexTokenizer.tokenize" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the more complex tokenization process, with the use of a Stemmer and list of stop words.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>processText</strong> (<em>str</em>) – text that will be tokenized</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Tokenizer.SimpleTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">Tokenizer.</code><code class="sig-name descname">SimpleTokenizer</code><a class="headerlink" href="#Tokenizer.SimpleTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Tokenizer.Tokenizer" title="Tokenizer.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer.Tokenizer</span></code></a></p>
<p>Implementation of a tokenizer dedicated to the first assignment. This instance is the simple implementation, spliting by ” ” and eliminating all non-alphabetic characters.</p>
<dl class="method">
<dt id="Tokenizer.SimpleTokenizer.clearTokens">
<code class="sig-name descname">clearTokens</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.SimpleTokenizer.clearTokens" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees memory by emptying the tokens list.</p>
</dd></dl>
<dl class="method">
<dt id="Tokenizer.SimpleTokenizer.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.SimpleTokenizer.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="Tokenizer.SimpleTokenizer.tokenize">
<code class="sig-name descname">tokenize</code><span class="sig-paren">(</span><em class="sig-param">processText</em><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.SimpleTokenizer.tokenize" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the simple tokenization process.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>processText</strong> (<em>str</em>) – text that will be tokenized</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Tokenizer.Tokenizer">
<em class="property">class </em><code class="sig-prename descclassname">Tokenizer.</code><code class="sig-name descname">Tokenizer</code><a class="headerlink" href="#Tokenizer.Tokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>Abstract class and interface for the various possible implementations of tokenizers</p>
<dl class="method">
<dt id="Tokenizer.Tokenizer.clearVar">
<code class="sig-name descname">clearVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.Tokenizer.clearVar" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that frees the memory currently in use by emptying all class variables.</p>
</dd></dl>
<dl class="method">
<dt id="Tokenizer.Tokenizer.tokenize">
<em class="property">abstract </em><code class="sig-name descname">tokenize</code><span class="sig-paren">(</span><em class="sig-param">porcessText</em><span class="sig-paren">)</span><a class="headerlink" href="#Tokenizer.Tokenizer.tokenize" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that receives a string and tokenizes it, applying as many rules as implemented by the user.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>processText</strong> (<em>str</em>) – text that will be tokenized</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-Merger">
<span id="merger-module"></span><h2>Merger Module<a class="headerlink" href="#module-Merger" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="Merger.Merger">
<em class="property">class </em><code class="sig-prename descclassname">Merger.</code><code class="sig-name descname">Merger</code><span class="sig-paren">(</span><em class="sig-param">intermediateIndex</em>, <em class="sig-param">totalNumDocs</em>, <em class="sig-param">outputFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#Merger.Merger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>Abstract class and interface for several types of index merging implementations, due to file format or processing method</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>intermediateIndex</strong> (<em>list<str></em>) – list of the names of the intermedia indexes to be merged</p></li>
<li><p><strong>indexer</strong> (<a class="reference internal" href="#Indexer.Indexer" title="Indexer.Indexer"><em>Indexer</em></a>) – instance of the indexer used in the context to create the corpus index</p></li>
<li><p><strong>outputFolder</strong> (<em>str</em>) – name of the folder where to store the final index</p></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="Merger.Merger.mergeIndex">
<em class="property">abstract </em><code class="sig-name descname">mergeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.Merger.mergeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that merges the intermediate indexes (or blocks of them) into one final index according to our memory-intelligent strategy.</p>
</dd></dl>
<dl class="method">
<dt id="Merger.Merger.writeIndex">
<em class="property">abstract </em><code class="sig-name descname">writeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.Merger.writeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that writes the final index (or blocks of it) to disk according to our memory-intelligent strategy.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Merger.PositionMerger">
<em class="property">class </em><code class="sig-prename descclassname">Merger.</code><code class="sig-name descname">PositionMerger</code><span class="sig-paren">(</span><em class="sig-param">intermediateIndex</em>, <em class="sig-param">totalNumDocs</em>, <em class="sig-param">outputFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Merger.Merger" title="Merger.Merger"><code class="xref py py-class docutils literal notranslate"><span class="pre">Merger.Merger</span></code></a></p>
<dl class="method">
<dt id="Merger.PositionMerger.mergeIndex">
<code class="sig-name descname">mergeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionMerger.mergeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the merge function adapted to the positions format.</p>
</dd></dl>
<dl class="method">
<dt id="Merger.PositionMerger.writeIndex">
<code class="sig-name descname">writeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionMerger.writeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the write function adapted to the positions format.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Merger.PositionWeightMerger">
<em class="property">class </em><code class="sig-prename descclassname">Merger.</code><code class="sig-name descname">PositionWeightMerger</code><span class="sig-paren">(</span><em class="sig-param">intermediateIndex</em>, <em class="sig-param">totalNumDocs</em>, <em class="sig-param">outputFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionWeightMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Merger.Merger" title="Merger.Merger"><code class="xref py py-class docutils literal notranslate"><span class="pre">Merger.Merger</span></code></a></p>
<dl class="method">
<dt id="Merger.PositionWeightMerger.mergeIndex">
<code class="sig-name descname">mergeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionWeightMerger.mergeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the merge function adapted to the positions and weights format.</p>
</dd></dl>
<dl class="method">
<dt id="Merger.PositionWeightMerger.writeIndex">
<code class="sig-name descname">writeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.PositionWeightMerger.writeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the write function adapted to the positions and weights format.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Merger.SimpleMerger">
<em class="property">class </em><code class="sig-prename descclassname">Merger.</code><code class="sig-name descname">SimpleMerger</code><span class="sig-paren">(</span><em class="sig-param">intermediateIndex</em>, <em class="sig-param">totalNumDocs</em>, <em class="sig-param">outputFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#Merger.SimpleMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Merger.Merger" title="Merger.Merger"><code class="xref py py-class docutils literal notranslate"><span class="pre">Merger.Merger</span></code></a></p>
<dl class="method">
<dt id="Merger.SimpleMerger.mergeIndex">
<code class="sig-name descname">mergeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.SimpleMerger.mergeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the merge function adapted to the assignment’s 1 format.</p>
</dd></dl>
<dl class="method">
<dt id="Merger.SimpleMerger.writeIndex">
<code class="sig-name descname">writeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.SimpleMerger.writeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the write function adapted to the assignment’s 1 format.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="Merger.WeightMerger">
<em class="property">class </em><code class="sig-prename descclassname">Merger.</code><code class="sig-name descname">WeightMerger</code><span class="sig-paren">(</span><em class="sig-param">intermediateIndex</em>, <em class="sig-param">totalNumDocs</em>, <em class="sig-param">outputFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#Merger.WeightMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Merger.Merger" title="Merger.Merger"><code class="xref py py-class docutils literal notranslate"><span class="pre">Merger.Merger</span></code></a></p>
<dl class="method">
<dt id="Merger.WeightMerger.mergeIndex">
<code class="sig-name descname">mergeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.WeightMerger.mergeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the merge function adapted to the weights format.</p>
</dd></dl>
<dl class="method">
<dt id="Merger.WeightMerger.writeIndex">
<code class="sig-name descname">writeIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Merger.WeightMerger.writeIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Variation of the write function adapted to the weights format.</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">RI-Indexer</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2019, Joao Alegria & FIlipe Pires.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>