es.uam.eps.ir.ranksys.fast.index

Interface FastFeatureIndex<F>

Type Parameters:

F - type of the features

All Superinterfaces:

FeatureIndex<F>

All Known Subinterfaces:

FastFeatureData<I,F,V>

All Known Implementing Classes:

AbstractFastFeatureData, SimpleFastFeatureData, SimpleFastFeatureIndex

public interface FastFeatureIndex<F>
extends FeatureIndex<F>

Fast version of FeatureIndex, where features are internally represented with numerical indices from 0 (inclusive) to the number of indexed features (exclusive).

Author:

Saúl Vargas (saul.vargas@uam.es)

Method Summary

Modifier and Type	Method and Description
default boolean	containsFeature(F f) Checks whether the index contains a feature.
int	feature2fidx(F f) Returns the index assigned to the feature.
default <V> Tuple2io<V>	feature2fidx(org.jooq.lambda.tuple.Tuple2<F,V> tuple) Applies FastFeatureIndex::feature2fidx to the first element of the tuple.
default Tuple2id	feature2fidx(Tuple2od<F> tuple) Applies FastFeatureIndex::feature2fidx to the first element of the tuple.
F	fidx2feature(int fidx) Returns the feature represented with the index.
default Tuple2od<F>	fidx2feature(Tuple2id tuple) Applies FastFeatureIndex::fidx2feature to the first element of the tuple.
default <V> org.jooq.lambda.tuple.Tuple2<F,V>	fidx2feature(Tuple2io<V> tuple) Applies FastFeatureIndex::fidx2feature to the first element of the tuple.
default Stream<F>	getAllFeatures() Retrieves a stream of the indexed features.
default IntStream	getAllFidx() Gets all the indices of the features.

Methods inherited from interface es.uam.eps.ir.ranksys.core.index.FeatureIndex

numFeatures

Method Detail

containsFeature

default boolean containsFeature(F f)

Description copied from interface: FeatureIndex

Checks whether the index contains a feature.

Specified by:

containsFeature in interface FeatureIndex<F>

Parameters:

f - feature

Returns:

true if the index contains the feature, false otherwise

getAllFeatures

default Stream<F> getAllFeatures()

Description copied from interface: FeatureIndex

Retrieves a stream of the indexed features.

Specified by:

getAllFeatures in interface FeatureIndex<F>

Returns:

a stream of all the features

getAllFidx

default IntStream getAllFidx()

Gets all the indices of the features.

Returns:

a stream of indexes of features

feature2fidx

int feature2fidx(F f)

Returns the index assigned to the feature.

Parameters:

f - feature

Returns:

the index of the feature, or -1 if the feature does not exist

fidx2feature

F fidx2feature(int fidx)

Returns the feature represented with the index.

Parameters:

fidx - feature index

Returns:

the feature whose index is fidx

feature2fidx

default <V> Tuple2io<V> feature2fidx(org.jooq.lambda.tuple.Tuple2<F,V> tuple)

Applies FastFeatureIndex::feature2fidx to the first element of the tuple.

Type Parameters:

V - type of value

Parameters:

tuple - feature-value tuple

Returns:

fidx-value tuple

fidx2feature

default <V> org.jooq.lambda.tuple.Tuple2<F,V> fidx2feature(Tuple2io<V> tuple)

Applies FastFeatureIndex::fidx2feature to the first element of the tuple.

Type Parameters:

V - type of value

Parameters:

tuple - fidx-value tuple

Returns:

feature-value tuple

feature2fidx

default Tuple2id feature2fidx(Tuple2od<F> tuple)

Applies FastFeatureIndex::feature2fidx to the first element of the tuple.

Parameters:

tuple - feature-double tuple

Returns:

fidx-double tuple

fidx2feature

default Tuple2od<F> fidx2feature(Tuple2id tuple)

Applies FastFeatureIndex::fidx2feature to the first element of the tuple.

Parameters:

tuple - fidx-double tuple

Returns:

feature-double tuple