System documentation of the GNU Image-Finding Tool

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 C_FEATURE_DATA
 CCAccessorCAccessor - an abstract base class for everything accessing a GIFT database
 CCAccessorAdminCAccessorAdmin: The goal of this is to make it possible to have a list containing accessors to all possible collections, without really opening the accessors
 CCAccessorAdminCollectionThis is in fact a collection of collections
 CCAccessorElementQuadruplet of Image-ID, image-URL, thumbnail-URL, feature file name and assorted sorting functions
 CCAccessorFactoryThis is a common abstract base class for all specialised CAccessorFactories
 CCAccessorFactoryContainerThis is destined to hold a number of CAccessorFactories
 CCAccessorImplementationCAccessorImplementation - a base class for everything accessing a GIFT database
 CCAcHierarchyA very simple accessor for hierarchies of images Stored in an XML file
 CCAcIFFileSystemAn accessor to an inverted file
 CCAcInvertedFileAn accessor to an inverted file
 CCAcInvertedFileAbstractionAn accessor to an inverted file
 CCAcURL2FTSThis accessor is a base class for accessors which use an URL2FTS file to implement the interface of the CAccessor base class
 CCAdditionalDocumentInformationAdditional document information (ADI) is information is needed for weighting schemes which take into account properties of whole documents
 CCADIHashCADIHash
 CCAFHierarchyA factory to make inverted Files
 CCAFInvertedFileA factory to make inverted Files
 CCAFPlugin
 CCAFSpecialisedThis template is designed to make easy use of the CAccessorFactory: Tem
 CCAFURL2FTSA factory to make URL2FTS accessors
 CCAlgorithmAn algorithm is a CXMLElement which is linked to a CSessionManager together they are able to build CQuery trees
 CCAlgorithmCollectionThe algorithm collection is kind of a factory for CQuery structures:
 CCArraySelfDestroyPointer
 CCAttributeListSimple class destined to contain attribute-value pairs in an easily accessible fashion
 CCCommunicationHandlerHelper class for use with expat, which also handles the socket stuff
 CCComparisonResultsThe general scheme of implementing a PicHunter like algorithm in GIFT uses the following scheme:
 CCDebuggingMemoryManagerClass for memory management: This class gives you the full control about 1MByte of Memory
 CCDocumentFrequencyElementCDOCUMENTFREQUENCYELEMENT
 CCDocumentFrequencyHash
 CCDocumentFrequencyListA list of Document Frequency Elements (the main part of an inverted file)
 CCDomainSocketA structure that opens/closes a domain socket for a given path and sets the file permissions to 0600
 CCDynamicQueryFactory
 CCI18nTranslatorThis class offers runtime translation of strings
 CCIDRelevanceLevelPairLevel of relevance given by the user to an image (URL)
 CCIDRelevanceLevelPairList
 CCIFBuilderTripletWhen building an inverted file by successive merging we need first to create a file containing triplets of FeatureID, DocumentID and DocumentFrequency
 CCIFListStartThe chunk which starts a list in the inverted file, consisting of FeatureID, CollectionFrequency of the Feature and Number of Elements in the List
 CCInitializedDoubleA class of doubles which are initialized with a zero (unnecessary, it seems)
 CCInvertedFileChunkA class which does all the necessary administrative work for generating inverted files
 CCMagicThis is a simple class for debugging
 CCMapInvertedFileChunkCInvertedFileChunk
 CCMultiServerServer that serves multiple sockets at the same time
 CCMutexThis class offers an abstraction from the locking method used
 CCNoDeleteThe use of this class is to control where an element is destroyed
 CCProcessMessageParametersFunction started by a new thread does not take any parameters except a pointer to void
 CCPropertySheetListTakes the information contained in the list of properties, which is given in the config.mrml file
 CCQHierarchyThis is a simple hierarchy based browser
 CCQInvertedFileThe Query manager for Queries on inverted Files
 CCQMultipleThis is going to be one of our main building blocks
 CCQNBestFullyWeightedCQNBestFullyWeighted
 CCQNEuclideanLengthSquareThe query normalizer for the Best Fully Weighted Method does not work yet (1.12.1998)
 CCQNMaxDocumentFrequency
 CCQNNoNormalizationEmpty normalizer for the trivial case
 CCQNSquareDFLogICFSumCQNSQUAREDFLOGICFSUM
 CCQParallelFIXME: The name WRONGLY suggests that this actually does parallel processing
 CCQueryThe Query manager for Queries on inverted Files
 CCQueryContainerA type helping in the translation from CAlgorithmID to CQuery*
 CCQueryNormalizerFor normalizing weights like in Salton/Buckley we need to now all the features in the query or all the features in a document
 CCQueryParadigmMatcherA class for checking if the content of two query-paradigm tags matches
 CCQueryPlugin
 CCQueryTreeBuilderThis class builds and maintains a query tree
 CCQueryTreeNodeThis class does nothing but wrap the current query interface in a way, that it can be used with CORBA
 CCReaperAuthor of this file: Wolfgang Müller
 CCReaperDistributorThis is a structure for administering reapers that come into action on reception of a sigchild
 CCRelevanceLevelCRELEVANCELEVEL
 CCRelevanceLevelList
 CCRPipeA reaper that closes a pipe after the piping child has exited
 CCScoreBoard
 CCSelfClonePointer
 CCSelfDestroyPointerDestroys the element it points to or not (depending on user's choice)
 CCSessionA class containing a session
 CCSessionManagerThis structure handles the sessions; by this, it encapsulates the current state of the server
 CCSocketThis class takes a unary function
 CCSortByAbsQueryFactor_WFCWeightingFunction: Sort by the absolute value of the query factor
 CCSortByBase_CA
 CCSortByDFTimesLogICF_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
 CCSortByDocumentFrequency_DFECDocumentFrequencyElement:ASCENDING Sort for the document frequency
 CCSortByFeatureID_WFCWeightingFunction: Sort by FeatureID
 CCSortByID_CA
 CCSortByID_CAESort CAccessorElements by their ID
 CCSortByID_DFECDocumentFrequencyElement:Sorting function class for sorting by ID
 CCSortByID_IRLP
 CCSortByName_pAP
 CCSortByQueryFactor_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
 CCSortByThumbnailURL_CAESort CAccessorElements by their ThumbnailURL
 CCSortByURL_CAESort CAccessorElements by their URL
 CCSortByURL_RLSort CAccessorElements by their ID
 CCSortPointers_WF
 CCStaticQueryFactoryA factory for base types of algorithms
 CCStreamPosWrapper for streampos, so we can do increments on it
 CCTCPSocketA structure that opens/closes a TCP socket for a given path and sets the file permissions to 0600
 CCTimeStampGeneratorThis class generates a cui-time-stamp MRML element
 CCWeighterA weighter is a set of WeightingFunction and normalizers which are going to be used together
 CCWeighterFactoryA factory for weighting functions with associated normalizers
 CCWeightingFunctionUniversally usable class for weighting
 CCWeightingFunctionPointerHashA hash of weighting function pointers
 CCWFBestFullyWeightedWeighting function for method 1
 CCWFBestProbabilisticWeighting Function method 2
 CCWFBinaryTermMethod
 CCWFClassicalIDFClassical IDF weight
 CCWFCoordinationLevelCoordination Level, i.e. no weighting
 CCWFProbabilityMethod
 CCWFStandardTFStandard TermFrequency weight
 CCXEVCommunicationA visitor visiting document trees built from the communication
 CCXEVI18nTranslatorA visitor that visits XML elements in order to translate them
 CCXEVTripletListThis visitor converts a CXMLTree into a list of (instruction,name,value) triplets, in order to pass them to Perl or CORBA
 CCXMLElementThis class captures the structure of an XML element
 CCXMLElementBuilderThis class builds an XML element from a string
 CCXMLElementVisitorThis class is designed for visiting XML document trees
 CCXMLHelperClass which helps with xml output
 CCXMLTripletThis structure contains a triplet of (instruction,name,value)
 CCXMLTripletList
 CGIFTExceptionA base class for exceptions thrown by GIFT
 ClTChunkA structure, which is useful to maintain a twice connected list: A list of Chunks and a list of free/occupied chunks
 Cmrml_const
 Cstring_string_mapConvenience typedef
 Cstring_TID_mapConvenience typedef
 CTID_CAccessorElement_mapConvenience typedef
 CTID_string_mapConvenience typedef
 CVEBaseUnknownI dunno (embarrassing), but it is quite late
 CVEConfigurationErrorError in configuration, e.g
 CVEDoubleInsertAn element which is considered bein only once in a set was inserted another time
 CVENotFoundA file or a hash element was not found
 CVEProgrammingMistakeClear programming mistake in this code has been found
 CVEUnknownSessionThe session ID is unknown
 CVEWrongAccessorThe accessor does not fit the chosen algorithm
 CVEWrongAlgorithmThe the algorithm cannot be used with the collection chosen
 CVEWrongBaseTypeThe the algorithm cannot be used with the collection chosen

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