CAdditionalDocumentInformation Class

# CAdditionalDocumentInformation Class Reference

[CADIHash.h Index] [CADIHash.h Hierarchy]

Additional document information (ADI) is information is needed for weighting schemes which take into account properties of whole documents More...

`#include <../libInvertedFile/include/CAdditionalDocumentInformation.h>`

## Public Members

- CAdditionalDocumentInformation (const string& inName="N.N.")
- void setFileNameBase (const string& inName)
- void resetDF ()
- void adjustDF (double inDF)
- void resetSquareDFLogICF ()
- void adjustSquareDFLogICF (double)
- double getMaximumDF ()
- double getDFSquareSum ()
- double getSquareDFLogICFSum ()
- bool output (ostream& outStream)
- bool output ()
- bool input (istream& inStream)
- bool input ()

## Protected Members

- string mFileNameBase
- double mMaximumDF
- double mDFSquareSum
- double mSquareDFLogICFSum

## Detailed Description

Additional document information (ADI) is information is needed for weighting schemes which take into account properties of whole documents. Things like e.g. the euclidean length of a vector have to be calculated beforehand.

## CAdditionalDocumentInformation(const string& inName="N.N.")

Constructor sets filename

## void setFileNameBase(const string& inName)

...If neccesary set filename later

## void resetDF()

Reset mMaximumDF and mDFSquareSum

## void adjustDF(double inDF)

Add the right things to mMaximumDF and mDFSquareSum

## void resetSquareDFLogICF()

reset mSquareDFLogICFSum

## void adjustSquareDFLogICF(double)

add the right things to mSquareDFLogICFSum

## double getMaximumDF()

@name Accessors

## string mFileNameBase

Filename of the document (from which the ADI file will be built)

## double mMaximumDF

Maximum Document frequency of a feature for the whole document

## double mDFSquareSum

Sum of squared document frequencies off all features of the document.

## double mSquareDFLogICFSum

Sum of (DF*DF*log(ICF)) for all features of the document

| Kdoc