A postings list with a term, df, cf, and postings list of <d,tf> pairs. More...

#include <ciff_lin.h>

Collaboration diagram for JASS::ciff_lin::postings_list:

Public Member Functions
void	clear (void)
	removes all content from the postings list

Static Public Member Functions
static error_code	get_next_postings (postings_list &into, const uint8_t &stream, const uint8_t stream_end)
	read a full postings list (inclding term, df, cf, etc.) from a protobuf encoded stream More...

Public Attributes
slice	term
	The term as a <pointer,length> tuple.

uint64_t	document_frequency
	The number of documents containing the term.

uint64_t	collection_frequency
	The number of times the term occurs in the collection.

std::vector< posting >	postings
	The postings list, a vector of <d,tf> tuples.

Static Private Member Functions
static error_code	get_next_postings_pair (posting &into, const uint8_t &stream, const uint8_t stream_end)
	read a <d,tf> pair from a protobuf encoded stream More...

Detailed Description

A postings list with a term, df, cf, and postings list of <d,tf> pairs.

Member Function Documentation

static error_code JASS::ciff_lin::postings_list::get_next_postings	(	postings_list &	into,
		const uint8_t *&	stream,
		const uint8_t *	stream_end
	)

inlinestatic

read a full postings list (inclding term, df, cf, etc.) from a protobuf encoded stream

Parameters

into	[out] The postings list being read
stream	[in, out] A reference to a pointer to the start of the value, points to the next byte on return.
stream_end	[in] A pointer to the byte after the last byte in the stream.

static error_code JASS::ciff_lin::postings_list::get_next_postings_pair	(	posting &	into,
		const uint8_t *&	stream,
		const uint8_t *	stream_end
	)

inlinestaticprivate

read a <d,tf> pair from a protobuf encoded stream

Parameters

into	[out] The posting pair being read
stream	[in, out] A reference to a pointer to the start of the value, points to the next byte on return.
stream_end	[in] A pointer to the byte after the last byte in the stream.

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