---

BasicSumm Class Reference

#include <BasicSumm.hpp>

Inheritance diagram for BasicSumm:

List of all members.

Public Methods
	BasicSumm (InvFPIndex *inIdx, int inSummLen=5)
	Constructor takes index information and an option default summary length.
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	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.
virtual void	clear (void)
	Clear all scores and passages from the summarizer.
virtual int	fetchPassages (Passage psgs[], int optLen)
	Place marked passages into an array.
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.
int	isEOS (const char *check)
	Checks for EOS marker.
int	hasEOS (InvFPIndex *idx, TermInfoList *tList)
	Determines if any EOS markers are present.
double	scorePassage (BasicPassage &psg, char *qInfo)
	Scores an individual passage.
void	findNextPassage (BasicPassage &psg, InvFPIndex *idx, TermInfoList *tList, int eos)
	Locate the next passage in a document by searching for the next EOS or using a max length.
void	showPassage (passageVec *psg, InvFPIndex *idx)
	BasicSumm's method to output a summary (to screen)
void	showMarkedPassages ()
	Only display passages flagged as 'marked' as part of the output.

---

Detailed Description

A simple summarizer implementation that uses sentence selection to create summaries. This example shows how a simple 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 BasicPassage.

---

Constructor & Destructor Documentation

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

Constructor takes index information and an option default summary length.

---

Member Function Documentation

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

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

void BasicSumm::clear (  void    )  [virtual]

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

int BasicSumm::fetchPassages (  Passage    psgs[], int    optLen )  [virtual]

Place marked passages into an array. Implements Summarizer.

void BasicSumm::findNextPassage (  BasicPassage &    psg, InvFPIndex *    idx, TermInfoList *    tList, int    eos )  [inline]

Locate the next passage in a document by searching for the next EOS or using a max length.

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

Determines if any EOS markers are present.

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

Checks for EOS marker.

void BasicSumm::iterClear (  void    )  [virtual]

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

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

Flag optLen passages for inclusion in summary. Implements Summarizer.

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

Get the next passage in iterative manner. Implements Summarizer.

void BasicSumm::outputSumm (  void    )  [virtual]

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

double BasicSumm::scorePassage (  BasicPassage &    psg, char *    qInfo )  [inline]

Scores an individual passage.

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

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

void BasicSumm::showMarkedPassages (    )  [inline]

Only display passages flagged as 'marked' as part of the output.

void BasicSumm::showPassage (  passageVec *    psg, InvFPIndex *    idx )  [inline]

BasicSumm's method to output a summary (to screen)

void BasicSumm::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:

• BasicSumm.hpp
• BasicSumm.cpp

---