org.terrier.learning

Interface FeaturedResultSet

All Superinterfaces:

ResultSet, Serializable

All Known Implementing Classes:

FeaturedQueryResultSet

public interface FeaturedResultSet
extends ResultSet

A result set to accommodate multiple feature scores. Features scores are managed as "dense" arrays, ordered by the current ordering of docids in the ResultSet (i.e. as returned by getDocids()).

Since:

4.0

Author:

Rodrygo Santos

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultLabel()
String[]	getFeatureNames() Gets the names of the features that have been added to this ResultSet
double[]	getFeatureScores(int feature_id) Get the feature scores for a given feature id
double[]	getFeatureScores(String name) Get all scores for the enabled docids given a feature name
String[]	getLabels()
int	getNumberOfFeatures() Number of features decorated for this resultset
void	putFeatureScores(String name, double[] scores) Add a feature to this result set
void	setDefaultLabel(String label)
void	setLabels(String[] labels)

Methods inherited from interface org.terrier.matching.ResultSet

addMetaItem, addMetaItems, getDocids, getExactResultSize, getLock, getMetaItem, getMetaItems, getMetaKeys, getOccurrences, getResultSet, getResultSet, getResultSize, getScores, getStatusCode, hasMetaItems, initialise, initialise, setExactResultSize, setResultSize, setStatusCode, sort, sort

Method Detail

getNumberOfFeatures

int getNumberOfFeatures()

Number of features decorated for this resultset

getFeatureNames

String[] getFeatureNames()

Gets the names of the features that have been added to this ResultSet

putFeatureScores

void putFeatureScores(String name,
                    double[] scores)

Add a feature to this result set

getFeatureScores

double[] getFeatureScores(String name)

Get all scores for the enabled docids given a feature name

getFeatureScores

double[] getFeatureScores(int feature_id)

Get the feature scores for a given feature id

setLabels

void setLabels(String[] labels)

getLabels

String[] getLabels()

setDefaultLabel

void setDefaultLabel(String label)

getDefaultLabel

String getDefaultLabel()