System documentation of the GNU Image-Finding Tool

CDocumentFrequencyList.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 */
42 #ifndef _CDOCUMENTFREQUENCYLIST
43 #define _CDOCUMENTFREQUENCYLIST
44 #include "libGIFTAcInvertedFile/include/uses-declarations.h"
45 #include "libGIFTAcInvertedFile/include/CDocumentFrequencyElement.h"
46 
47 //#define _CDocumentFrequencyListIsVector
48 //#define _CDocumentFrequencyListIsList
49 #define _CDocumentFrequencyListIsArray
50 
51 #ifdef _CDocumentFrequencyListIsVector
52 #include <vector>
53 #else
54 #include <list>
55 #endif
56 
59 #ifdef _CDocumentFrequencyListIsVector
60 :public vector<CDocumentFrequencyElement>
61 #endif
62 #ifdef _CDocumentFrequencyListIsList
63 :public list<CDocumentFrequencyElement>
64 #endif
65 {
67  int mSize;
70 
71 #ifdef _CDocumentFrequencyListIsArray
72  CDocumentFrequencyElement* mContent;
73 #endif
74 public:
80  CDocumentFrequencyList(size_t inSize);
99  bool writeBinary(ostream& outStream)const;
106  bool readBinary(istream& inStream);
107 #ifdef _CDocumentFrequencyListIsArray
108 
113  iterator begin();
115  iterator end();
117  const_iterator begin()const;
119  const_iterator end()const;
121  size_t size()const;
124 #endif
125 };
126 
127 #endif
void setEnd(CDocumentFrequencyElement *)
to set the end of this
CDocumentFrequencyElement * iterator
mimicking STL iterator is simple pointer
Definition: CDocumentFrequencyList.h:109
CDocumentFrequencyList()
Constructor.
iterator begin()
mimicking STL
A list of Document Frequency Elements (the main part of an inverted file)
Definition: CDocumentFrequencyList.h:58
bool writeBinary(ostream &outStream) const
A nice function for writing the whole list as binary (as opposed to human readable ascii) into a file...
bool readBinary(istream &inStream)
A nice function for reading the whole list as binary (as opposed to human readable ascii) from a file...
iterator end()
mimicking STL
CDOCUMENTFREQUENCYELEMENT.
Definition: CDocumentFrequencyElement.h:49
CDocumentFrequencyElement const * const_iterator
mimicking STL const_iterator is simple const pointer
Definition: CDocumentFrequencyList.h:111
size_t size() const
mimicking STL
~CDocumentFrequencyList()
Destructor.

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