Spec IndexDfi
The Deferred Frequency Index (see Weese and Schulz, "Efficient string mining under constraints via the deferred frequency index").

Extends IndexWotd
All Extended Index, IndexWotd
All Impl'd StringTreeConcept
Defined in <seqan/index.h>
Signature template <typename TText, typename TPredHull, typename TPred> class Index<TText, IndexWotd< Dfi<TPredHull, TPred> > >;

Template Parameters

TText The text.
TPred An arbitrary frequency predicate.
TPredHull A monotonic hull of TPred

Member Function Overview

Member Functions Inherited From IndexWotd

Interface Function Overview

Interface Functions Inherited From Index

Interface Functions Inherited From IndexWotd

Interface Functions Inherited From StringTreeConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From Index

Interface Metafunctions Inherited From StringTreeConcept

Detailed Description

This index is based on a lazy suffix tree (see IndexWotd). All TPredHull sufficing nodes can be iterated using a TopDownIterator. To iterate the exact solution set of TPred, use a TopDownHistoryIterator of this index.

Member Functions Detail

Index::Index(); Index::Index(index); Index::Index(text[, predHull][, pred]);

Constructor

Parameters

index Other Index object to copy from.
text The text to be indexed.
predHull (TPredHull) A monotonic hull of TPred. (optional)
pred (TPred) An arbitrary frequeny predicate. (optional)

Data Races

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

Interface Functions Detail

TFibre dirAt(position, index);

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

Parameters

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

Returns

TFibre A reference to the DfiDir fibre.

Data Races

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

TFibre indexDir(index);

Shortcut for getFibre(.., DfiDir()).

Parameters

index The IndexDfi object holding the fibre.

Returns

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

Data Races

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

TSa indexSA(index);

Shortcut for getFibre(.., DfiSA).

Parameters

index The IndexDfi object holding the fibre.

Returns

TSa A reference to the DfiSA 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 IndexDfi 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 DfiSA 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.