File: finder.h

package info (click to toggle)
seqan2 2.4.0%2Bdfsg-16
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 224,180 kB
  • sloc: cpp: 256,886; ansic: 91,672; python: 8,330; sh: 995; xml: 570; makefile: 252; awk: 51; javascript: 21
file content (814 lines) | stat: -rw-r--r-- 34,518 bytes parent folder | download | duplicates (5)
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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2018, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Enrico Siragusa <enrico.siragusa@fu-berlin.de>
// ==========================================================================
// This file contains the DbFinder class.
// ==========================================================================

#ifndef SANDBOX_ESIRAGUSA_APPS_SEARCHJOIN_DBFINDER_H_
#define SANDBOX_ESIRAGUSA_APPS_SEARCHJOIN_DBFINDER_H_

#include <seqan/basic.h>
#include <seqan/sequence.h>
#include <seqan/index.h>
#include <seqan/parallel.h>

#include "verifier.h"

using namespace seqan;

// ============================================================================
// Tags, Classes, Enums
// ============================================================================

// ----------------------------------------------------------------------------
// Tag Online
// ----------------------------------------------------------------------------

struct Online_;
typedef Tag<Online_>    Online;

// ----------------------------------------------------------------------------
// Tag Top
// ----------------------------------------------------------------------------

struct Top_;
typedef Tag<Top_>       Top;

// ----------------------------------------------------------------------------
// Tag Bottom
// ----------------------------------------------------------------------------

struct Bottom_;
typedef Tag<Bottom_>    Bottom;

// ----------------------------------------------------------------------------
// Class DbFinder
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec = void>
struct DbFinder
{
    typedef Db<TText>                                               TDb;
    typedef Db<TText, TDbQuerySpec>                                 TDbQuery;
    typedef DbIndex<TIndex>                                         TDbIndex;
    typedef DbIndex<TIndex, Query>                                  TDbQueryIndex;
    typedef Verifier<TText, TDbQuerySpec>                           TVerifier;
    typedef typename Size<TText>::Type                              TTextSize;

    TDb /* const */     & db;
    TDbIndex            dbIndex;
    Holder<TDbQuery>    query;
    TDbQueryIndex       queryIndex;
    TDelegate           & delegate;
    TVerifier           verifier;
    TTextSize           minSeedLength;

    DbFinder(TDb /* const */ & db, TDelegate & delegate) :
        db(db),
        dbIndex(),
        delegate(delegate),
        verifier(db),
        minSeedLength(0)
    {}

    template <typename TFinder>
    void operator()(TFinder const & finder)
    {
        onFind(*this, finder);
    }
};

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
struct DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Parallel>
{
    typedef Db<TText>                                           TDb;
    typedef Db<TText, TDbQuerySpec>                             TDbQuery;
    typedef DbIndex<TIndex>                                     TDbIndex;
    typedef DbIndex<TIndex, Query>                              TDbQueryIndex;
    typedef Verifier<TText, TDbQuerySpec>                       TVerifier;
    typedef typename Size<TText>::Type                          TTextSize;
    typedef typename Size<TIndex>::Type                         TDepth;

    typedef Backtracking<HammingDistance, Bottom>               TBacktrackingExt;
    typedef Backtracking<EditDistance, Bottom>                  TBacktrackingApx;
    typedef Finder_<TIndex, TIndex, TBacktrackingExt>           TFinderExt;
    typedef Finder_<TIndex, TIndex, TBacktrackingApx>           TFinderApx;
    typedef String<TFinderApx>                                  TFindersApx;
    typedef String<TFinderExt>                                  TFindersExt;

    TDb /* const */     & db;
    TDbIndex            dbIndex;
    Holder<TDbQuery>    query;
    TDbQueryIndex       queryIndex;
    TDelegate           & delegate;
    TVerifier           verifier;
    TTextSize           minSeedLength;

    TDepth              parallelDepth;
    TFindersExt         findersExt;
    TFindersApx         findersApx;

    DbFinder(TDb /* const */ & db, TDelegate & delegate) :
        db(db),
        dbIndex(),
        delegate(delegate),
        verifier(db),
        minSeedLength(0),
        parallelDepth(2)
    {}

    template <typename TFinder>
    void operator()(TFinder const & finder)
    {
        onFind(*this, finder);
    }
};

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
struct DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Online>
{
    typedef Db<TText>                                               TDb;
    typedef Db<TText, TDbQuerySpec>                                 TDbQuery;
    typedef Verifier<TText, TDbQuerySpec>                           TVerifier;
    typedef typename Size<TText>::Type                              TTextSize;

    TDb /* const */     & db;
    Holder<TDbQuery>    query;
    TDelegate           & delegate;
    TVerifier           verifier;

    DbFinder(TDb /* const */ & db, TDelegate & delegate) :
        db(db),
        delegate(delegate),
        verifier(db)
    {}
};

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
struct DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact>
{
    typedef Db<TText>                                               TDb;
    typedef Db<TText, TDbQuerySpec>                                 TDbQuery;
    typedef DbIndex<TIndex>                                         TDbIndex;

    TDb /* const */     & db;
    TDbIndex            dbIndex;
    TDelegate           & delegate;

    DbFinder(TDb /* const */ & db, TDelegate & delegate) :
        db(db),
        delegate(delegate)
    {}
};

// ============================================================================
// Metafunctions
// ============================================================================

// ----------------------------------------------------------------------------
// Metafunction PatternIterator_
// ----------------------------------------------------------------------------

namespace seqan {

template <typename TDistance, typename TSpec>
struct PatternIterator_<TDbDnaSaSmall, TDbDnaSaSmall, Backtracking<TDistance, TSpec> >
{
    typedef typename Iterator<TDbDnaSaSmall, TopDown<Truncated<Preorder> > >::Type  Type;
};

template <typename TDistance, typename TSpec>
struct PatternIterator_<TDbGeoSaSmall, TDbGeoSaSmall, Backtracking<TDistance, TSpec> >
{
    typedef typename Iterator<TDbGeoSaSmall, TopDown<Truncated<Preorder> > >::Type  Type;
};

template <typename TDistance, typename TSpec>
struct PatternIterator_<TDbDnaSaHuge, TDbDnaSaHuge, Backtracking<TDistance, TSpec> >
{
    typedef typename Iterator<TDbDnaSaHuge, TopDown<Truncated<Preorder> > >::Type  Type;
};

template <typename TDistance, typename TSpec>
struct PatternIterator_<TDbGeoSaHuge, TDbGeoSaHuge, Backtracking<TDistance, TSpec> >
{
    typedef typename Iterator<TDbGeoSaHuge, TopDown<Truncated<Preorder> > >::Type  Type;
};

// ============================================================================
// Functions
// ============================================================================

// ----------------------------------------------------------------------------
// Function _inTerminalState()                          [Finder_<Backtracking>]
// ----------------------------------------------------------------------------

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_inTerminalState(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<HammingDistance, Top> > const & finder,
                 StageFinal_ const & /* tag */)
{
    return _inActiveState(finder, StageFinal_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_inTerminalState(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & finder,
                 StageLower_ const & /* tag */)
{
    return _inActiveState(finder, StageLower_());
}

// ----------------------------------------------------------------------------
// Function _moveToNextStage()                          [Finder_<Backtracking>]
// ----------------------------------------------------------------------------

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_moveToNextStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & /* finder */,
                 StageLower_ const & /* tag */)
{
    return false;
}

// ----------------------------------------------------------------------------
// Function _stayInCurrentStage()                       [Finder_<Backtracking>]
// ----------------------------------------------------------------------------

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<HammingDistance, Top> > const & finder,
                    StageInitial_ const & /* tag */)
{
    return !_moveToNextStage(finder, StageInitial_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<HammingDistance, Top> > const & finder,
                    StageExact_ const & /* tag */)
{
    return !_moveToNextStage(finder, StageExact_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & finder,
                    StageInitial_ const & /* tag */)
{
    return !_moveToNextStage(finder, StageInitial_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & finder,
                    StageUpper_ const & /* tag */)
{
    return !_moveToNextStage(finder, StageUpper_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & finder,
                    StageDiagonal_ const & /* tag */)
{
    return !_moveToNextStage(finder, StageDiagonal_());
}

template <typename TText, typename TTextIndexSpec, typename TPattern, typename TPatternIndexSpec>
inline bool
_stayInCurrentStage(Finder_<Index<TText, TTextIndexSpec>, Index<TPattern, TPatternIndexSpec>, Backtracking<EditDistance, Top> > const & /* finder */,
                    StageLower_ const & /* tag */)
{
    return true;
}

} // namespace seqan

// ----------------------------------------------------------------------------
// Function setMinSeedLength()                                       [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec, typename TSeedLength>
void setMinSeedLength(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> & dbFinder, TSeedLength minSeedLength)
{
    dbFinder.minSeedLength = minSeedLength;
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSeedLength>
void setMinSeedLength(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Online> & /* dbFinder */, TSeedLength /* minSeedLength */)
{}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSeedLength>
void setMinSeedLength(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact> & /* dbFinder */, TSeedLength /* minSeedLength */)
{}

// ----------------------------------------------------------------------------
// Function index()                                                  [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec>
void index(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> & dbFinder)
{
    // Build database index.
    build(dbFinder.dbIndex, dbFinder.db, Default());

    // Free some memory if we don't need a q-gram directory
    clear(dbFinder.dbIndex.dir);
    shrinkToFit(dbFinder.dbIndex.dir);
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void index(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact> & dbFinder)
{
    // Build database index.
    build(dbFinder.dbIndex, dbFinder.db, seqan::Exact());
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void index(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Online> & /* dbFinder */)
{}

// ----------------------------------------------------------------------------
// Function prepare()                                                [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec>
void prepare(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> & dbFinder, Db<TText, TDbQuerySpec> & query)
{
    // Set query.
    setValue(dbFinder.query, query);
    setValue(dbFinder.verifier.query, query);

    // Build query index.
    buildQuery(dbFinder.queryIndex, value(dbFinder.query), dbFinder.minSeedLength);
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void prepare(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Online> & dbFinder, Db<TText, TDbQuerySpec> & query)
{
    // Set query.
    setValue(dbFinder.query, query);
    setValue(dbFinder.verifier.query, query);
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void prepare(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact> &, Db<TText, TDbQuerySpec> &)
{}

// ----------------------------------------------------------------------------
// Function onFind()                                                 [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec, typename TBacktracking>
inline void
onFind(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> & dbFinder,
       Finder_<TIndex, TIndex, TBacktracking> const & finder)
{
    typedef typename TextIterator_<TIndex, TIndex, TBacktracking>::Type     TTextIterator;
    typedef typename PatternIterator_<TIndex, TIndex, TBacktracking>::Type  TPatternIterator;
    typedef typename Size<TIndex>::Type                                     TSize;
    //typedef typename Size<TText>::Type                                    TErrors;
    typedef typename Fibre<TIndex, FibreSA>::Type const                     TSAFibre;
    typedef typename Infix<TSAFibre>::Type                                  TOccurrences;

    TTextIterator const & textIt = back(finder.textStack);
    TPatternIterator const & patternIt = back(finder.patternStack);

    TOccurrences textOccurrences = getOccurrences(textIt);
    TOccurrences patternOccurrences = getEmptyEdges(patternIt);

    TSize textOccurrencesCount = length(textOccurrences);
    TSize patternOccurrencesCount = length(patternOccurrences);

    for (TSize i = 0; i < textOccurrencesCount; ++i)
        for (TSize j = 0; j < patternOccurrencesCount; ++j)
        {
            TSize dbId1 = getSeqNo(textOccurrences[i]);
            TSize dbId2 = getSeqNo(patternOccurrences[j]);
            TSize pos1 = getSeqOffset(textOccurrences[i]);
            TSize pos2 = getSeqOffset(patternOccurrences[j]);

            if (_validHit(dbFinder, dbId1, dbId2, pos1, pos2))
                dbFinder.verifier(dbId1, dbId2, dbFinder.delegate);
        }
}

// ----------------------------------------------------------------------------
// Function _validHit()                                              [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec>
inline bool
_validHit(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> const & dbFinder,
          typename Size<TIndex>::Type dbId1,
          typename Size<TIndex>::Type dbId2,
          typename Size<TIndex>::Type pos1,
          typename Size<TIndex>::Type pos2)
{
    if (dbId1 >= dbId2)
        return false;

    int maxErrors = getErrors(value(dbFinder.query), dbId2);
    int dbLen1 = length(dbFinder.db.text[dbId1]);
    int dbLen2 = length(dbFinder.db.text[dbId2]);

    // Check maximal length difference.
    if (dbLen1 + maxErrors < dbLen2 || dbLen2 + maxErrors < dbLen1)
        return false;

    // Check band according to Lemma 1.
    int diag = pos1 - pos2;
    int leftDiag = -((dbLen2 - dbLen1 + maxErrors) / 2);
    int rightDiag =  (dbLen1 - dbLen2 + maxErrors) / 2;

    return (leftDiag <= diag && diag <= rightDiag);
}

template <typename TText, typename TIndex, typename TDelegate, typename TSpec>
inline bool
_validHit(DbFinder<TText, TIndex, Query, TDelegate, TSpec> const & dbFinder,
          typename Size<TIndex>::Type dbId1,
          typename Size<TIndex>::Type dbId2,
          typename Size<TIndex>::Type pos1,
          typename Size<TIndex>::Type pos2)
{
    int maxErrors = getErrors(value(dbFinder.query), dbId2);
    int dbLen1 = length(dbFinder.db.text[dbId1]);
    int dbLen2 = length(value(dbFinder.query).text[dbId2]);

    // Check maximal length difference.
    if (dbLen1 + maxErrors < dbLen2 || dbLen2 + maxErrors < dbLen1)
        return false;

    // Check band according to Lemma 1.
    int diag = pos1 - pos2;
    int leftDiag = -((dbLen2 - dbLen1 + maxErrors) / 2);
    int rightDiag =  (dbLen1 - dbLen2 + maxErrors) / 2;

    if (!(leftDiag <= diag && diag <= rightDiag))
        return false;

    return true;
}

// ----------------------------------------------------------------------------
// Function onFind()                                       [DbFinder<Parallel>]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
inline void
onFind(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Parallel> & dbFinder,
       Finder_<TIndex, TIndex, Backtracking<EditDistance, Top> > const & finder)
{
    typedef Backtracking<EditDistance, Bottom>                          TBacktracking;
    typedef Finder_<TIndex, TIndex, TBacktracking>                      TFinder;

    TFinder finderBottom;
    _setScoreThreshold(finderBottom, finder.maxScore);
    appendValue(finderBottom.textStack, back(finder.textStack));
    appendValue(finderBottom.patternStack, back(finder.patternStack));
    appendValue(finderBottom.scoreStack, back(finder.scoreStack));
    back(finderBottom.patternStack).depth = dbFinder.queryIndex.seedLength;

    appendValue(dbFinder.findersApx, finderBottom);
}

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
inline void
onFind(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Parallel> & dbFinder,
       Finder_<TIndex, TIndex, Backtracking<HammingDistance, Top> > const & finder)
{
    typedef Backtracking<HammingDistance, Bottom>                       TBacktracking;
    typedef Finder_<TIndex, TIndex, TBacktracking>                      TFinder;

    TFinder finderBottom;
    _setScoreThreshold(finderBottom, finder.maxScore);
    appendValue(finderBottom.textStack, back(finder.textStack));
    appendValue(finderBottom.patternStack, back(finder.patternStack));
    appendValue(finderBottom.scoreStack, back(finder.scoreStack));
    back(finderBottom.patternStack).depth = dbFinder.queryIndex.seedLength;

    appendValue(dbFinder.findersExt, finderBottom);
}

// ----------------------------------------------------------------------------
// Function execute()                                                [DbFinder]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate, typename TSpec>
void execute(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, TSpec> & dbFinder)
{
    typedef Backtracking<EditDistance>                                          TBacktrackingApx;
    typedef Backtracking<HammingDistance>                                       TBacktrackingExt;
    typedef Finder_<TIndex, TIndex, TBacktrackingApx>                           TFinderApx;
    typedef Finder_<TIndex, TIndex, TBacktrackingExt>                           TFinderExt;
    typedef typename TextIterator_<TIndex, TIndex, TBacktrackingApx>::Type      TTextIterator;
    typedef typename PatternIterator_<TIndex, TIndex, TBacktrackingApx>::Type   TPatternIterator;

    // Instantiate a finder.
    TFinderApx finderApx;
    TFinderExt finderExt;

    unsigned seedSetsCount = length(dbFinder.queryIndex.errors);
    unsigned seedSet = 0;

    // Find exactly query index in database index.
    if (seedSetsCount > 0 && dbFinder.queryIndex.errors[seedSet] == 0)
    {
        TTextIterator textIt(dbFinder.dbIndex.index);
        TPatternIterator patternIt(dbFinder.queryIndex.index[seedSet]);
        patternIt.depth = dbFinder.queryIndex.seedLength;

        _setScoreThreshold(finderExt, 0);
        _initState(finderExt, textIt, patternIt);
        _find(finderExt, dbFinder, StageInitial_());
        clear(finderExt);

        seedSet++;
    }

    // Find approximately query index in database index.
    for (; seedSet < seedSetsCount; ++seedSet)
    {
        unsigned seedErrors = dbFinder.queryIndex.errors[seedSet];

        TTextIterator textIt(dbFinder.dbIndex.index);
        TPatternIterator patternIt(dbFinder.queryIndex.index[seedSet]);
        patternIt.depth = dbFinder.queryIndex.seedLength;

        _setScoreThreshold(finderApx, seedErrors);
        _initState(finderApx, textIt, patternIt);
        _find(finderApx, dbFinder, StageInitial_());
        clear(finderApx);
    }
}

// ----------------------------------------------------------------------------
// Function execute()                                      [DbFinder<Parallel>]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void execute(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Parallel> & dbFinder)
{
    typedef Backtracking<EditDistance, Top>                                     TBacktrackingApx;
    typedef Backtracking<HammingDistance, Top>                                  TBacktrackingExt;
    typedef Backtracking<EditDistance, Bottom>                                  TBacktrackingApxBottom;
    typedef Backtracking<HammingDistance, Bottom>                               TBacktrackingExtBottom;
    typedef Finder_<TIndex, TIndex, TBacktrackingApx>                           TFinderApx;
    typedef Finder_<TIndex, TIndex, TBacktrackingExt>                           TFinderExt;
    typedef Finder_<TIndex, TIndex, TBacktrackingApxBottom>                     TFinderApxBottom;
    typedef Finder_<TIndex, TIndex, TBacktrackingExtBottom>                     TFinderExtBottom;
    typedef typename TextIterator_<TIndex, TIndex, TBacktrackingApx>::Type      TTextIterator;
    typedef typename PatternIterator_<TIndex, TIndex, TBacktrackingApx>::Type   TPatternIterator;

    // Instantiate a finder.
    TFinderApx finderApx;
    TFinderExt finderExt;

    unsigned seedSetsCount = length(dbFinder.queryIndex.errors);
    unsigned seedSet = 0;

    // Find exactly query index in database index.
    if (seedSetsCount > 0 && dbFinder.queryIndex.errors[seedSet] == 0)
    {
        TTextIterator textIt(dbFinder.dbIndex.index);
        TPatternIterator patternIt(dbFinder.queryIndex.index[seedSet]);
        patternIt.depth = _min(dbFinder.queryIndex.seedLength, dbFinder.parallelDepth);
        
        _setScoreThreshold(finderExt, 0);
        _initState(finderExt, textIt, patternIt);
        _find(finderExt, dbFinder, StageInitial_());
        clear(finderExt);

        seedSet++;
    }

    // Find approximately query index in database index.
    for (; seedSet < seedSetsCount; ++seedSet)
    {
        unsigned seedErrors = dbFinder.queryIndex.errors[seedSet];

        TTextIterator textIt(dbFinder.dbIndex.index);
        TPatternIterator patternIt(dbFinder.queryIndex.index[seedSet]);
        patternIt.depth = _min(dbFinder.queryIndex.seedLength, dbFinder.parallelDepth);

        _setScoreThreshold(finderApx, seedErrors);
        _initState(finderApx, textIt, patternIt);
        _find(finderApx, dbFinder, StageInitial_());
        clear(finderApx);
    }

    unsigned findersExtCount = length(dbFinder.findersExt);
    unsigned findersApxCount = length(dbFinder.findersApx);

    std::cout << "Ext jobs count:\t\t\t\t" << findersExtCount << std::endl;
    std::cout << "Apx jobs count:\t\t\t\t" << findersApxCount << std::endl;

    SEQAN_OMP_PRAGMA(parallel for schedule(dynamic))
    for (int finderExt = 0; finderExt < (int)findersExtCount; ++finderExt)
    {
        TFinderExtBottom & finderBottom = dbFinder.findersExt[finderExt];
        _find(finderBottom, dbFinder, StageInitial_());
        clear(finderBottom);
    }

    SEQAN_OMP_PRAGMA(parallel for schedule(dynamic))
    for (int finderApx = 0; finderApx < (int)findersApxCount; ++finderApx)
    {
        TFinderApxBottom & finderBottom = dbFinder.findersApx[finderApx];
        _find(finderBottom, dbFinder, StageInitial_());
        clear(finderBottom);
    }
}

// ----------------------------------------------------------------------------
// Function execute()                                         [DbFinder<Exact>]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void execute(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact> & dbFinder)
{
    typedef typename Fibre<TIndex, FibreSA>::Type const      TSA;
    typedef typename Size<TIndex>::Type                      TSize;
    typedef typename Value<TText const>::Type                TString;
    typedef typename Iterator<TString const, Standard>::Type TStringIter;

    TText const &text = dbFinder.db.text;
    TSA const &sa = indexSA(dbFinder.dbIndex.index);
    String<TSize> &dir = dbFinder.dbIndex.dir;
    TSize sortedPrefix = dbFinder.dbIndex.sortedPrefix;

    SEQAN_OMP_PRAGMA(parallel for schedule(dynamic,1))
	for (int i = 1; i < (int)length(dir); ++i)
	{
        size_t bktBegin = dir[i - 1];
        size_t bktEnd = dir[i];

        // We need at least 2 suffixes.
		if (bktBegin + 2 > bktEnd)
            continue;

        TSize runBegin = bktBegin;
        TSize seqNo1 = getSeqNo(sa[runBegin]);
        for (size_t i = bktBegin + 1; i < bktEnd; ++i)
        {
            TSize seqNo2 = getSeqNo(sa[i]);
            SEQAN_ASSERT_EQ(getSeqOffset(sa[i]), 0u);
            if (length(text[seqNo1]) == length(text[seqNo2]))
            {
                TStringIter it1Beg = begin(text[seqNo1], Standard()) + sortedPrefix - 1;
                TStringIter it1End = end(text[seqNo1], Standard()) - 1;
                TStringIter it2End = end(text[seqNo2], Standard()) - 1;

                for (; it1End != it1Beg; --it1End, --it2End)
                {
                    if (*it1End != *it2End)
                        break;
                }

                if (it1End == it1Beg)
                    continue;
            }

            if (runBegin + 1 < i)
            {
                for (unsigned j = runBegin; j < i; ++j)
                    for (unsigned k = j + 1; k < i; ++k)
                        dbFinder.delegate(getSeqNo(sa[j]), getSeqNo(sa[k]));
            }
            runBegin = i;
            seqNo1 = getSeqNo(sa[runBegin]);
        }

        if (runBegin + 1 < bktEnd)
        {
            for (unsigned j = runBegin; j < bktEnd; ++j)
                for (unsigned k = j + 1; k < bktEnd; ++k)
                    dbFinder.delegate(getSeqNo(sa[j]), getSeqNo(sa[k]));
        }
    }
}

// NOTE(esiragusa): This is computing exact join using a dfs traversal.
//namespace seqan
//{
//    struct SAInfix;
//
//    template <typename TText>
//    struct Fibre<Index<TText, IndexSa<SAInfix> >, FibreSA>
//    {
//        typedef Segment<typename Fibre<Index<TText, IndexSa<> >, FibreSA>::Type const, InfixSegment> Type;
//    };
//
//}
//
//template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
//void execute(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Exact> & dbFinder)
//{
//    typedef Index<TText, IndexSa<SAInfix> >                                     TSAInfixIndex;
//    typedef typename Iterator<TSAInfixIndex, TopDown<ParentLinks<> > >::Type    TIter;
//
//    TText const &text = dbFinder.db.text;
//    TSA const &sa = indexSA(dbFinder.dbIndex.index);
//    String<TSize> &dir = dbFinder.dbIndex.dir;
//    TSize sortedPrefix = dbFinder.dbIndex.sortedPrefix;
//
//    TSAInfixIndex subIndex(text);
//    indexSA(subIndex) = infix(sa, bktBegin, bktEnd);
//
//    TIter iter(subIndex);
//    value(iter).range.i1 = 0;
//    _setSizeInval(value(iter).range.i2);
//    value(iter).parentRight = value(iter).range.i2;
//    value(iter).repLen = sortedPrefix;
//    value(iter).lastChar = suffix(text, sa[bktBegin])[sortedPrefix - 1];
//
//    while (!atEnd(iter))
//    {
//        if (isRightTerminal(iter))
//        {
//            typename Infix<TSA>::Type emptyEdges = getEmptyEdges(iter);
//            TSize len = length(emptyEdges);
//            if (len < 2)
//                continue;
//            std::cout << len << '\t' << representative(iter) << std::endl;
//            for (unsigned i = 0; i < len; ++i)
//                for (unsigned j = i + 1; j < len; ++j)
//                    dbFinder.delegate(getSeqNo(sa[j]), getSeqNo(sa[k]));
//        }
//        goNext(iter);
//    }
//}

// ----------------------------------------------------------------------------
// Function execute()                                        [DbFinder<Online>]
// ----------------------------------------------------------------------------

template <typename TText, typename TIndex, typename TDbQuerySpec, typename TDelegate>
void execute(DbFinder<TText, TIndex, TDbQuerySpec, TDelegate, Online> & dbFinder)
{
    typedef Db<TText>                           TDb;
    typedef typename Size<TDb>::Type            TDbSize;
    typedef typename MakeSigned<TDbSize>::Type  TDbSSize;

    TDbSSize dbSize = (TDbSSize)length(dbFinder.db.text) - 1;
    TDbSSize dbQuerySize = length(value(dbFinder.query).text);

    SEQAN_OMP_PRAGMA(parallel for schedule(dynamic))
    for (TDbSSize dbId1 = 0; dbId1 < dbSize; ++dbId1)
        for (TDbSSize dbId2 = dbId1 + 1; dbId2 < dbQuerySize; ++dbId2)
            dbFinder.verifier(dbId1, dbId2, dbFinder.delegate);
}

template <typename TText, typename TIndex, typename TDelegate>
void execute(DbFinder<TText, TIndex, Query, TDelegate, Online> & dbFinder)
{
    typedef Db<TText>                               TDb;
    typedef Db<TText, Query>                        TDbQuery;
    typedef typename Size<TDb>::Type                TDbSize;
    typedef typename MakeSigned<TDbSize>::Type      TDbSSize;
    typedef typename Size<TDbQuery>::Type           TDbQuerySize;
    typedef typename MakeSigned<TDbQuerySize>::Type TDbQuerySSize;

    TDbSSize dbSize = length(dbFinder.db.text);
    TDbQuerySSize dbQuerySize = length(value(dbFinder.query).text);

    SEQAN_OMP_PRAGMA(parallel for schedule(dynamic))
    for (TDbSSize dbId = 0; dbId < dbSize; ++dbId)
        for (TDbQuerySSize queryId = 0; queryId < dbQuerySize; ++queryId)
            dbFinder.verifier(dbId, queryId, dbFinder.delegate);
}

#endif  // #ifndef SANDBOX_ESIRAGUSA_APPS_SEARCHJOIN_DBFINDER_H_