File List

Here is a list of all files with brief descriptions:

[detail level 1234]

include
strus
lib
database_leveldb.hpp	Exported functions of the library implementing the key/value store database interface with leveldb
queryeval.hpp	Exported functions of the strus query evaluation library
queryproc.hpp	Exported functions of the strus query processor library (container for all types of functions needed for query evaluation)
scalarfunc.hpp	Exported functions of the strus scalarfunc library
statsproc.hpp	Exported functions of the strus statsproc library
storage.hpp	Exported functions of the strus storage library
storage_objbuild.hpp	Library with some convenient functions to create storage objects
storage_prgload_std.hpp	Various functions to instantiate strus storage and query evaluation components from configuration programs loaded from source
aclReaderInterface.hpp	Interface (readonly) for accessing document access control list (read)
attributeReaderInterface.hpp	Interface (readonly) for accessing document attributes
constants.hpp	Collection of constants that are shared between components of strus
databaseBackupCursorInterface.hpp	Cursor interface to read the content of a snapshot of the key/value store database for backup
databaseClientInterface.hpp	Client interface to reading and writing to the key/value store database
databaseCursorInterface.hpp	Cursor interface to iterate on elements of the key/value store database for retrieval
databaseInterface.hpp	Toplevel interface for the key/value store database
databaseOptions.hpp	Structure for passing read/write options to the the key/value store database
databaseTransactionInterface.hpp	Interface for a transaction on the key/value store database
documentTermIteratorInterface.hpp
forwardIteratorInterface.hpp	Interface for accessing the forward index of the storage
functionDescription.hpp	Description of a weighting or summarizer function
globalStatistics.hpp
index.hpp	Numeric types used for local and global indices
invAclIteratorInterface.hpp	Interface for iterating on the document numbers a user is allowed to see
metaDataReaderInterface.hpp	Interface for reading elements of the document meta data table in the storage
metaDataRestrictionInstanceInterface.hpp
metaDataRestrictionInterface.hpp
postingIteratorInterface.hpp	Interface for an iterator on postings (pairs of (d,p) where d is the document number and p the position of a feature)
postingJoinOperatorInterface.hpp	Interface for a function implementing a join of N posting sets and providing an posting iterator on the result
queryEvalInterface.hpp	Interface for defining a query evaluation scheme
queryInterface.hpp	Interface for defining a query and evaluating it
queryProcessorInterface.hpp	Interface for the container of all types of functions provided for query evaluation
queryResult.hpp	Result of a query evaluation
resultDocument.hpp	Result element of the query evaluation
scalarFunctionInstanceInterface.hpp	Interface for parameterizing a scalar function
scalarFunctionInterface.hpp	Interface for a scalar function type
scalarFunctionParserInterface.hpp	Interface for a scalar function parser
statisticsBuilderInterface.hpp	Interface for a builder for a message to populate statistics (distributed index)
statisticsIteratorInterface.hpp	Interface for a iterator on messages with statistics
statisticsProcessorInterface.hpp	Interface for packing/unpacking messages with statistics (distributed index)
statisticsViewerInterface.hpp	Interface for a viewer of a message with statistics (distributed index)
storageAlterMetaDataTableInterface.hpp	Interface to declare changes in the meta data table structure of the storage
storageClientInterface.hpp	Client interface for accessing a storage (read/write)
storageDocumentInterface.hpp	Interface for contructing a document for inserting it into the storage
storageDocumentUpdateInterface.hpp	Interface for contructing some document data for an update in the storage
storageDumpInterface.hpp	Interface for dumping the contents of the storage
storageInterface.hpp	Toplevel interface of a storage
storageObjectBuilderInterface.hpp	Builder object for all toplevel interfaces related to the storage. Used by components acting as proxy (calling strus with RPC) or by components that build the storage universe from external components (loading storage objects from dynamically loadable modules)
storageTransactionInterface.hpp	Interface for a transaction on the storage
structIteratorInterface.hpp	Interface for an iterator on structures defined as relations of position info index ranges (directed graph)
summarizationVariable.hpp	Object describing a variable associated to a set of postings. This variable can be used by summarizers to extract features from the forward index of matching documents
summarizerFunctionContextInterface.hpp	Interface for the context data of a processed summarizer
summarizerFunctionInstanceInterface.hpp	Interface for a parameterized summarizer function instance
summarizerFunctionInterface.hpp	Interface for a summarizer function type
summaryElement.hpp	Element of summary (result of summarization)
termStatistics.hpp
termStatisticsChange.hpp	Term statistics change (for a distributed search index)
valueIteratorInterface.hpp	Interface for introspection of string values stored in the storage
vectorQueryResult.hpp	Result of a vector similarity search
vectorStorageClientInterface.hpp
vectorStorageDumpInterface.hpp	Interface for dumping the contents of a vector storage
vectorStorageInterface.hpp
vectorStorageTransactionInterface.hpp
weightedDocument.hpp	Weighted document of the query evaluation (result document without attributes)
weightingFunctionContextInterface.hpp	Interface for the context data of a processed weighting function
weightingFunctionInstanceInterface.hpp	Interface for a parameterized weighting function instance
weightingFunctionInterface.hpp	Interface for a weighting function type
wordVector.hpp	Vector type used for word embedding vector calculations