dragon.ir.search.smooth

Class AbstractSmoother

java.lang.Object

dragon.ir.search.smooth.AbstractSmoother

All Implemented Interfaces:

Smoother

Direct Known Subclasses:

AbsoluteDiscountSmoother, DirichletSmoother, DocFirstTransSmoother, JMSmoother, OkapiSmoother, PivotedNormSmoother, QueryFirstTransSmoother, TFIDFSmoother, TwoStageSmoother

public abstract class AbstractSmoother
extends Object
implements Smoother

Abstract Smoother

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	docFirstOptimal
protected boolean	querytermFirstOptimal
protected double	queryWeight
protected boolean	useLog

Constructor Summary

Constructors

Constructor and Description
AbstractSmoother()

Method Summary

Modifier and Type	Method and Description
protected abstract double	computeSmoothedProb(int termFreq)
boolean	getLogLikelihoodOption()
protected double	getProb(double originalProb)
double	getSmoothedProb(int termFreq) Before calling this method, one should call the setQueryTerm method and the setDoc method.
double	getSmoothedProb(IRDoc doc) It is equal to calling getSmoothedProb(doc, 0);
double	getSmoothedProb(IRDoc doc, int termFreq) Before calling this method, one should call the setQueryTerm method.
double	getSmoothedProb(IRDoc doc, SimpleTermPredicate queryTerm) This method is equal to call getSmoothedProb(doc, queryTerm, 0).
double	getSmoothedProb(IRDoc doc, SimpleTermPredicate queryTerm, int termFreq)
double	getSmoothedProb(SimpleTermPredicate queryTerm) It is equal to calling getSmoothedProb(queryTerm, 0);
double	getSmoothedProb(SimpleTermPredicate queryTerm, int termFreq) Before calling this method, one should call the setDoc method.
boolean	isDocFirstOptimal() If this method returns true, the fullrank searcher will do breadth-frist search, i.e.
boolean	isQueryTermFirstOptimal() If this method returns true, the fullrank searcher will do depth-frist search, i.e.
void	setLogLikelihoodOption(boolean option) If this option is true, smoomther will return a log score

Methods inherited from class java.lang.Object

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

Methods inherited from interface dragon.ir.search.smooth.Smoother

setDoc, setParameters, setQueryTerm

Field Detail

useLog

protected boolean useLog

queryWeight

protected double queryWeight

docFirstOptimal

protected boolean docFirstOptimal

querytermFirstOptimal

protected boolean querytermFirstOptimal

Constructor Detail

AbstractSmoother

public AbstractSmoother()

Method Detail

computeSmoothedProb

protected abstract double computeSmoothedProb(int termFreq)

isDocFirstOptimal

public boolean isDocFirstOptimal()

Description copied from interface: Smoother

If this method returns true, the fullrank searcher will do breadth-frist search, i.e. processing document one by one.

Specified by:

isDocFirstOptimal in interface Smoother

Returns:

true or false

isQueryTermFirstOptimal

public boolean isQueryTermFirstOptimal()

Description copied from interface: Smoother

If this method returns true, the fullrank searcher will do depth-frist search, i.e. processing query terms one by one and then merging the document lists resulted from different query terms.

Specified by:

isQueryTermFirstOptimal in interface Smoother

Returns:

true or false

setLogLikelihoodOption

public void setLogLikelihoodOption(boolean option)

Description copied from interface: Smoother

If this option is true, smoomther will return a log score

Specified by:

setLogLikelihoodOption in interface Smoother

Parameters:

option - true or false

getLogLikelihoodOption

public boolean getLogLikelihoodOption()

Specified by:

getLogLikelihoodOption in interface Smoother

getSmoothedProb

public double getSmoothedProb(int termFreq)

Description copied from interface: Smoother

Before calling this method, one should call the setQueryTerm method and the setDoc method.

Specified by:

getSmoothedProb in interface Smoother

Parameters:

termFreq - the frequency of the current term in the current document

Returns:

a score

getSmoothedProb

public double getSmoothedProb(IRDoc doc,
                              int termFreq)

Description copied from interface: Smoother

Before calling this method, one should call the setQueryTerm method.

Specified by:

getSmoothedProb in interface Smoother

Parameters:

doc - the document

termFreq - the frequency of the current query term in the given document

Returns:

a score

getSmoothedProb

public double getSmoothedProb(IRDoc doc)

Description copied from interface: Smoother

It is equal to calling getSmoothedProb(doc, 0);

Specified by:

getSmoothedProb in interface Smoother

Parameters:

doc - the document

Returns:

a score

getSmoothedProb

public double getSmoothedProb(SimpleTermPredicate queryTerm,
                              int termFreq)

Description copied from interface: Smoother

Before calling this method, one should call the setDoc method.

Specified by:

getSmoothedProb in interface Smoother

Parameters:

queryTerm - the query term

termFreq - the frequency of the given query term in the current document

Returns:

a score

getSmoothedProb

public double getSmoothedProb(SimpleTermPredicate queryTerm)

Description copied from interface: Smoother

It is equal to calling getSmoothedProb(queryTerm, 0);

Specified by:

getSmoothedProb in interface Smoother

Parameters:

queryTerm - the query term

Returns:

a score

getSmoothedProb

public double getSmoothedProb(IRDoc doc,
                              SimpleTermPredicate queryTerm)

Description copied from interface: Smoother

This method is equal to call getSmoothedProb(doc, queryTerm, 0).

Specified by:

getSmoothedProb in interface Smoother

Parameters:

doc - the document

queryTerm - the query term

Returns:

a score

getSmoothedProb

public double getSmoothedProb(IRDoc doc,
                              SimpleTermPredicate queryTerm,
                              int termFreq)

Specified by:

getSmoothedProb in interface Smoother

Parameters:

doc - the document

queryTerm - the query term

termFreq - the frequency of the query term in the given document

Returns:

a score

getProb

protected double getProb(double originalProb)