System documentation of the GNU Image-Finding Tool

Main Page | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members

CAcInvertedFileAbstraction Class Reference

An accessor to an inverted file. More...

#include <CAcInvertedFileAbstraction.h>

List of all members.

Public Member Functions

virtual bool operator() () const=0
 for testing if the inverted file is correctly constructed

 CAcInvertedFileAbstraction (const CXMLElement &inCollectionElement)
 This opens an exsisting inverted file, and then inits this structure.

 ~CAcInvertedFileAbstraction ()
 Destructor.

virtual string IDToURL (TID inID) const=0
 Translate a DocumentID to a URL (for output).

virtual TID URLToID (const string &inURL) const=0
 Translate an URL to its document ID.

virtual list< TID > * getAllFeatureIDs () const=0
 Getting a list of all features contained in this.

The proper inverted file access
virtual CDocumentFrequencyListFeatureToList (TFeatureID inFID) const=0
 Give the List of documents containing the feature inFID.

virtual CDocumentFrequencyListURLToFeatureList (string inURL) const=0
 List of features contained by a document with URL inURL.

virtual CDocumentFrequencyListDIDToFeatureList (TID inDID) const=0
 List of features contained by a document with ID inDID.

Accessing information about features
virtual double FeatureToCollectionFrequency (TFeatureID) const=0
 Collection frequency for a given feature.

virtual unsigned int getFeatureDescription (TID inFeatureID) const=0
 What kind of feature is the feature with ID inFeatureID?

Accessing additional document information
virtual double DIDToMaxDocumentFrequency (TID) const=0
 returns the maximum document frequency for one document ID

virtual double DIDToDFSquareSum (TID) const=0
 Returns the document-frequency square sum for a given document ID.

virtual double DIDToSquareDFLogICFSum (TID) const=0
 Returns this function for a given document ID.

virtual bool generateInvertedFile ()=0
 Generating an inverted File, if there is none.

virtual bool checkConsistency ()=0
 Check the consistency of the inverted file system accessed by this accessor.


Detailed Description

An accessor to an inverted file.

This access is done "by hand" at present this not really efficient, however we plan to move to memory mapped files.


Constructor & Destructor Documentation

CAcInvertedFileAbstraction::CAcInvertedFileAbstraction const CXMLElement inCollectionElement  ) 
 

This opens an exsisting inverted file, and then inits this structure.

After that it is fully usable

As a paramter it takes an XMLElement which contains a "collection" element and its content.

If the attribute vi-generate-inverted-file is true, then a new inverted file will be generated using the parameters given in inCollectionElement. you will NOT be able to use *this afterwards.

The REAL constructor.


Member Function Documentation

virtual CDocumentFrequencyList* CAcInvertedFileAbstraction::FeatureToList TFeatureID  inFID  )  const [pure virtual]
 

Give the List of documents containing the feature inFID.

CORNELIA: CDocumentFrequencyList ist nichts anderes als eine liste von

int,float paaren:

struct{ int mID, float mFrequency; }

virtual list<TID>* CAcInvertedFileAbstraction::getAllFeatureIDs  )  const [pure virtual]
 

Getting a list of all features contained in this.

This function is necessary, because in the present system only about 50 percent of the features are really used.

A feature is considered used if it arises in at least one image


The documentation for this class was generated from the following file:
Need for discussion? Want to contribute? Contact
help-gift@gnu.org Generated using Doxygen