System documentation of the GNU Image-Finding Tool

Main Page | Class Hierarchy | Alphabetical List | Compound List | File List | Compound 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     This program is free software; you can redistribute it and/or modify
00009     it under the terms of the GNU General Public License as published by
00010     the Free Software Foundation; either version 2 of the License, or
00011     (at your option) any later version.
00012 
00013     This program is distributed in the hope that it will be useful,
00014     but WITHOUT ANY WARRANTY; without even the implied warranty of
00015     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016     GNU General Public License for more details.
00017 
00018     You should have received a copy of the GNU General Public License
00019     along with this program; if not, write to the Free Software
00020     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021 
00022 */
00023 /***************************************
00024 *
00025 * CADDITIONALDOCUMENTINFORMATION
00026 *
00027 ****************************************
00028 *
00029 * modification history:
00030 *
00031 * HM 090399 created the documentation
00032 *
00033 ****************************************
00034 *
00035 * compiler defines used:
00036 *
00037 *
00038 ****************************************/
00039 #ifndef _CADDITIONALDOCUMENTINFORMATION
00040 #define _CADDITIONALDOCUMENTINFORMATION
00041 #include "libGIFTAcInvertedFile/include/uses-declarations.h"
00042 #include "libMRML/include/TID.h"
00043 #include <string>
00044 #include <functional>
00045 #include <iostream>
00046 #include <fstream>
00054 class CAdditionalDocumentInformation{
00055 protected:
00057   string mFileNameBase;
00059   double mMaximumDF;
00061   double mDFSquareSum;
00063   double mSquareDFLogICFSum;
00064 
00065 public:
00066 /***************************************
00067 *
00068 * 
00069 *
00070 ***************************************/
00072   CAdditionalDocumentInformation(const string& inName="N.N.");
00073   
00074 /***************************************
00075 *
00076 * 
00077 *
00078 ***************************************/
00080   void setFileNameBase(const string& inName);
00081 
00082 /***************************************
00083 *
00084 * 
00085 *
00086 ***************************************/
00088   void resetDF();
00089 
00090 /***************************************
00091 *
00092 * 
00093 *
00094 ***************************************/
00096   void adjustDF(double inDF);
00097 
00098 /***************************************
00099 *
00100 * 
00101 *
00102 ***************************************/
00104   void resetSquareDFLogICF();
00105 
00106 /***************************************
00107 *
00108 * 
00109 *
00110 ***************************************/
00112   void adjustSquareDFLogICF(double);
00113 
00114 /***************************************
00115 *
00116 * 
00117 *
00118 ***************************************/
00120 
00121   double getMaximumDF()const;
00122 
00123 /***************************************
00124 *
00125 * 
00126 *
00127 ***************************************/
00129   double getDFSquareSum()const;
00130 
00131 /***************************************
00132 *
00133 * 
00134 *
00135 ***************************************/
00137   double getSquareDFLogICFSum()const;
00138 
00139 /***************************************
00140 *
00141 * 
00142 *
00143 ***************************************/
00145   //@name input/output to streams
00147 
00148   bool output(ostream& outStream)const;
00149 
00150 /***************************************
00151 *
00152 * 
00153 *
00154 ***************************************/
00156   bool output()const;
00157 
00158 /***************************************
00159 *
00160 * 
00161 *
00162 ***************************************/
00164   bool input(istream& inStream);
00165 
00166 /***************************************
00167 *
00168 * 
00169 *
00170 ***************************************/
00172   bool input();
00173 
00175 };
00176 
00177 
00178 #endif

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