Spec IndexWotd
An index based on a lazy suffix tree (see Giegerich et al., "Efficient implementation of lazy suffix trees").

Extends Index
Implements StringTreeConcept
All Extended Index
All Subcl's IndexDfi
All Impl'd StringTreeConcept
Defined in <seqan/index.h>
Signature template <typename TText, typename TSpec> class Index<TText, IndexWotd<TSpec> >;

Template Parameters

TText The TextConcept text type.
TSpec The type for further specialization of the Index type.

Member Function Overview

Interface Function Overview

Interface Functions Inherited From Index

Interface Functions Inherited From StringTreeConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From Index

Interface Metafunctions Inherited From StringTreeConcept

Detailed Description

The fibres (see Index and Fibre) of this index are a partially sorted suffix array (see WotdSA) and the wotd tree (see WotdDir).

Demo: Demo.Constraint Iterator

See Also

Member Functions Detail

Index::Index(); Index::Index(index); Index::Index(text);

Constructor

Parameters

index Other Index object to copy from.
text The text to be indexed.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

Interface Functions Detail

void createWotdIndex(sa, dir, text);

Builds a the WOTD index.

Parameters

sa The resulting list in which all q-grams are sorted alphabetically.
dir The resulting array that indicates at which position in index the corresponding q-grams can be found.
text The sequence. Types: ContainerConcept

The resulting index contains the sorted list of qgrams. For each possible q-gram pos contains the first position in index that corresponds to this q-gram.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TFibre dirAt(position, index);

Shortcut for value(indexDir(index), position).

Parameters

index The IndexWotd object holding the fibre.
position A position in the array on which the value should be accessed.

Returns

TFibre A reference to the WotdDir fibre.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TFibre indexDir(index);

Shortcut for getFibre(.., WotdDir()).

Parameters

index The IndexWotd object holding the fibre.

Returns

TFibre A reference to the WotdDir fibre (tree structure).

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TSa indexSA(index);

Shortcut for getFibre(.., WotdSA).

Parameters

index The IndexWotd object holding the fibre.

Returns

TSa A reference to the WotdSA fibre (partially sorted suffix array).

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TValue saAt(position, index);

Note.

Advanced functionality, not commonly used.

Shortcut for value(indexSA(..), ..).

Parameters

index The IndexWotd object holding the fibre.
position A position in the array on which the value should be accessed.

Returns

TValue A reference or proxy to the value in the WotdSA fibre. To be more precise, a reference to a position containing a value of type SAValue is returned (or a proxy).

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.