Package org.terrier.matching

Class LearnedModelMatching

java.lang.Object

org.terrier.matching.LearnedModelMatching

All Implemented Interfaces:

Matching

Direct Known Subclasses:

JforestsModelMatching, LinearModelMatching

public abstract class LearnedModelMatching
extends java.lang.Object
implements Matching

An abstract class for applying a learned model onto a FeaturedResultSet.

Since:

4.0

Author:

Craig Macdonald

Field Summary

Fields

Modifier and Type	Field	Description
protected int	increment
protected org.slf4j.Logger	logger
protected Matching	parent
protected boolean	score_is_feature

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LearnedModelMatching(Matching _parent)
protected	LearnedModelMatching(Index _index, Matching _parent)

Method Summary

Modifier and Type	Method	Description
protected abstract void	applyModel(int N, double[] in_scores, int F, double[][] features, double[] out_scores)	Apply the loaded learned model for identifying the top N documents.
java.lang.String	getInfo()	Return a human readable description of this Matching class
ResultSet	match(java.lang.String queryNumber, MatchingQueryTerms queryTerms)	Get a ResultSet for the given query terms.
void	setCollectionStatistics(CollectionStatistics cs)	Update the collection statistics being used by this matching instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected final Matching parent

logger

protected org.slf4j.Logger logger

score_is_feature

protected final boolean score_is_feature

increment

protected final int increment

Constructor Detail

LearnedModelMatching

protected LearnedModelMatching(Matching _parent)

LearnedModelMatching

protected LearnedModelMatching(Index _index,
                               Matching _parent)
                        throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

applyModel

protected abstract void applyModel(int N,
                                   double[] in_scores,
                                   int F,
                                   double[][] features,
                                   double[] out_scores)

Apply the loaded learned model for identifying the top N documents.

Parameters:

N - - number of documents

in_scores - - sample scores

F - number of features

features - indexed by feature THEN document

out_scores - - final scores

match

public ResultSet match(java.lang.String queryNumber,
                       MatchingQueryTerms queryTerms)
                throws java.io.IOException

Description copied from interface: Matching

Get a ResultSet for the given query terms.

Specified by:

match in interface Matching

Parameters:

queryNumber - - some ID of the query

queryTerms - - query terms to match

Returns:

ResultSet - the matched results

Throws:

java.io.IOException - if a problem occurs during matching

setCollectionStatistics

public void setCollectionStatistics(CollectionStatistics cs)

Description copied from interface: Matching

Update the collection statistics being used by this matching instance

Specified by:

setCollectionStatistics in interface Matching

Parameters:

cs - CollectionStatistics to use during matching

getInfo

public java.lang.String getInfo()

Description copied from interface: Matching

Return a human readable description of this Matching class

Specified by:

getInfo in interface Matching