System documentation of the GNU Image-Finding Tool

CAdditionalDocumentInformation.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 /***************************************
26 *
27 * CADDITIONALDOCUMENTINFORMATION
28 *
29 ****************************************
30 *
31 * modification history:
32 *
33 * HM 090399 created the documentation
34 *
35 ****************************************
36 *
37 * compiler defines used:
38 *
39 *
40 ****************************************/
41 #ifndef _CADDITIONALDOCUMENTINFORMATION
42 #define _CADDITIONALDOCUMENTINFORMATION
43 #include "libGIFTAcInvertedFile/include/uses-declarations.h"
44 #include "libMRML/include/TID.h"
45 #include <string>
46 #include <functional>
47 #include <iostream>
48 #include <fstream>
57 protected:
59  string mFileNameBase;
61  double mMaximumDF;
63  double mDFSquareSum;
66 
67 public:
68 /***************************************
69 *
70 *
71 *
72 ***************************************/
74  CAdditionalDocumentInformation(const string& inName="N.N.");
75 
76 /***************************************
77 *
78 *
79 *
80 ***************************************/
82  void setFileNameBase(const string& inName);
83 
84 /***************************************
85 *
86 *
87 *
88 ***************************************/
90  void resetDF();
91 
92 /***************************************
93 *
94 *
95 *
96 ***************************************/
98  void adjustDF(double inDF);
99 
100 /***************************************
101 *
102 *
103 *
104 ***************************************/
106  void resetSquareDFLogICF();
107 
108 /***************************************
109 *
110 *
111 *
112 ***************************************/
114  void adjustSquareDFLogICF(double);
115 
116 /***************************************
117 *
118 *
119 *
120 ***************************************/
122 
123  double getMaximumDF()const;
124 
125 /***************************************
126 *
127 *
128 *
129 ***************************************/
131  double getDFSquareSum()const;
132 
133 /***************************************
134 *
135 *
136 *
137 ***************************************/
139  double getSquareDFLogICFSum()const;
140 
141 /***************************************
142 *
143 *
144 *
145 ***************************************/
147  //@name input/output to streams
149  bool output(ostream& outStream)const;
151 
152 /***************************************
153 *
154 *
155 *
156 ***************************************/
158  bool output()const;
159 
160 /***************************************
161 *
162 *
163 *
164 ***************************************/
166  bool input(istream& inStream);
167 
168 /***************************************
169 *
170 *
171 *
172 ***************************************/
174  bool input();
175 
177 };
178 
179 
180 #endif
string mFileNameBase
Filename of the document (from which the ADI file will be built)
Definition: CAdditionalDocumentInformation.h:59
Additional document information (ADI) is information is needed for weighting schemes which take into ...
Definition: CAdditionalDocumentInformation.h:56
void adjustDF(double inDF)
Add the right things to mMaximumDF and mDFSquareSum.
double mSquareDFLogICFSum
Sum of (DF*DF*log(ICF)) for all features of the document.
Definition: CAdditionalDocumentInformation.h:65
CAdditionalDocumentInformation(const string &inName="N.N.")
Constructor sets filename.
double mDFSquareSum
Sum of squared document frequencies off all features of the document.
Definition: CAdditionalDocumentInformation.h:63
void resetSquareDFLogICF()
reset mSquareDFLogICFSum
void adjustSquareDFLogICF(double)
add the right things to mSquareDFLogICFSum
void resetDF()
Reset mMaximumDF and mDFSquareSum.
void setFileNameBase(const string &inName)
...If neccesary set filename later
double mMaximumDF
Maximum Document frequency of a feature for the whole document.
Definition: CAdditionalDocumentInformation.h:61

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