lemur::summarization::MMRSumm Class Reference

#include <MMRSumm.hpp>

Inheritance diagram for lemur::summarization::MMRSumm:

List of all members.


Public Member Functions
	MMRSumm (const lemur::api::Index *inIdx, int inSummLen=5)
virtual void	markPassages (int optLen, const string &qInfo)
	Flag `optLen` passages for inclusion in summary.
virtual void	addPassage (Passage &psg)
	Append a new passage to the list the summarizer will use to generate summary.
void	addDocument (const string &docID)
virtual int	fetchPassages (Passage *psgs, int optLen) const
	Place marked passages into an array.
virtual void	summDocument (const string &docID, const int optLen, const string &qInfo)
	General purpose function that does all summary computation as well as passage marking.
virtual void	scorePassages (const string &qInfo)
	Score ALL passages currently in this summarizer, optionally given query terms.
virtual void	clear (void)
	Clear all scores and passages from the summarizer.
virtual int	nextPassage (Passage *psg) const
	Get the next passage in iterative manner.
virtual void	iterClear (void) const
	Reset to the first summarized passage (in conjunction with `nextPassage`).
virtual void	outputSumm (void) const
	General purpose "send summary to stdout" function.
void	findNextPassage (MMRPassage &psg, const lemur::api::Index idx, const lemur::api::TermInfoList tList, int eos)
void	showPassage (const passageVec psg, const lemur::api::Index idx) const
void	showMarkedPassages () const
int	isEOS (const string &check)
int	hasEOS (const lemur::api::Index idx, const lemur::api::TermInfoList tList)
int	isTITLE (const string &check)
int	hasTITLE (const lemur::api::Index idx, const lemur::api::TermInfoList tList)
int	isPRONOUN (const string &check)
Static Public Attributes
const string	TITLE = "*title"
	title marker
const string	PRONOUN = "*pronoun"
	pronoun marker
Private Member Functions
int	autoMMRQuery (void)
int	setMMRQuery (const string &qInfo)
Private Attributes
double	lambda
const lemur::api::Index *	idx
int	summLen
vector< MMRPassage >	doc
int	iterCount
double	maxSims
MMRPassage *	queryPassage

Detailed Description

A summarizer implementation that uses MMR to create summaries. This example shows how a slightly more complex summarizer may look, and how to use the Summarizer abstract with the Passage abstract. Note that this implementation is paired with an implementation of Passage called MMRPassage.

Constructor & Destructor Documentation

lemur::summarization::MMRSumm::MMRSumm ( const lemur::api::Index * inIdx,

int inSummLen = 5

) [inline]

Member Function Documentation

void lemur::summarization::MMRSumm::addDocument ( const string & docID )

void lemur::summarization::MMRSumm::addPassage ( Passage & psg ) [virtual]

Append a new passage to the list the summarizer will use to generate summary.

Implements lemur::summarization::Summarizer.

int lemur::summarization::MMRSumm::autoMMRQuery ( void ) [inline, private]

void lemur::summarization::MMRSumm::clear ( void ) [virtual]

Clear all scores and passages from the summarizer.

Implements lemur::summarization::Summarizer.

int lemur::summarization::MMRSumm::fetchPassages ( Passage * psgs,

int optLen

) const [virtual]

Place marked passages into an array.

Implements lemur::summarization::Summarizer.

void lemur::summarization::MMRSumm::findNextPassage ( MMRPassage & psg,

const lemur::api::Index * idx,

const lemur::api::TermInfoList * tList,

int eos

)

int lemur::summarization::MMRSumm::hasEOS ( const lemur::api::Index * idx,

const lemur::api::TermInfoList * tList

) [inline]

int lemur::summarization::MMRSumm::hasTITLE ( const lemur::api::Index * idx,

const lemur::api::TermInfoList * tList

) [inline]

int lemur::summarization::MMRSumm::isEOS ( const string & check ) [inline]

int lemur::summarization::MMRSumm::isPRONOUN ( const string & check ) [inline]

int lemur::summarization::MMRSumm::isTITLE ( const string & check ) [inline]

void lemur::summarization::MMRSumm::iterClear ( void ) const [virtual]

Reset to the first summarized passage (in conjunction with nextPassage).

Implements lemur::summarization::Summarizer.

void lemur::summarization::MMRSumm::markPassages ( int optLen,

const string & qInfo

) [virtual]

Flag optLen passages for inclusion in summary.

Implements lemur::summarization::Summarizer.

int lemur::summarization::MMRSumm::nextPassage ( Passage * psg ) const [virtual]

Get the next passage in iterative manner.

Implements lemur::summarization::Summarizer.

void lemur::summarization::MMRSumm::outputSumm ( void ) const [virtual]

General purpose "send summary to stdout" function.

Implements lemur::summarization::Summarizer.

void lemur::summarization::MMRSumm::scorePassages ( const string & qInfo ) [virtual]

Score ALL passages currently in this summarizer, optionally given query terms.

Implements lemur::summarization::Summarizer.

int lemur::summarization::MMRSumm::setMMRQuery ( const string & qInfo ) [inline, private]

void lemur::summarization::MMRSumm::showMarkedPassages ( ) const

void lemur::summarization::MMRSumm::showPassage ( const passageVec * psg,

const lemur::api::Index * idx

) const

void lemur::summarization::MMRSumm::summDocument ( const string & docID,

const int optLen,

const string & qInfo

) [virtual]

General purpose function that does all summary computation as well as passage marking.

Implements lemur::summarization::Summarizer.