---

MMRSumm Class Reference

#include <MMRSumm.hpp>

Inheritance diagram for MMRSumm:

List of all members.

Public Methods
	MMRSumm (const InvFPIndex *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 InvFPIndex *idx, const TermInfoList *tList, int eos)
void	showPassage (const passageVec *psg, const InvFPIndex *idx) const
void	showMarkedPassages () const
int	isEOS (const string &check)
int	hasEOS (const InvFPIndex *idx, const TermInfoList *tList)
int	isTITLE (const string &check)
int	hasTITLE (const InvFPIndex *idx, const TermInfoList *tList)
int	isPRONOUN (const string &check)

---

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

MMRSumm::MMRSumm (  const InvFPIndex *    inIdx, int    inSummLen = 5 )  [inline]

---

Member Function Documentation

void MMRSumm::addDocument (  const string &    docID )

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

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

void MMRSumm::clear (  void    )  [virtual]

Clear all scores and passages from the summarizer. Implements Summarizer.

int MMRSumm::fetchPassages (  Passage *    psgs, int    optLen )  const [virtual]

Place marked passages into an array. Implements Summarizer.

void MMRSumm::findNextPassage (  MMRPassage &    psg, const InvFPIndex *    idx, const TermInfoList *    tList, int    eos )

int MMRSumm::hasEOS (  const InvFPIndex *    idx, const TermInfoList *    tList )  [inline]

int MMRSumm::hasTITLE (  const InvFPIndex *    idx, const TermInfoList *    tList )  [inline]

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

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

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

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

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

void MMRSumm::markPassages (  int    optLen, const string &    qInfo )  [virtual]

Flag optLen passages for inclusion in summary. Implements Summarizer.

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

Get the next passage in iterative manner. Implements Summarizer.

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

General purpose "send summary to stdout" function. Implements Summarizer.

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

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

void MMRSumm::showMarkedPassages (    )

void MMRSumm::showPassage (  const passageVec *    psg, const InvFPIndex *    idx )  const

void 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 Summarizer.

---

The documentation for this class was generated from the following files:

• MMRSumm.hpp
• MMRSumm.cpp

---