strus  0.17
File List
Here is a list of all files with brief descriptions:
[detail level 1234]
\-include
 \-strus
  o-lib
  |o*database_leveldb.hppExported functions of the library implementing the key/value store database interface with leveldb
  |o*queryeval.hppExported functions of the strus query evaluation library
  |o*queryproc.hppExported functions of the strus query processor library (container for all types of functions needed for query evaluation)
  |o*scalarfunc.hppExported functions of the strus scalarfunc library
  |o*statsproc.hppExported functions of the strus statsproc library
  |o*storage.hppExported functions of the strus storage library
  |o*storage_objbuild.hppLibrary with some convenient functions to create storage objects
  |\*storage_prgload_std.hppVarious functions to instantiate strus storage and query evaluation components from configuration programs loaded from source
  o*aclReaderInterface.hppInterface (readonly) for accessing document access control list (read)
  o*attributeReaderInterface.hppInterface (readonly) for accessing document attributes
  o*constants.hppCollection of constants that are shared between components of strus
  o*databaseBackupCursorInterface.hppCursor interface to read the content of a snapshot of the key/value store database for backup
  o*databaseClientInterface.hppClient interface to reading and writing to the key/value store database
  o*databaseCursorInterface.hppCursor interface to iterate on elements of the key/value store database for retrieval
  o*databaseInterface.hppToplevel interface for the key/value store database
  o*databaseOptions.hppStructure for passing read/write options to the the key/value store database
  o*databaseTransactionInterface.hppInterface for a transaction on the key/value store database
  o*documentTermIteratorInterface.hpp
  o*forwardIteratorInterface.hppInterface for accessing the forward index of the storage
  o*functionDescription.hppDescription of a weighting or summarizer function
  o*globalStatistics.hpp
  o*index.hppNumeric types used for local and global indices
  o*invAclIteratorInterface.hppInterface for iterating on the document numbers a user is allowed to see
  o*metaDataReaderInterface.hppInterface for reading elements of the document meta data table in the storage
  o*metaDataRestrictionInstanceInterface.hpp
  o*metaDataRestrictionInterface.hpp
  o*postingIteratorInterface.hppInterface for an iterator on postings (pairs of (d,p) where d is the document number and p the position of a feature)
  o*postingJoinOperatorInterface.hppInterface for a function implementing a join of N posting sets and providing an posting iterator on the result
  o*queryEvalInterface.hppInterface for defining a query evaluation scheme
  o*queryInterface.hppInterface for defining a query and evaluating it
  o*queryProcessorInterface.hppInterface for the container of all types of functions provided for query evaluation
  o*queryResult.hppResult of a query evaluation
  o*resultDocument.hppResult element of the query evaluation
  o*scalarFunctionInstanceInterface.hppInterface for parameterizing a scalar function
  o*scalarFunctionInterface.hppInterface for a scalar function type
  o*scalarFunctionParserInterface.hppInterface for a scalar function parser
  o*statisticsBuilderInterface.hppInterface for a builder for a message to populate statistics (distributed index)
  o*statisticsIteratorInterface.hppInterface for a iterator on messages with statistics
  o*statisticsProcessorInterface.hppInterface for packing/unpacking messages with statistics (distributed index)
  o*statisticsViewerInterface.hppInterface for a viewer of a message with statistics (distributed index)
  o*storageAlterMetaDataTableInterface.hppInterface to declare changes in the meta data table structure of the storage
  o*storageClientInterface.hppClient interface for accessing a storage (read/write)
  o*storageDocumentInterface.hppInterface for contructing a document for inserting it into the storage
  o*storageDocumentUpdateInterface.hppInterface for contructing some document data for an update in the storage
  o*storageDumpInterface.hppInterface for dumping the contents of the storage
  o*storageInterface.hppToplevel interface of a storage
  o*storageObjectBuilderInterface.hppBuilder 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)
  o*storageTransactionInterface.hppInterface for a transaction on the storage
  o*structIteratorInterface.hppInterface for an iterator on structures defined as relations of position info index ranges (directed graph)
  o*summarizationVariable.hppObject 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
  o*summarizerFunctionContextInterface.hppInterface for the context data of a processed summarizer
  o*summarizerFunctionInstanceInterface.hppInterface for a parameterized summarizer function instance
  o*summarizerFunctionInterface.hppInterface for a summarizer function type
  o*summaryElement.hppElement of summary (result of summarization)
  o*termStatistics.hpp
  o*termStatisticsChange.hppTerm statistics change (for a distributed search index)
  o*valueIteratorInterface.hppInterface for introspection of string values stored in the storage
  o*vectorQueryResult.hppResult of a vector similarity search
  o*vectorStorageClientInterface.hpp
  o*vectorStorageDumpInterface.hppInterface for dumping the contents of a vector storage
  o*vectorStorageInterface.hpp
  o*vectorStorageTransactionInterface.hpp
  o*weightedDocument.hppWeighted document of the query evaluation (result document without attributes)
  o*weightingFunctionContextInterface.hppInterface for the context data of a processed weighting function
  o*weightingFunctionInstanceInterface.hppInterface for a parameterized weighting function instance
  o*weightingFunctionInterface.hppInterface for a weighting function type
  \*wordVector.hppVector type used for word embedding vector calculations