System documentation of the GNU Image-Finding Tool

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

CAdditionalDocumentInformation.h

00001 /* -*- mode: c++ -*- 
00002 */
00003 /* 
00004 
00005     GIFT, a flexible content based image retrieval system.
00006     Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva
00007 
00008      Copyright (C) 2003, 2004 Bayreuth University
00009       2005 Bamberg University
00010     This program is free software; you can redistribute it and/or modify
00011     it under the terms of the GNU General Public License as published by
00012     the Free Software Foundation; either version 2 of the License, or
00013     (at your option) any later version.
00014 
00015     This program is distributed in the hope that it will be useful,
00016     but WITHOUT ANY WARRANTY; without even the implied warranty of
00017     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018     GNU General Public License for more details.
00019 
00020     You should have received a copy of the GNU General Public License
00021     along with this program; if not, write to the Free Software
00022     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00023 
00024 */
00025 /***************************************
00026 *
00027 * CADDITIONALDOCUMENTINFORMATION
00028 *
00029 ****************************************
00030 *
00031 * modification history:
00032 *
00033 * HM 090399 created the documentation
00034 *
00035 ****************************************
00036 *
00037 * compiler defines used:
00038 *
00039 *
00040 ****************************************/
00041 #ifndef _CADDITIONALDOCUMENTINFORMATION
00042 #define _CADDITIONALDOCUMENTINFORMATION
00043 #include "libGIFTAcInvertedFile/include/uses-declarations.h"
00044 #include "libMRML/include/TID.h"
00045 #include <string>
00046 #include <functional>
00047 #include <iostream>
00048 #include <fstream>
00056 class CAdditionalDocumentInformation{
00057 protected:
00059   string mFileNameBase;
00061   double mMaximumDF;
00063   double mDFSquareSum;
00065   double mSquareDFLogICFSum;
00066 
00067 public:
00068 /***************************************
00069 *
00070 * 
00071 *
00072 ***************************************/
00074   CAdditionalDocumentInformation(const string& inName="N.N.");
00075   
00076 /***************************************
00077 *
00078 * 
00079 *
00080 ***************************************/
00082   void setFileNameBase(const string& inName);
00083 
00084 /***************************************
00085 *
00086 * 
00087 *
00088 ***************************************/
00090   void resetDF();
00091 
00092 /***************************************
00093 *
00094 * 
00095 *
00096 ***************************************/
00098   void adjustDF(double inDF);
00099 
00100 /***************************************
00101 *
00102 * 
00103 *
00104 ***************************************/
00106   void resetSquareDFLogICF();
00107 
00108 /***************************************
00109 *
00110 * 
00111 *
00112 ***************************************/
00114   void adjustSquareDFLogICF(double);
00115 
00116 /***************************************
00117 *
00118 * 
00119 *
00120 ***************************************/
00122 
00123   double getMaximumDF()const;
00124 
00125 /***************************************
00126 *
00127 * 
00128 *
00129 ***************************************/
00131   double getDFSquareSum()const;
00132 
00133 /***************************************
00134 *
00135 * 
00136 *
00137 ***************************************/
00139   double getSquareDFLogICFSum()const;
00140 
00141 /***************************************
00142 *
00143 * 
00144 *
00145 ***************************************/
00147   //@name input/output to streams
00149 
00150   bool output(ostream& outStream)const;
00151 
00152 /***************************************
00153 *
00154 * 
00155 *
00156 ***************************************/
00158   bool output()const;
00159 
00160 /***************************************
00161 *
00162 * 
00163 *
00164 ***************************************/
00166   bool input(istream& inStream);
00167 
00168 /***************************************
00169 *
00170 * 
00171 *
00172 ***************************************/
00174   bool input();
00175 
00177 };
00178 
00179 
00180 #endif

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