The header of the CIFF file, it happens first in the file and describes how many postings and document details are included. More...

#include <ciff_lin.h>

Public Member Functions
	header ()
	Constructor.

void	text_render (void)
	Dump the value of the header to stdout.

Public Attributes
int32_t	version
	Version number of the CIFF standard.

int32_t	num_postings_lists
	Exactly the number of PostingsList messages that follow the Header.

int32_t	num_docs
	Exactly the number of DocRecord messages that follow the PostingsList messages.

int32_t	total_postings_lists
	The total number of postings lists in the collection; the vocabulary size. This might differ from num_postings_lists, for example, because we only export the postings lists of query terms.

int32_t	total_docs
	The total number of documents in the collection; might differ from num_doc_records for a similar reason as above.

int64_t	total_terms_in_collection
	The total number of terms in the entire collection. This is the sum of all document lengths of all documents in the collection.

double	average_doclength
	The average document length. We store this value explicitly in case the exporting application wants a particular level of precision.

std::string	description
	Description of this index, meant for human consumption. Describing, for example, the exporting application, document processing and tokenization pipeline, etc.

Detailed Description

The header of the CIFF file, it happens first in the file and describes how many postings and document details are included.

The documentation for this class was generated from the following file:

Public Member Functions