System documentation of the GNU Image-Finding Tool

CAcInvertedFileAbstraction.h
1 /* -*- mode: c++ -*-
2 */
3 /*
4 
5  GIFT, a flexible content based image retrieval system.
6  Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva
7 
8  Copyright (C) 2003, 2004 Bayreuth University
9  2005 Bamberg University
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14 
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with this program; if not, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 
24 */
25 // -*- mode: c++ -*-
26 
27 
28 class CXMLElement;
29 
52 #ifndef _CINVERTEDFILEACCESSOR
53 #define _CINVERTEDFILEACCESSOR
54 #include "libGIFTAcInvertedFile/include/uses-declarations.h"
55 #include <string>
56 #include "libMRML/include/TID.h"
57 #include "libMRML/include/CSelfDestroyPointer.h"
58 #include "libMRML/include/CArraySelfDestroyPointer.h"
59 #include "libGIFTAcInvertedFile/include/CDocumentFrequencyList.h"
60 #include "CCollectionFrequencyList.h"
61 #include "libGIFTAcInvertedFile/include/CADIHash.h"
62 #include "libGIFTAcURL2FTS/include/CAcURL2FTS.h"
63 #include <iostream>
64 #include <fstream>
65 #include <map>
66 #include <vector>
67 #ifdef HAS_HASH_MAP
68 #include <hash_map>
69 #else
70 #define hash_map map
71 #endif
72 #include <functional>
73 #include <algorithm>
74 
75 #include "libMRML/include/CMagic.h"
76 
77 
78 typedef TID TFeatureID ;
79 
87 
88 public:
90  virtual bool operator()()const =0;
91 
106  CAcInvertedFileAbstraction(const CXMLElement& inCollectionElement);
109 
113  virtual string IDToURL(TID inID)const =0;
114 
116  virtual TID URLToID(const string& inURL)const =0;
117 
134  virtual CDocumentFrequencyList* FeatureToList(TFeatureID inFID)const =0;
135 
137  virtual CDocumentFrequencyList* URLToFeatureList(string inURL)const =0;
138 
140  virtual CDocumentFrequencyList* DIDToFeatureList(TID inDID)const =0;
141 
154 
155 
159  virtual double FeatureToCollectionFrequency(TFeatureID)const =0;
160 
162  virtual unsigned int getFeatureDescription(TID inFeatureID)const =0;
164 
168  virtual double DIDToMaxDocumentFrequency(TID)const =0;
169 
171  virtual double DIDToDFSquareSum(TID)const =0;
172 
174  virtual double DIDToSquareDFLogICFSum(TID)const =0;
176 
177  /*@name Inverted File Generation and Consistency Checking*/
179 
182  virtual bool generateInvertedFile() =0;
183 
186  virtual bool checkConsistency() =0;
187 
189 
197  virtual list<TID>* getAllFeatureIDs()const =0;
198 };
199 
200 #endif
virtual double DIDToMaxDocumentFrequency(TID) const =0
returns the maximum document frequency for one document ID
virtual double DIDToSquareDFLogICFSum(TID) const =0
Returns this function for a given document ID.
virtual CDocumentFrequencyList * FeatureToList(TFeatureID inFID) const =0
Give the List of documents containing the feature inFID.
~CAcInvertedFileAbstraction()
Destructor.
virtual double FeatureToCollectionFrequency(TFeatureID) const =0
Collection frequency for a given feature.
This class captures the structure of an XML element.
Definition: CXMLElement.h:51
virtual string IDToURL(TID inID) const =0
<HIER-WIRDS-INTERESSANT->
A list of Document Frequency Elements (the main part of an inverted file)
Definition: CDocumentFrequencyList.h:58
virtual unsigned int getFeatureDescription(TID inFeatureID) const =0
What kind of feature is the feature with ID inFeatureID?
virtual TID URLToID(const string &inURL) const =0
Translate an URL to its document ID.
virtual bool generateInvertedFile()=0
Generating an inverted File, if there is none.
CAcInvertedFileAbstraction(const CXMLElement &inCollectionElement)
This opens an exsisting inverted file, and then inits this structure.
virtual bool operator()() const =0
for testing if the inverted file is correctly constructed
An accessor to an inverted file.
Definition: CAcInvertedFileAbstraction.h:86
virtual double DIDToDFSquareSum(TID) const =0
Returns the document-frequency square sum for a given document ID.
virtual CDocumentFrequencyList * URLToFeatureList(string inURL) const =0
List of features contained by a document with URL inURL.
virtual list< TID > * getAllFeatureIDs() const =0
Getting a list of all features contained in this.
virtual bool checkConsistency()=0
Check the consistency of the inverted file system accessed by this accessor.
virtual CDocumentFrequencyList * DIDToFeatureList(TID inDID) const =0
List of features contained by a document with ID inDID.

Need for discussion? Want to contribute? Contact
help-gift@gnu.org Generated using Doxygen