CAdditionalDocumentInformation Class Reference

#include <CAdditionalDocumentInformation.h>

List of all members.

Public Member Functions
	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
Accessors
double	getMaximumDF () const
double	getDFSquareSum () const
double	getSquareDFLogICFSum () const
bool	output (ostream &outStream) const
bool	output () const
bool	input (istream &inStream)
bool	input ()
Protected Attributes
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.

---

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.

Definition at line 56 of file CAdditionalDocumentInformation.h.

---

Constructor & Destructor Documentation

CAdditionalDocumentInformation::CAdditionalDocumentInformation

(

const string &

inName = "N.N."

)

Constructor sets filename.

Definition at line 61 of file CAdditionalDocumentInformation.cc.

References resetDF(), resetSquareDFLogICF(), and setFileNameBase().

                                                                                  {
  setFileNameBase(inName);
  resetDF();
  resetSquareDFLogICF();
};

---

Member Function Documentation

void CAdditionalDocumentInformation::setFileNameBase

(

const string &

inName

)

...If neccesary set filename later

Definition at line 81 of file CAdditionalDocumentInformation.cc.

References mFileNameBase, and resetDF().

Referenced by CAdditionalDocumentInformation().

                                                                        {
  mFileNameBase=inName;
  resetDF();
};

void CAdditionalDocumentInformation::resetDF

(

)

Reset mMaximumDF and mDFSquareSum.

Definition at line 100 of file CAdditionalDocumentInformation.cc.

References mDFSquareSum, and mMaximumDF.

Referenced by CAdditionalDocumentInformation(), and setFileNameBase().

                                            {
  mMaximumDF=0;
  mDFSquareSum=0;
};

void CAdditionalDocumentInformation::adjustDF

(

double

inDF

)

Add the right things to mMaximumDF and mDFSquareSum.

Definition at line 119 of file CAdditionalDocumentInformation.cc.

References mDFSquareSum, and mMaximumDF.

                                                        {
  mDFSquareSum+=inDF*inDF;
  mMaximumDF=max(inDF,mMaximumDF);
};

void CAdditionalDocumentInformation::resetSquareDFLogICF

(

)

reset mSquareDFLogICFSum

Definition at line 176 of file CAdditionalDocumentInformation.cc.

References mSquareDFLogICFSum.

Referenced by CAdditionalDocumentInformation().

                                                        {
  mSquareDFLogICFSum=0;
};

void CAdditionalDocumentInformation::adjustSquareDFLogICF

(

double

inValue

)

add the right things to mSquareDFLogICFSum

Definition at line 194 of file CAdditionalDocumentInformation.cc.

References mSquareDFLogICFSum.

                                                                       {
  mSquareDFLogICFSum+=inValue;
};

double CAdditionalDocumentInformation::getMaximumDF

(

)

const

Definition at line 138 of file CAdditionalDocumentInformation.cc.

References mMaximumDF.

                                                        {
  assert(mMaximumDF);
  return mMaximumDF;
};

double CAdditionalDocumentInformation::getDFSquareSum

(

)

const

Definition at line 157 of file CAdditionalDocumentInformation.cc.

References mDFSquareSum.

                                                          {
  assert(mDFSquareSum);
  return mDFSquareSum;
};

double CAdditionalDocumentInformation::getSquareDFLogICFSum

(

)

const

Definition at line 212 of file CAdditionalDocumentInformation.cc.

References mSquareDFLogICFSum.

                                                                {
  return mSquareDFLogICFSum;
};

bool CAdditionalDocumentInformation::output

(

ostream &

outStream

)

const

Definition at line 253 of file CAdditionalDocumentInformation.cc.

References mDFSquareSum, mMaximumDF, and mSquareDFLogICFSum.

                                                                  {
#ifdef PRINT
  cout << "[>mSquareDFLogICFSum" 
       << mMaximumDF
       << ",square"
       << mDFSquareSum
       << ","
       << mSquareDFLogICFSum
       << "]" 
       << flush 
       << endl;
#endif
  outStream << mMaximumDF
      << " " 
      << mDFSquareSum
      << " " 
      << mSquareDFLogICFSum;
 return outStream;
};

bool CAdditionalDocumentInformation::output

(

)

const

Definition at line 230 of file CAdditionalDocumentInformation.cc.

References mFileNameBase.

                                                {
  ofstream 
    lStream(string(mFileNameBase+".ADI").c_str());

  

  return output(lStream);
};

bool CAdditionalDocumentInformation::input

(

istream &

inStream

)

Definition at line 287 of file CAdditionalDocumentInformation.cc.

References mDFSquareSum, mMaximumDF, and mSquareDFLogICFSum.

                                                           {
  inStream >> mMaximumDF
     >> mDFSquareSum
     >> mSquareDFLogICFSum;
#ifdef PRINT
  cout << "[Max" 
       << mMaximumDF
       << ",square"
       << mDFSquareSum
       << ",IDFlog.."
       << mSquareDFLogICFSum
       << "]" 
       << flush 
       << endl;
#endif
  return inStream;
};

bool CAdditionalDocumentInformation::input

(

)

Definition at line 319 of file CAdditionalDocumentInformation.cc.

References mFileNameBase.

                                          {
  ifstream 
    lStream(string(mFileNameBase+".ADI").c_str());
  return input(lStream);
};

---

Member Data Documentation

string CAdditionalDocumentInformation::mFileNameBase [protected]

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

Definition at line 59 of file CAdditionalDocumentInformation.h.

Referenced by input(), output(), and setFileNameBase().

double CAdditionalDocumentInformation::mMaximumDF [protected]

Maximum Document frequency of a feature for the whole document.

Definition at line 61 of file CAdditionalDocumentInformation.h.

Referenced by adjustDF(), getMaximumDF(), input(), output(), and resetDF().

double CAdditionalDocumentInformation::mDFSquareSum [protected]

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

Definition at line 63 of file CAdditionalDocumentInformation.h.

Referenced by adjustDF(), getDFSquareSum(), input(), output(), and resetDF().

double CAdditionalDocumentInformation::mSquareDFLogICFSum [protected]

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

Definition at line 65 of file CAdditionalDocumentInformation.h.

Referenced by adjustSquareDFLogICF(), getSquareDFLogICFSum(), input(), output(), and resetSquareDFLogICF().

---

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

• gift/libGIFTAcInvertedFile/include/CAdditionalDocumentInformation.h
• gift/libGIFTAcInvertedFile/cc/CAdditionalDocumentInformation.cc