Xapian: API Documentation: Class List

xapian-core 2.0.0

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2]

N Xapian | The Xapian namespace contains public interfaces for the Xapian library
C Error | All exceptions thrown by Xapian are subclasses of Xapian::Error
C LogicError | The base class for exceptions indicating errors in the program logic
C RuntimeError | The base class for exceptions indicating errors only detectable at runtime
C AssertionError | AssertionError is thrown if a logical assertion inside Xapian fails
C InvalidArgumentError | InvalidArgumentError indicates an invalid parameter value was passed to the API
C InvalidOperationError | InvalidOperationError indicates the API was used in an invalid way
C UnimplementedError | UnimplementedError indicates an attempt to use an unimplemented feature
C DatabaseError | DatabaseError indicates some sort of database related error
C DatabaseCorruptError | DatabaseCorruptError indicates database corruption was detected
C DatabaseCreateError | DatabaseCreateError indicates a failure to create a database
C DatabaseLockError | DatabaseLockError indicates failure to lock a database
C DatabaseModifiedError | DatabaseModifiedError indicates a database was modified
C DatabaseOpeningError | DatabaseOpeningError indicates failure to open a database
C DatabaseVersionError | DatabaseVersionError indicates that a database is in an unsupported format
C DocNotFoundError | Indicates an attempt to access a document not present in the database
C FeatureUnavailableError | Indicates an attempt to use a feature which is unavailable
C InternalError | InternalError indicates a runtime problem of some sort
C NetworkError | Indicates a problem communicating with a remote database
C NetworkTimeoutError | Indicates a timeout expired while communicating with a remote database
C QueryParserError | Indicates a query string can't be parsed
C SerialisationError | Indicates an error in the std::string serialisation of an object
C RangeError | RangeError indicates an attempt to access outside the bounds of a container
C WildcardError | WildcardError indicates an error expanding a wildcarded query
C DatabaseNotFoundError | Indicates an attempt to access a database not present
C DatabaseClosedError | Indicates an attempt to access a closed database
C StemStopper | Stopper subclass which checks for both stemmed and unstemmed stopwords
C DocumentSet | Class representing a set of documents in a cluster
C FreqSource | Base class for TermListGroup Stores and provides terms that are contained in a document and their respective term frequencies
C TermListGroup | A class for construction of termlists which store the terms for a document along with the number of documents it indexes i.e
C PointType | Abstract class representing a point in the VSM
C Point | Class to represent a document as a point in the Vector Space Model
C Centroid | Class to represent cluster centroids in the vector space
C Cluster | Class to represents a Cluster which contains Points and Centroid of the Cluster
C ClusterSet | Class for storing the results returned by the Clusterer
C Similarity | Base class for calculating the similarity between documents
C CosineDistance | Class for calculating the cosine distance between two documents
C Clusterer | Class representing an abstract class for a clusterer to be implemented
C KMeans | Kmeans clusterer: This clusterer implements the K-Means clustering algorithm
C LCDClusterer | LCD clusterer: This clusterer implements the LCD clustering algorithm adapted from Modelling efficient novelty-based search result diversification in metric spaces Gil-Costa et al
C Compactor | Compact a database, or merge and compact several
C Database | An indexed database of documents
C WritableDatabase | This class provides read/write access to a database
C Document | Class representing a document
C Enquire | Querying session
C ESet | Class representing a list of search results
C ESetIterator | Iterator over a Xapian::ESet
C ExpandDecider | Virtual base class for expand decider functor
C ExpandDeciderAnd | ExpandDecider subclass which rejects terms using two ExpandDeciders
C ExpandDeciderFilterTerms | ExpandDecider subclass which rejects terms in a specified list
C ExpandDeciderFilterPrefix | ExpandDecider subclass which restrict terms to a particular prefix
C LatLongCoord | A latitude-longitude coordinate
C LatLongCoordsIterator | An iterator across the values in a LatLongCoords object
C LatLongCoords | A sequence of latitude-longitude coordinates
C LatLongMetric | Base class for calculating distances between two lat/long coordinates
C GreatCircleMetric | Calculate the great-circle distance between two coordinates on a sphere
C LatLongDistancePostingSource | Posting source which returns a weight based on geospatial distance
C LatLongDistanceKeyMaker | KeyMaker subclass which sorts by distance from a latitude/longitude
C KeyMaker | Virtual base class for key making functors
C MultiValueKeyMaker | KeyMaker subclass which combines several values
C MatchDecider | Abstract base class for match deciders
C MatchSpy | Abstract base class for match spies
C ValueCountMatchSpy | Class for counting the frequencies of values in the matching documents
C MSet | Class representing a list of search results
C MSetIterator | Iterator over a Xapian::MSet
C PositionIterator | Class for iterating over term positions
C PostingIterator | Class for iterating over a list of terms
C PostingSource | Base class which provides an "external" source of postings
C ValuePostingSource | A posting source which generates weights from a value slot
C ValueWeightPostingSource | A posting source which reads weights from a value slot
C DecreasingValueWeightPostingSource | Read weights from a value which is known to decrease as docid increases
C ValueMapPostingSource | A posting source which looks up weights in a map using values as the key
C FixedWeightPostingSource | A posting source which returns a fixed weight for all documents
C Query | Class representing a query
C Stopper | Abstract base class for stop-word decision functor
C SimpleStopper | Simple implementation of Stopper class - this will suit most users
C RangeProcessor | Base class for range processors
C DateRangeProcessor | Handle a date range
C NumberRangeProcessor | Handle a number range
C UnitRangeProcessor | Handle a byte unit range
C FieldProcessor | Base class for field processors
C QueryParser | Build a Xapian::Query object from a user query string
C Registry | Registry for user subclasses
C RSet | Class representing a set of documents judged as relevant
C StemImplementation | Class representing a stemming algorithm implementation
C Stem | Class representing a stemming algorithm
C TermGenerator | Parses a piece of text and generate terms
C TermIterator | Class for iterating over a list of terms
C Utf8Iterator | An iterator which returns Unicode character values from a UTF-8 encoded string
C ValueIterator | Class for iterating over document values
C ValueSetMatchDecider | MatchDecider filtering results based on whether document values are in a user-defined set
C Weight | Abstract base class for weighting schemes
C BoolWeight | Class implementing a "boolean" weighting scheme
C TfIdfWeight | Xapian::Weight subclass implementing the tf-idf weighting scheme
C BM25Weight | Xapian::Weight subclass implementing the BM25 probabilistic formula
C BM25PlusWeight | Xapian::Weight subclass implementing the BM25+ probabilistic formula
C TradWeight | Xapian::Weight subclass implementing the traditional probabilistic formula
C InL2Weight | This class implements the InL2 weighting scheme
C IfB2Weight | This class implements the IfB2 weighting scheme
C IneB2Weight | This class implements the IneB2 weighting scheme
C BB2Weight | This class implements the BB2 weighting scheme
C DLHWeight | This class implements the DLH weighting scheme, which is a representative scheme of the Divergence from Randomness Framework by Gianni Amati
C PL2Weight | This class implements the PL2 weighting scheme
C PL2PlusWeight | Xapian::Weight subclass implementing the PL2+ probabilistic formula
C DPHWeight | This class implements the DPH weighting scheme
C LMJMWeight | Language Model weighting with Jelinek-Mercer smoothing
C LMDirichletWeight | Language Model weighting with Dirichlet or Dir+ smoothing
C LMAbsDiscountWeight | Language Model weighting with Absolute Discount smoothing
C LM2StageWeight | Language Model weighting with Two Stage smoothing
C CoordWeight | Xapian::Weight subclass implementing Coordinate Matching
C DiceWeight | Xapian::Weight subclass implementing Dice Coefficient