Spec
Max Repeats IteratorIterator to search for all maximal repeats.
Iterator to search for all maximal repeats.
| Extends | BottomUpIterator |
|---|---|
| All Extended | BottomUpIterator, Iter, VSTreeIterator |
| All Impl'd | CopyConstructibleConcept, DefaultConstructibleConcept, EqualityComparableConcept, ForwardIteratorConcept, InputIteratorConcept, IteratorAssociatedTypesConcept |
| Defined in | <seqan/index.h> |
| Signature |
Iterator<TContainer, MaxRepeats>::Type;
template <typename TContainer>
class Iter<TContainer, VSTree< BottomUp<MaxRepeats> > >;
|
Template Parameters
TContainer |
Type of an index that can be iterated with a bottom-up iterator. Types: IndexEsa |
|---|
Member Function Overview
-
Iter::Iter(index[, minLength]);, Iter::Iter(iterator);The constructor
Member Functions Inherited From BottomUpIterator
Member Functions Inherited From Iter
Member Functions Inherited From EqualityComparableConcept
Interface Function Overview
-
TSize length(it);Return the number of repeats.
Interface Functions Inherited From BottomUpIterator
Interface Functions Inherited From VSTreeIterator
alignmentassignPropertyatEndchildrenAreLeavescountChildrencountOccurrencesgetFrequencygetOccurrencegetOccurrencesgetOccurrencesBwtgetPropertygoBegingoNextgoRootisLeafisLeftMaximalisPartiallyLeftExtensibleisRightTerminalisRootisUniquenodeHullPredicatenodePredicatepropertyrangerepLengthrepresentativevalue
Interface Functions Inherited From InputIteratorConcept
Interface Functions Inherited From IteratorAssociatedTypesConcept
Interface Metafunction Overview
Interface Metafunctions Inherited From Iter
Interface Metafunctions Inherited From VSTreeIterator
Interface Metafunctions Inherited From IteratorAssociatedTypesConcept
Detailed Description
Note:
Instead of using the class Iter directly we recommend to use the result of the metafunction Iterator<TContainer, MaxRepeats>::Type (which is Iter<TContainer, VSTree< BottomUp<MaxRepeats> > >).
See Also
Member Functions Detail
Iter::Iter(index[, minLength]);
Iter::Iter(iterator);
The constructor
Parameters
index
|
The index to be used for the iteration. Types: IndexEsa |
|---|---|
minLength
|
Minimum length of the supermaximal repeats, default value is 1. |
iterator
|
Another MaxRepeats iterator. Types: MaxRepeatsIterator |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
Interface Functions Detail
TSize length(it);
Return the number of repeats.
Parameters
it
|
The MaxRepeatsIterator to query. |
|---|
Returns
TSize |
The number of found repeats. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.