System documentation of the GNU Image-Finding Tool

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oC_FEATURE_DATA
oCCAccessorCAccessor - an abstract base class for everything accessing a GIFT database
oCCAccessorAdminCAccessorAdmin: The goal of this is to make it possible to have a list containing accessors to all possible collections, without really opening the accessors
oCCAccessorAdminCollectionThis is in fact a collection of collections
oCCAccessorElementQuadruplet of Image-ID, image-URL, thumbnail-URL, feature file name and assorted sorting functions
oCCAccessorFactoryThis is a common abstract base class for all specialised CAccessorFactories
oCCAccessorFactoryContainerThis is destined to hold a number of CAccessorFactories
oCCAccessorImplementationCAccessorImplementation - a base class for everything accessing a GIFT database
oCCAcHierarchyA very simple accessor for hierarchies of images Stored in an XML file
oCCAcIFFileSystemAn accessor to an inverted file
oCCAcInvertedFileAn accessor to an inverted file
oCCAcInvertedFileAbstractionAn accessor to an inverted file
oCCAcURL2FTSThis accessor is a base class for accessors which use an URL2FTS file to implement the interface of the CAccessor base class
oCCAdditionalDocumentInformationAdditional document information (ADI) is information is needed for weighting schemes which take into account properties of whole documents
oCCADIHashCADIHash
oCCAFHierarchyA factory to make inverted Files
oCCAFInvertedFileA factory to make inverted Files
oCCAFPlugin
oCCAFSpecialisedThis template is designed to make easy use of the CAccessorFactory: Tem
oCCAFURL2FTSA factory to make URL2FTS accessors
oCCAlgorithmAn algorithm is a CXMLElement which is linked to a CSessionManager together they are able to build CQuery trees
oCCAlgorithmCollectionThe algorithm collection is kind of a factory for CQuery structures:
oCCArraySelfDestroyPointer
oCCAttributeListSimple class destined to contain attribute-value pairs in an easily accessible fashion
oCCCommunicationHandlerHelper class for use with expat, which also handles the socket stuff
oCCComparisonResultsThe general scheme of implementing a PicHunter like algorithm in GIFT uses the following scheme:
oCCDebuggingMemoryManagerClass for memory management: This class gives you the full control about 1MByte of Memory
oCCDocumentFrequencyElementCDOCUMENTFREQUENCYELEMENT
oCCDocumentFrequencyHash
oCCDocumentFrequencyListA list of Document Frequency Elements (the main part of an inverted file)
oCCDomainSocketA structure that opens/closes a domain socket for a given path and sets the file permissions to 0600
oCCDynamicQueryFactory
oCCI18nTranslatorThis class offers runtime translation of strings
oCCIDRelevanceLevelPairLevel of relevance given by the user to an image (URL)
oCCIDRelevanceLevelPairList
oCCIFBuilderTripletWhen building an inverted file by successive merging we need first to create a file containing triplets of FeatureID, DocumentID and DocumentFrequency
oCCIFListStartThe chunk which starts a list in the inverted file, consisting of FeatureID, CollectionFrequency of the Feature and Number of Elements in the List
oCCInitializedDoubleA class of doubles which are initialized with a zero (unnecessary, it seems)
oCCInvertedFileChunkA class which does all the necessary administrative work for generating inverted files
oCCMagicThis is a simple class for debugging
oCCMapInvertedFileChunkCInvertedFileChunk
oCCMultiServerServer that serves multiple sockets at the same time
oCCMutexThis class offers an abstraction from the locking method used
oCCNoDeleteThe use of this class is to control where an element is destroyed
oCCProcessMessageParametersFunction started by a new thread does not take any parameters except a pointer to void
oCCPropertySheetListTakes the information contained in the list of properties, which is given in the config.mrml file
oCCQHierarchyThis is a simple hierarchy based browser
oCCQInvertedFileThe Query manager for Queries on inverted Files
oCCQMultipleThis is going to be one of our main building blocks
oCCQNBestFullyWeightedCQNBestFullyWeighted
oCCQNEuclideanLengthSquareThe query normalizer for the Best Fully Weighted Method does not work yet (1.12.1998)
oCCQNMaxDocumentFrequency
oCCQNNoNormalizationEmpty normalizer for the trivial case
oCCQNSquareDFLogICFSumCQNSQUAREDFLOGICFSUM
oCCQParallelFIXME: The name WRONGLY suggests that this actually does parallel processing
oCCQueryThe Query manager for Queries on inverted Files
oCCQueryContainerA type helping in the translation from CAlgorithmID to CQuery*
oCCQueryNormalizerFor normalizing weights like in Salton/Buckley we need to now all the features in the query or all the features in a document
oCCQueryParadigmMatcherA class for checking if the content of two query-paradigm tags matches
oCCQueryPlugin
oCCQueryTreeBuilderThis class builds and maintains a query tree
oCCQueryTreeNodeThis class does nothing but wrap the current query interface in a way, that it can be used with CORBA
oCCReaperAuthor of this file: Wolfgang Müller
oCCReaperDistributorThis is a structure for administering reapers that come into action on reception of a sigchild
oCCRelevanceLevelCRELEVANCELEVEL
oCCRelevanceLevelList
oCCRPipeA reaper that closes a pipe after the piping child has exited
oCCScoreBoard
oCCSelfClonePointer
oCCSelfDestroyPointerDestroys the element it points to or not (depending on user's choice)
oCCSessionA class containing a session
oCCSessionManagerThis structure handles the sessions; by this, it encapsulates the current state of the server
oCCSocketThis class takes a unary function
oCCSortByAbsQueryFactor_WFCWeightingFunction: Sort by the absolute value of the query factor
oCCSortByBase_CA
oCCSortByDFTimesLogICF_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
oCCSortByDocumentFrequency_DFECDocumentFrequencyElement:ASCENDING Sort for the document frequency
oCCSortByFeatureID_WFCWeightingFunction: Sort by FeatureID
oCCSortByID_CA
oCCSortByID_CAESort CAccessorElements by their ID
oCCSortByID_DFECDocumentFrequencyElement:Sorting function class for sorting by ID
oCCSortByID_IRLP
oCCSortByName_pAP
oCCSortByQueryFactor_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
oCCSortByThumbnailURL_CAESort CAccessorElements by their ThumbnailURL
oCCSortByURL_CAESort CAccessorElements by their URL
oCCSortByURL_RLSort CAccessorElements by their ID
oCCSortPointers_WF
oCCStaticQueryFactoryA factory for base types of algorithms
oCCStreamPosWrapper for streampos, so we can do increments on it
oCCTCPSocketA structure that opens/closes a TCP socket for a given path and sets the file permissions to 0600
oCCTimeStampGeneratorThis class generates a cui-time-stamp MRML element
oCCWeighterA weighter is a set of WeightingFunction and normalizers which are going to be used together
oCCWeighterFactoryA factory for weighting functions with associated normalizers
oCCWeightingFunctionUniversally usable class for weighting
oCCWeightingFunctionPointerHashA hash of weighting function pointers
oCCWFBestFullyWeightedWeighting function for method 1
oCCWFBestProbabilisticWeighting Function method 2
oCCWFBinaryTermMethod
oCCWFClassicalIDFClassical IDF weight
oCCWFCoordinationLevelCoordination Level, i.e. no weighting
oCCWFProbabilityMethod
oCCWFStandardTFStandard TermFrequency weight
oCCXEVCommunicationA visitor visiting document trees built from the communication
oCCXEVI18nTranslatorA visitor that visits XML elements in order to translate them
oCCXEVTripletListThis visitor converts a CXMLTree into a list of (instruction,name,value) triplets, in order to pass them to Perl or CORBA
oCCXMLElementThis class captures the structure of an XML element
oCCXMLElementBuilderThis class builds an XML element from a string
oCCXMLElementVisitorThis class is designed for visiting XML document trees
oCCXMLHelperClass which helps with xml output
oCCXMLTripletThis structure contains a triplet of (instruction,name,value)
oCCXMLTripletList
oCGIFTExceptionA base class for exceptions thrown by GIFT
oClTChunkA structure, which is useful to maintain a twice connected list: A list of Chunks and a list of free/occupied chunks
oCmrml_const
oCstring_string_mapConvenience typedef
oCstring_TID_mapConvenience typedef
oCTID_CAccessorElement_mapConvenience typedef
oCTID_string_mapConvenience typedef
oCVEBaseUnknownI dunno (embarrassing), but it is quite late
oCVEConfigurationErrorError in configuration, e.g
oCVEDoubleInsertAn element which is considered bein only once in a set was inserted another time
oCVENotFoundA file or a hash element was not found
oCVEProgrammingMistakeClear programming mistake in this code has been found
oCVEUnknownSessionThe session ID is unknown
oCVEWrongAccessorThe accessor does not fit the chosen algorithm
oCVEWrongAlgorithmThe 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