File: CDocumentFrequencyList.h

package info (click to toggle)
gnuift 0.1.14%2Bds-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 5,632 kB
  • ctags: 2,973
  • sloc: cpp: 15,867; sh: 8,281; ansic: 1,812; perl: 1,007; php: 651; makefile: 483; lisp: 344
file content (127 lines) | stat: -rw-r--r-- 3,166 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/* -*- mode: c++ -*- 
*/
/* 

    GIFT, a flexible content based image retrieval system.
    Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva

     Copyright (C) 2003, 2004 Bayreuth University
      2005 Bamberg University
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
/**
*
* 
*
*
*
* modification history:
* WM 19990913 
* HM 090399   created the documentation
* WM          created
*
*
*
* compiler defines used:
*
*
*/
#ifndef _CDOCUMENTFREQUENCYLIST
#define _CDOCUMENTFREQUENCYLIST
#include "libGIFTAcInvertedFile/include/uses-declarations.h"
#include "libGIFTAcInvertedFile/include/CDocumentFrequencyElement.h"

//#define _CDocumentFrequencyListIsVector
//#define _CDocumentFrequencyListIsList
#define _CDocumentFrequencyListIsArray

#ifdef _CDocumentFrequencyListIsVector
#include <vector>
#else
#include <list>
#endif

/** A list of Document Frequency Elements (the main part of an inverted file) */
class CDocumentFrequencyList
#ifdef  _CDocumentFrequencyListIsVector
:public vector<CDocumentFrequencyElement>
#endif
#ifdef  _CDocumentFrequencyListIsList
:public list<CDocumentFrequencyElement>
#endif
{
  /** The (maximum) size of this */
  int mSize;
  /** The end of this */
  CDocumentFrequencyElement* mEnd;
  
#ifdef _CDocumentFrequencyListIsArray
  CDocumentFrequencyElement* mContent;
#endif
public:
  /**
   *
   * Constructor
   *
   */
  CDocumentFrequencyList(size_t inSize);
  /**
   *
   * Constructor
   *
   */
  CDocumentFrequencyList();
  /**
   *
   * Destructor
   *
   */
  ~CDocumentFrequencyList();
  /**
   *
   * A nice function for writing the whole list as binary 
   * (as opposed to human readable ascii) into a file
   * 
   */
  bool writeBinary(ostream& outStream)const;
  /**
   *
   * A nice function for reading the whole list as binary 
   * (as opposed to human readable ascii) from a file
   * 
   */
  bool readBinary(istream& inStream);
#ifdef _CDocumentFrequencyListIsArray
  /** mimicking STL iterator is simple pointer*/
  typedef CDocumentFrequencyElement* iterator;
  /** mimicking STL const_iterator is simple const pointer*/
  typedef CDocumentFrequencyElement const* const_iterator;
  /** mimicking STL */
  iterator begin();
  /** mimicking STL */
  iterator end();
  /** mimicking STL */
  const_iterator begin()const;
  /** mimicking STL */
  const_iterator end()const;
  /** mimicking STL */
  size_t size()const;
  /** to set the end of this */
  void setEnd(CDocumentFrequencyElement*);
#endif
};

#endif