System documentation of the GNU Image-Finding Tool

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
_FEATURE_DATA
CAccessorCAccessor - an abstract base class for everything accessing a GIFT database
CAccessorAdminCAccessorAdmin: The goal of this is to make it possible to have a list containing accessors to all possible collections, without really opening the accessors
CAccessorAdminCollectionThis is in fact a collection of collections
CAccessorElementQuadruplet of Image-ID, image-URL, thumbnail-URL, feature file name and assorted sorting functions
CAccessorFactoryThis is a common abstract base class for all specialised CAccessorFactories
CAccessorFactoryContainerThis is destined to hold a number of CAccessorFactories
CAccessorImplementationCAccessorImplementation - a base class for everything accessing a GIFT database
CAcHierarchyA very simple accessor for hierarchies of images Stored in an XML file
CAcIFFileSystemAn accessor to an inverted file
CAcInvertedFileAn accessor to an inverted file
CAcInvertedFileAbstractionAn accessor to an inverted file
CAcURL2FTSThis accessor is a base class for accessors which use an URL2FTS file to implement the interface of the CAccessor base class
CAdditionalDocumentInformationAdditional document information (ADI) is information is needed for weighting schemes which take into account properties of whole documents
CADIHashCADIHash
CAFHierarchyA factory to make inverted Files
CAFInvertedFileA factory to make inverted Files
CAFPlugin
CAFSpecialised< TAccessorSubType, TName >This template is designed to make easy use of the CAccessorFactory: Tem
CAFURL2FTSA factory to make URL2FTS accessors
CAlgorithmAn algorithm is a CXMLElement which is linked to a CSessionManager together they are able to build CQuery trees
CAlgorithmCollectionThe algorithm collection is kind of a factory for CQuery structures:
CArraySelfDestroyPointer< T >
CAttributeListSimple class destined to contain attribute-value pairs in an easily accessible fashion
CCommunicationHandlerHelper class for use with expat, which also handles the socket stuff
CComparisonResultsThe general scheme of implementing a PicHunter like algorithm in GIFT uses the following scheme:
CAccessorAdminCollection::CContentThis is mainly a map from string to accessor proxy we would like to destroy this in a decent way
CAccessorAdmin::CContentElementContent is pointer to a factory, a pointer to the actual Accessor (if already made) and the open-close-counter
CDebuggingMemoryManagerClass for memory management: This class gives you the full control about 1MByte of Memory
CDocumentFrequencyElementCDOCUMENTFREQUENCYELEMENT
CDocumentFrequencyHash
CDocumentFrequencyListA list of Document Frequency Elements (the main part of an inverted file)
CDomainSocketA structure that opens/closes a domain socket for a given path and sets the file permissions to 0600
CDynamicQueryFactory
CI18nTranslatorThis class offers runtime translation of strings
CIDRelevanceLevelPairLevel of relevance given by the user to an image (URL)
CIDRelevanceLevelPairList
CIFBuilderTripletWhen building an inverted file by successive merging we need first to create a file containing triplets of FeatureID, DocumentID and DocumentFrequency
CIFListStartThe chunk which starts a list in the inverted file, consisting of FeatureID, CollectionFrequency of the Feature and Number of Elements in the List
CInitializedDoubleA class of doubles which are initialized with a zero (unnecessary, it seems)
CInvertedFileChunkA class which does all the necessary administrative work for generating inverted files
CMagicThis is a simple class for debugging
CMapInvertedFileChunkCInvertedFileChunk
CMultiServerServer that serves multiple sockets at the same time
CMutexThis class offers an abstraction from the locking method used
CNoDeleteThe use of this class is to control where an element is destroyed
CProcessMessageParametersFunction started by a new thread does not take any parameters except a pointer to void
CPropertySheetListTakes the information contained in the list of properties, which is given in the config.mrml file
CQHierarchyThis is a simple hierarchy based browser
CQInvertedFileThe Query manager for Queries on inverted Files
CQMultipleThis is going to be one of our main building blocks
CQNBestFullyWeightedCQNBestFullyWeighted
CQNEuclideanLengthSquareThe query normalizer for the Best Fully Weighted Method does not work yet (1.12.1998)
CQNMaxDocumentFrequency
CQNNoNormalizationEmpty normalizer for the trivial case
CQNSquareDFLogICFSumCQNSQUAREDFLOGICFSUM
CQParallelFIXME: The name WRONGLY suggests that this actually does parallel processing
CQueryThe Query manager for Queries on inverted Files
CQueryContainerA type helping in the translation from CAlgorithmID to CQuery*
CQueryNormalizerFor normalizing weights like in Salton/Buckley we need to now all the features in the query or all the features in a document
CQueryParadigmMatcherA class for checking if the content of two query-paradigm tags matches
CQueryPlugin
CQueryTreeBuilderThis class builds and maintains a query tree
CQueryTreeNodeThis class does nothing but wrap the current query interface in a way, that it can be used with CORBA
CReaperAuthor of this file: Wolfgang Müller
CReaperDistributorThis is a structure for administering reapers that come into action on reception of a sigchild
CRelevanceLevelCRELEVANCELEVEL
CRelevanceLevelList
CRPipeA reaper that closes a pipe after the piping child has exited
CScoreBoard
CSelfClonePointer< T >
CSelfDestroyPointer< T >Destroys the element it points to or not (depending on user's choice)
CSocket::CServeFunctionThis is the function that's called when serving
CSessionA class containing a session
CSessionManagerThis structure handles the sessions; by this, it encapsulates the current state of the server
CSocketThis class takes a unary function
CSortByAbsQueryFactor_WFCWeightingFunction: Sort by the absolute value of the query factor
CSortByBase_CA
CSortByDFTimesLogICF_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
CSortByDocumentFrequency_DFECDocumentFrequencyElement:ASCENDING Sort for the document frequency
CSortByFeatureID_WFCWeightingFunction: Sort by FeatureID
CSortByID_CA
CSortByID_CAESort CAccessorElements by their ID
CSortByID_DFECDocumentFrequencyElement:Sorting function class for sorting by ID
CSortByID_IRLP
CSortByName_pAP
CSortByQueryFactor_WFCWeightingFunction: Sort by DocumentFrequency/CollectionFrequency
CSortByThumbnailURL_CAESort CAccessorElements by their ThumbnailURL
CSortByURL_CAESort CAccessorElements by their URL
CSortByURL_RLSort CAccessorElements by their ID
CSortPointers_WF< CSortOp >
CStaticQueryFactoryA factory for base types of algorithms
CStreamPos< T >Wrapper for streampos, so we can do increments on it
CTCPSocketA structure that opens/closes a TCP socket for a given path and sets the file permissions to 0600
CTimeStampGeneratorThis class generates a cui-time-stamp MRML element
CWeighterA weighter is a set of WeightingFunction and normalizers which are going to be used together
CWeighterFactoryA factory for weighting functions with associated normalizers
CWeightingFunctionUniversally usable class for weighting
CWeightingFunctionPointerHashA hash of weighting function pointers
CWFBestFullyWeightedWeighting function for method 1
CWFBestProbabilisticWeighting Function method 2
CWFBinaryTermMethod
CWFClassicalIDFClassical IDF weight
CWFCoordinationLevelCoordination Level, i.e. no weighting
CWFProbabilityMethod
CWFStandardTFStandard TermFrequency weight
CXEVCommunicationA visitor visiting document trees built from the communication
CXEVI18nTranslatorA visitor that visits XML elements in order to translate them
CXEVTripletListThis visitor converts a CXMLTree into a list of (instruction,name,value) triplets, in order to pass them to Perl or CORBA
CXMLElementThis class captures the structure of an XML element
CXMLElementBuilderThis class builds an XML element from a string
CXMLElementVisitorThis class is designed for visiting XML document trees
CXMLHelperClass which helps with xml output
CXMLTripletThis structure contains a triplet of (instruction,name,value)
CXMLTripletList
GIFTExceptionA base class for exceptions thrown by GIFT
CQuery::lCChildA child of this
lTChunkA structure, which is useful to maintain a twice connected list: A list of Chunks and a list of free/occupied chunks
mrml_const
CQInvertedFile::parameterPruningTypeParameters for scoreboard pruning
string_string_mapConvenience typedef
string_TID_mapConvenience typedef
TID_CAccessorElement_mapConvenience typedef
TID_string_mapConvenience typedef
VEBaseUnknownI dunno (embarrassing), but it is quite late
VEConfigurationErrorError in configuration, e.g
VEDoubleInsertAn element which is considered bein only once in a set was inserted another time
VENotFoundA file or a hash element was not found
VEProgrammingMistakeClear programming mistake in this code has been found
VEUnknownSessionThe session ID is unknown
VEWrongAccessorThe accessor does not fit the chosen algorithm
VEWrongAlgorithmThe the algorithm cannot be used with the collection chosen
VEWrongBaseTypeThe the algorithm cannot be used with the collection chosen

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