/usr/include/seqan/find/find_base.h is in seqan-dev 1.3.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 | // ==========================================================================
// SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2010, 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: Andreas Gogol-Doering <andreas.doering@mdc-berlin.de>
// ==========================================================================
// Definition of the class Finder and supporting tags and metafunctions.
// ==========================================================================
#ifndef SEQAN_HEADER_FIND_BASE_H
#define SEQAN_HEADER_FIND_BASE_H
//////////////////////////////////////////////////////////////////////////////
namespace SEQAN_NAMESPACE_MAIN
{
//////////////////////////////////////////////////////////////////////////////
// Tags
/**
.Tag.FindInfix:
..summary:Find needle as a substring of haystack (infix search).
..see:Tag.FindPrefix
..see:Spec.Myers
..see:Spec.DPSearch
..include:seqan/find.h
*/
struct FindInfix;
/**
.Tag.FindPrefix:
..summary:Find needle as a prefix of the haystack (prefix serach)
..see:Tag.FindInfix
..see:Spec.Myers
..see:Spec.DPSearch
..include:seqan/find.h
*/
struct FindPrefix;
//////////////////////////////////////////////////////////////////////////////
/**
.Metafunction.DefaultFinder:
..cat:Searching
..summary:Default @Class.Finder@ specialization type.
..signature:DefaultFinder<THaystack>::Type
..param.THaystack:The given haystack type.
..returns:Is $void$ by default and @Tag.Index Find Algorithm.EsaFindMlr@ if $THaystack$ is an @Class.Index@.
..include:seqan/find.h
*/
template < typename TObject >
struct DefaultFinder
{
typedef void Type;
};
/**
.Metafunction.DefaultPattern:
..cat:Searching
..summary:Default @Class.Pattern@ specialization type.
..signature:DefaultPattern<TNeedle>::Type
..param.TNeedle:The given needle type.
..returns:Is $void$ by default.
..include:seqan/find.h
*/
template < typename TObject >
struct DefaultPattern
{
typedef void Type;
};
/**
.Metafunction.Haystack:
..summary:Returns the haystack type of a @Class.Finder@ type.
..cat:Searching
..signature:Haystack<TFinder>::Type
..param.TFinder:A @Class.Finder@ type.
...type:Class.Finder
..returns:The haystack type of $TFinder$, i.e. $THaystack$ for $Finder<THaystack, TSpec>$.
This is an alias to function @Function.host@ of the pattern function.
..see:Function.host
..include:seqan/find.h
*/
template <typename TFinder>
struct Haystack
{
typedef typename Container<TFinder>::Type Type;
};
/**
.Metafunction.Needle:
..summary:Returns the needle type of a @Class.Pattern@ type.
..cat:Searching
..signature:Needle<TPattern>::Type
..param.TPattern:A @Class.Pattern@ type.
...type:Class.Pattern
..returns:The needle type of $TPattern$, i.e. $TNeedle$ for $Pattern<TNeedle, TSpec>$.
..include:seqan/find.h
*/
template <typename TPattern>
struct Needle
{
typedef typename Host<TPattern>::Type Type;
};
template <typename THost, typename TSpec>
struct Needle<Segment<THost, TSpec> >
{
typedef Segment<THost, TSpec> Type;
};
template <typename THost, typename TSpec>
struct Needle<Segment<THost, TSpec> const>
{
typedef Segment<THost, TSpec> const Type;
};
//////////////////////////////////////////////////////////////////////////////
/**
.Function.find:
..summary:Search for a @Class.Pattern@ in a @Class.Finder@ object.
..cat:Searching
..signature:find(finder, pattern)
..signature:find(finder, pattern, k)
..param.finder:The @Class.Finder@ object to search through.
...remarks:For online-algorithm $patterns$, finder can also be an arbitrary @Concept.Rooted Iterator@.
...type:Class.Finder
...type:Concept.Rooted Iterator
..param.pattern:The @Class.Pattern@ object to search for.
...remarks:For index $finders$, pattern can also be a Sequence.
...type:Class.Pattern
..param.k:Desired minimal score (for approximate matching).
...remarks:$k$ has to be a number <= 0.
...remarks:Differences are deletions, insertions and substitutions.
..returns:$boolean$ that indicates whether an occurence of $pattern$ was found or not.
..remarks:Repeated calls of this function iterate through all occurences of $pattern$.
..include:seqan/find.h
*/
/**
.Class.Finder:
..summary:Holds the haystack and a current search context.
..cat:Searching
..signature:Finder<THaystack[, TSpec]>
..param.THaystack:The haystack type.
...type:Class.String
...type:Class.Index
..param.TSpec:The index-algorithm to search with (Optional).
...default:The result of @Metafunction.DefaultFinder@
...remarks:Leave empty for online pattern matching (see @Class.Pattern@).
...remarks:If $THaystack$ is an @Class.Index@, then $TSpec$ specifies the index search algorithm.
..remarks:$position(finder)$ returns the position of the current hit in the haystack.
If $THaystack$ is a set of strings or an index of a set of strings, then $position(finder)$ returns a @Class.Pair@ $(hayNo, pos)$,
in which $hayNo$ is the haystack index and $pos$ the local position of the hit.
..remarks:Use $clear(finder)$ to reset a finder object and search from the beginning.
..include:seqan/find.h
*/
///.Function.clear.param.object.type:Class.Finder
///.Function.position.param.iterator.type:Class.Finder
template < typename THaystack, typename TSpec = typename DefaultFinder<THaystack>::Type >
class Finder
{
typedef typename Iterator<THaystack, Rooted>::Type TIterator;
typedef typename Position<THaystack>::Type TPosition;
typedef typename Size<THaystack>::Type TSize;
public:
TIterator data_iterator;
TPosition data_endPos; //note: we need this since iterator could point to begin or end (depending on pattern type)
TSize data_length;
bool _needReinit; // if true, the Pattern needs to be reinitialized
bool _beginFind_called; // if false, then findBegin was not yet called for this match position (see findBegin default implementation)
/**
.Memfunc.Finder#Finder:
..class:Class.Finder
..summary:Constructor
..signature:Finder()
*/
Finder()
: data_endPos(0)
, data_length(0)
, _needReinit(true)
, _beginFind_called(false)
{}
/**
.Memfunc.Finder#Finder:
..signature:Finder(haystack)
..param.haystack:The haystack to work on, $THaystack$.
*/
Finder(THaystack & haystack)
: data_iterator(begin(haystack, Rooted()))
, data_endPos(0)
, data_length(0)
, _needReinit(true)
, _beginFind_called(false)
{}
/**
.Memfunc.Finder#Finder:
..signature:Finder(iter)
..param.iter:The iterator to work on, either const or non-const.
*/
Finder(TIterator &iter)
: data_iterator(iter)
, data_endPos(0)
, data_length(0)
, _needReinit(true)
, _beginFind_called(false)
{}
Finder(TIterator const &iter)
: data_iterator(iter)
, data_endPos(0)
, data_length(0)
, _needReinit(true)
, _beginFind_called(false)
{}
/**
.Memfunc.Finder#Finder:
..signature:Finder(orig)
..param.orig:Finder object to copy from (copy constructor).
...type:Class.Finder
*/
Finder(Finder const &orig)
: data_iterator(orig.data_iterator)
, data_endPos(orig.data_endPos)
, data_length(orig.data_length)
, _needReinit(orig._needReinit)
, _beginFind_called(orig._beginFind_called)
{}
~Finder() {}
//____________________________________________________________________________
Finder const &
operator = (Finder const & other)
{
data_iterator = other.data_iterator;
data_endPos = other.data_endPos;
data_length = other.data_length;
_needReinit = other._needReinit;
_beginFind_called = other._beginFind_called;
return *this;
}
//____________________________________________________________________________
inline typename Reference<TIterator>::Type
operator* ()
{
SEQAN_CHECKPOINT
return value(hostIterator(*this));
}
inline typename Reference<TIterator const>::Type
operator* () const
{
SEQAN_CHECKPOINT
return value(hostIterator(*this));
}
//____________________________________________________________________________
operator TIterator () const
{
SEQAN_CHECKPOINT
return data_iterator;
}
//____________________________________________________________________________
};
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec>
inline void
_setFinderEnd(Finder<THaystack, TSpec> & me)
{//shortcut: move end position to iterator position +1
me._beginFind_called = false;
me.data_endPos = position(me)+1;
}
template <typename THaystack, typename TSpec, typename TPosition>
inline void
_setFinderEnd(Finder<THaystack, TSpec> & me,
TPosition end_pos)
{
me._beginFind_called = false;
me.data_endPos = end_pos;
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec, typename TSize>
inline void
_setFinderLength(Finder<THaystack, TSpec> & me,
TSize _length)
{
me.data_length = _length;
}
//////////////////////////////////////////////////////////////////////////////
///.Function.beginPosition.param.object.type:Class.Finder
template <typename THaystack, typename TSpec>
inline typename Position<THaystack>::Type
beginPosition(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return me.data_endPos - me.data_length;
}
template <typename THaystack, typename TSpec>
inline typename Position<THaystack const>::Type
beginPosition(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return me.data_endPos - me.data_length;
}
//////////////////////////////////////////////////////////////////////////////
///.Function.begin.param.object.type:Class.Finder
template <typename THaystack, typename TSpec, typename TTag>
inline typename Iterator<THaystack, Tag<TTag> const>::Type
begin(Finder<THaystack, TSpec> & me,
Tag<TTag> const tag)
{
SEQAN_CHECKPOINT
return iter(haystack(me), beginPosition(me), tag);
}
template <typename THaystack, typename TSpec, typename TTag>
inline typename Iterator<THaystack const, Tag<TTag> const>::Type
begin(Finder<THaystack, TSpec> const & me,
Tag<TTag> const tag)
{
SEQAN_CHECKPOINT
return iter(haystack(me), beginPosition(me), tag);
}
//////////////////////////////////////////////////////////////////////////////
///.Function.endPosition.param.object.type:Class.Finder
template <typename THaystack, typename TSpec>
inline typename Position<THaystack>::Type
endPosition(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return me.data_endPos;
}
template <typename THaystack, typename TSpec>
inline typename Position<THaystack const>::Type
endPosition(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return me.data_endPos;
}
//////////////////////////////////////////////////////////////////////////////
///.Function.end.param.object.type:Class.Finder
template <typename THaystack, typename TSpec, typename TTag>
inline typename Iterator<THaystack, Tag<TTag> const>::Type
end(Finder<THaystack, TSpec> & me,
Tag<TTag> const tag)
{
SEQAN_CHECKPOINT
return iter(haystack(me), endPosition(me), tag);
}
template <typename THaystack, typename TSpec, typename TTag>
inline typename Iterator<THaystack const, Tag<TTag> const>::Type
end(Finder<THaystack, TSpec> const & me,
Tag<TTag> const tag)
{
SEQAN_CHECKPOINT
return iter(haystack(me), endPosition(me), tag);
}
//////////////////////////////////////////////////////////////////////////////
///.Function.length.param.object.type:Class.Finder
template <typename THaystack, typename TSpec>
inline typename Size<THaystack>::Type
length(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return me.data_length;
}
template <typename THaystack, typename TSpec>
inline typename Size<THaystack const>::Type
length(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return me.data_length;
}
//////////////////////////////////////////////////////////////////////////////
/**
.Function.infix:
..description:Segment of the last found match in haystack.
..signature:Infix infix(finder)
..param.finder:An online finder.
...type:Class.Finder
..returns:An @Metafunction.Infix.infix@ of the @Metafunction.Haystack.haystack@.
...metafunction:Metafunction.Infix
..remarks:This function works only correct if the begin position of the match was already found,
see @Function.findBegin@.
..include:seqan/find.h
*/
template <typename THaystack, typename TSpec>
inline typename Infix<THaystack>::Type
infix(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
typedef typename Infix<THaystack>::Type TInfix;
return infix(haystack(me), beginPosition(me), endPosition(me));
}
template <typename THaystack, typename TSpec>
inline typename Infix<THaystack const>::Type
infix(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
typedef typename Infix<THaystack const>::Type TInfix;
return infix(haystack(me), beginPosition(me), endPosition(me));
}
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec>
inline typename Parameter_<THaystack>::Type
host(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return container(hostIterator(me));
}
template <typename THaystack, typename TSpec>
inline typename Parameter_<THaystack>::Type
host(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return container(hostIterator(me));
}
template <typename THaystack, typename TSpec>
inline typename Parameter_<THaystack>::Type
container(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return container(hostIterator(me));
}
template <typename THaystack, typename TSpec>
inline typename Parameter_<THaystack>::Type
container(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return container(hostIterator(me));
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline void
setHost(Finder<THaystack, TSpec> & me,
typename Parameter_<THaystack>::Type container_)
{
SEQAN_CHECKPOINT
setContainer(hostIterator(me), container_);
goBegin(me);
}
template <typename THaystack, typename TSpec>
inline void
setContainer(Finder<THaystack, TSpec> & me,
typename Parameter_<THaystack>::Type container_)
{
SEQAN_CHECKPOINT
setContainer(hostIterator(me), container_);
goBegin(me);
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline typename Iterator<THaystack, Rooted>::Type &
hostIterator(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return me.data_iterator;
}
template <typename THaystack, typename TSpec>
inline typename Iterator<THaystack, Rooted>::Type const &
hostIterator(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return me.data_iterator;
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline bool
empty(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
return me._needReinit;
}
template <typename THaystack, typename TSpec>
inline void
clear(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
me._needReinit = true;
}
//____________________________________________________________________________
template <typename T>
inline void
_finderSetNonEmpty(T & me)
{
SEQAN_CHECKPOINT
goBegin(me);
}
template <typename THaystack, typename TSpec>
inline void
_finderSetNonEmpty(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
me._needReinit = false;
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline bool
atBegin(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return (!empty(me) && atBegin(hostIterator(me)));
}
template <typename THaystack, typename TSpec>
inline bool
atEnd(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
return (!empty(me) && atEnd(hostIterator(me)));
}
//____________________________________________________________________________
/**
.Function.goBegin
..signature:goBegin(finder)
...param.finder:Finder object to go to beginning in.
..include:seqan/find.h
*/
template <typename THaystack, typename TSpec>
inline void
goBegin(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
//_finderSetNonEmpty(me);
goBegin(hostIterator(me));
}
/**
.Function.goEnd
..signature:goEnd(finder)
...param.finder:Finder object to go to end in.
..include:seqan/find.h
*/
template <typename THaystack, typename TSpec>
inline void
goEnd(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
//_finderSetNonEmpty(me);
goEnd(hostIterator(me));
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline typename Position<Finder<THaystack, TSpec> >::Type
position(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
if (empty(me)) return 0;
return position(hostIterator(me));
}
template <typename THaystack, typename TSpec>
inline typename Position<Finder<THaystack, TSpec> >::Type
position(Finder<THaystack, TSpec> const & me)
{
SEQAN_CHECKPOINT
if (empty(me)) return 0;
return position(hostIterator(me));
}
//____________________________________________________________________________
/**
.Function.setPosition:
..cat:Searching
..summary:Sets the position of a finder.
..signature:setPosition(finder, pos)
..param.finder:A finder.
...class:Class.Finder
..param.pos:A position.
...metafunction:Metafunction.Position
..see:Function.position
..include:seqan/find.h
*/
template <typename THaystack, typename TSpec, typename TPosition>
inline void
setPosition(Finder<THaystack, TSpec> & me, TPosition pos_)
{
SEQAN_CHECKPOINT
setPosition(hostIterator(me), pos_);
}
//____________________________________________________________________________
template <typename THaystack, typename TSpec>
inline Finder<THaystack, TSpec> &
operator--(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
--hostIterator(me);
return me;
}
template <typename THaystack, typename TSpec>
inline Finder<THaystack, TSpec> &
operator++(Finder<THaystack, TSpec> & me)
{
SEQAN_CHECKPOINT
/* if (beforeBegin()) {
goBegin(hostIterator(me));
} else*/
++hostIterator(me);
return me;
}
//////////////////////////////////////////////////////////////////////////////
// operator +
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec, typename TIntegral>
inline Finder<THaystack, TSpec> const
operator + (Finder<THaystack, TSpec> const & left, TIntegral right)
{
SEQAN_CHECKPOINT
return Finder<THaystack, TSpec>(hostIterator(left) + right);
}
//////////////////////////////////////////////////////////////////////////////
// operator +=
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec, typename TIntegral>
inline Finder<THaystack, TSpec> &
operator += (Finder<THaystack, TSpec> & left,
TIntegral right)
{
SEQAN_CHECKPOINT
hostIterator(left) += right;
return left;
}
//////////////////////////////////////////////////////////////////////////////
// operator -
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec, typename TIntegral>
inline Finder<THaystack, TSpec> const
operator - (Finder<THaystack, TSpec> const & left, TIntegral right)
{
SEQAN_CHECKPOINT
return Finder<THaystack, TSpec>(hostIterator(left) - right);
}
template <typename THaystack, typename TSpec, typename TIntegral>
inline typename Difference<Finder<THaystack, TSpec> const>::Type
operator - (Finder<THaystack, TSpec> const & left, Finder<THaystack, TSpec> const & right)
{
SEQAN_CHECKPOINT
return hostIterator(left) - hostIterator(right);
}
//////////////////////////////////////////////////////////////////////////////
// operator -=
//////////////////////////////////////////////////////////////////////////////
template <typename THaystack, typename TSpec, typename TIntegral>
inline Finder<THaystack, TSpec> &
operator -= (Finder<THaystack, TSpec> & left,
TIntegral right)
{
SEQAN_CHECKPOINT
hostIterator(left) -= right;
return left;
}
//____________________________________________________________________________
/**
.Function.setHaystack:
..summary:Sets the haystack of a @Class.Finder@ object.
..cat:Searching
..signature:setHaystack(finder, haystack)
..param.finder:The @Class.Finder@ object to search with.
...type:Class.Finder
..param.haystack:The haystack object the finder searches through.
...type:Class.String
..include:seqan/find.h
*/
template < typename THaystack, typename TSpec >
inline void
setHaystack(Finder<THaystack, TSpec> &obj, THaystack const &hstk) {
setHost(obj, hstk);
}
/**
.Function.haystack:
..summary:Returns the haystack of a @Class.Finder@ object.
..cat:Searching
..signature:haystack(finder)
..param.finder:The @Class.Finder@ object to search through.
...type:Class.Finder
..returns:The haystack object.
..remarks:The result type is @Metafunction.Haystack@$<TFinder>::Type$ for finder of type $TFinder$.
..include:seqan/find.h
*/
template < typename TObject >
inline typename Haystack<TObject>::Type &
haystack(TObject &obj) {
return container(obj);
}
template < typename TObject >
inline typename Haystack<TObject const>::Type &
haystack(TObject const &obj) {
return container(obj);
}
//////////////////////////////////////////////////////////////////////////////
///.Metafunction.Container.param.T.type:Class.Finder
template <typename THaystack, typename TSpec>
struct Container< Finder<THaystack, TSpec> > {
typedef THaystack Type;
};
template <typename THaystack, typename TSpec>
struct Container< Finder<THaystack, TSpec> const> {
typedef THaystack const Type;
};
///.Metafunction.Host.param.T.type:Class.Finder
template <typename THaystack, typename TSpec>
struct Host< Finder<THaystack, TSpec> > {
typedef THaystack Type;
};
template <typename THaystack, typename TSpec>
struct Host< Finder<THaystack, TSpec> const> {
typedef THaystack const Type;
};
///.Metafunction.Value.param.T.type:Class.Finder
template <typename THaystack, typename TSpec>
struct Value< Finder<THaystack, TSpec> > {
typedef typename Value<THaystack>::Type Type;
};
template <typename THaystack, typename TSpec>
struct Position< Finder<THaystack, TSpec> >:
Position<THaystack> {};
///.Metafunction.Difference.param.T.type:Class.Finder
template <typename THaystack, typename TSpec>
struct Difference< Finder<THaystack, TSpec> > {
typedef typename Difference<THaystack>::Type Type;
};
template <typename THaystack, typename TSpec>
struct Size< Finder<THaystack, TSpec> > {
typedef typename Size<THaystack>::Type Type;
};
///.Metafunction.Iterator.param.T.type:Class.Finder
template <typename THaystack, typename TSpec, typename TIteratorSpec>
struct Iterator< Finder<THaystack, TSpec>, TIteratorSpec >
{
typedef typename Iterator<THaystack>::Type Type;
};
template <typename THaystack, typename TSpec, typename TIteratorSpec>
struct Iterator< Finder<THaystack, TSpec> const, TIteratorSpec >
{
typedef typename Iterator<THaystack>::Type Type;
};
// TODO(holtgrew): Document DefaultGetIterator at main location, first.
// .Metafunction.DefaultGetIterator.param.T.type:Class.Finder
template <typename THaystack, typename TSpec>
struct DefaultGetIteratorSpec< Finder<THaystack, TSpec> >:
DefaultGetIteratorSpec< THaystack >
{
};
template <typename THaystack, typename TSpec>
struct DefaultGetIteratorSpec< Finder<THaystack, TSpec> const>:
DefaultGetIteratorSpec< THaystack const>
{
};
//////////////////////////////////////////////////////////////////////////////
}// namespace SEQAN_NAMESPACE_MAIN
#endif //#ifndef SEQAN_HEADER_...
|