---

MMRSumm Class Reference

#include <MMRSumm.hpp>

Inheritance diagram for MMRSumm:

List of all members.

Public Methods
	MMRSumm (InvFPIndex *inIdx, int inSummLen=5)
virtual void	markPassages (int optLen, char *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 char *docID)
virtual int	fetchPassages (Passage psgs[], int optLen)
	Place marked passages into an array.
virtual void	summDocument (const char *docID, const int optLen, const char *qInfo)
	General purpose function that does all summary computation as well as passage marking.
virtual void	scorePassages (const char *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)
	Get the next passage in iterative manner.
virtual void	iterClear (void)
	Reset to the first summarized passage (in conjunction with nextPassage).
virtual void	outputSumm (void)
	General purpose "send summary to stdout" function.
void	findNextPassage (MMRPassage &psg, InvFPIndex *idx, TermInfoList *tList, int eos)
void	showPassage (passageVec *psg, InvFPIndex *idx)
void	showMarkedPassages ()
int	isEOS (const char *check)
int	hasEOS (InvFPIndex *idx, TermInfoList *tList)
int	isTITLE (const char *check)
int	hasTITLE (InvFPIndex *idx, TermInfoList *tList)
int	isPRONOUN (const char *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 (  InvFPIndex *    inIdx, int    inSummLen = 5 )  [inline]

---

Member Function Documentation

void MMRSumm::addDocument (  const char *    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 )  [virtual]

Place marked passages into an array. Implements Summarizer.

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

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

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

int MMRSumm::isEOS (  const char *    check )  [inline]

int MMRSumm::isPRONOUN (  const char *    check )  [inline]

int MMRSumm::isTITLE (  const char *    check )  [inline]

void MMRSumm::iterClear (  void    )  [virtual]

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

void MMRSumm::markPassages (  int    optLen, char *    qInfo )  [virtual]

Flag optLen passages for inclusion in summary. Implements Summarizer.

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

Get the next passage in iterative manner. Implements Summarizer.

void MMRSumm::outputSumm (  void    )  [virtual]

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

void MMRSumm::scorePassages (  const char *    qInfo )  [virtual]

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

void MMRSumm::showMarkedPassages (    )

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

void MMRSumm::summDocument (  const char *    docID, const int    optLen, const char *    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

---