source Directory Reference

Files
file	accumulator_2d.h [code]
	Store the accumulators in a 2D array as originally used in ATIRE.
file	accumulator_block_max.h [code]
	Store the accumulators in a block-max array as originally used in IOQP.
file	accumulator_simple.h [code]
	Store the accumulators in a simple array that gets zeroed at the start of each query.
file	allocator.h [code]
	Base class for different allocators.
file	allocator_cpp.h [code]
	C++11 allocator class that uses a C allocator. See here: https://msdn.microsoft.com/en-us/library/aa985953.aspx.
file	allocator_memory.h [code]
	Simple block-allocator that internally uses a single non-growable fixed-sized buffer.
file	allocator_pool.h [code]
	Simple block-allocator that internally allocates a large chunk then allocates smaller blocks from this larger block.
file	ascii.h [code]
	fast locale-ignoring version of the C runtime library ctype methods for plain 7-bit ASCII.
file	asserts.h [code]
	replacement for the C runtime library assert that also works in release.
file	beap.h [code]
	Bi-parental heap over a fixed length array (min-beap).
file	binary_tree.h [code]
	Thread-safe binary tree.
file	bitstream.h [code]
	Long bitstreams (push and pull from a long bitstring).
file	bitstring.h [code]
	Long bitstrings.
file	channel.h [code]
	Input and output channels so that JASS i/o is device independant.
file	channel_buffer.h [code]
	Input (not output) channel from a block of memory.
file	channel_file.h [code]
	Input and output channel for disk files and stdin / stdout.
file	channel_trec.h [code]
	Input (not output) channel for turning TREC fopic files into JASS queries.
file	checksum.h [code]
	Checksum routines.
file	commandline.h [code]
	Command line processor in a single stand-alone header file.
file	compress_general.h [code]
	General purpose compression.
file	compress_general_zlib.h [code]
	General purpose compression using zlib (deflate)
file	compress_general_zstd.h [code]
	General purpose compression using the zstd version of deflate.
file	compress_integer.h [code]
	Compression codexes for integer sequences.
file	compress_integer_all.h [code]
	A container holding all the integer compression schemes known by JASS.
file	compress_integer_bitpack.h [code]
	Base class for bit-packing into sequences of 32-bit words.
file	compress_integer_bitpack_128.h [code]
	Pack fixed-width integers into a 128-bit SIMD register.
file	compress_integer_bitpack_256.h [code]
	Pack fixed-width integers into a 256-bit SIMD register.
file	compress_integer_bitpack_32_reduced.h [code]
	Pack fixed-width integers into a 32-bit register.
file	compress_integer_bitpack_64.h [code]
	Pack fixed-width integers into a 64-bit register.
file	compress_integer_carry_8b.h [code]
	Carry-8b Compression.
file	compress_integer_carryover_12.h [code]
	Carryover-12 Compression.
file	compress_integer_elias_delta.h [code]
	Elias delta compression.
file	compress_integer_elias_delta_bitwise.h [code]
	Elias delta encoding using bit-by-bit encoding and decoding (slow)
file	compress_integer_elias_delta_simd.h [code]
	Elias delta based SIMD compression.
file	compress_integer_elias_gamma.h [code]
	Elias gamma compression.
file	compress_integer_elias_gamma_bitwise.h [code]
	Elias gamma encoding using bit-by-bit encoding and decoding (slow)
file	compress_integer_elias_gamma_simd.h [code]
	Pack 32-bit integers into 512-bit SIMD words using elias gamma encoding.
file	compress_integer_elias_gamma_simd_vb.h [code]
	Pack 32-bit integers into 512-bit SIMD words using elias gamma encoding - with VByte on short lists.
file	compress_integer_lyck_16.h [code]
	Pack (small) integers into 2-bit pairs (lycks) and then into a 16-bit word.
file	compress_integer_none.h [code]
	The null compressor for integer sequences (i.e. just copy, don't compress).
file	compress_integer_nybble_8.h [code]
	Pack (small) integers into nybbles and then into a byte.
file	compress_integer_qmx_improved.h [code]
	Improved QMX Compression.
file	compress_integer_qmx_jass_v1.h [code]
	QMX version compatible with JASS v1.
file	compress_integer_qmx_original.h [code]
	QMX Compression.
file	compress_integer_relative_10.h [code]
	Relative-10 Compression.
file	compress_integer_simple_16.h [code]
	Simple-16 Compression.
file	compress_integer_simple_16_packed.h [code]
	Optimally packed Simple-16 Compression.
file	compress_integer_simple_8b.h [code]
	Simple-8b Compression.
file	compress_integer_simple_8b_packed.h [code]
	Optimally packed Simple-8b Compression.
file	compress_integer_simple_9.h [code]
	Simple-9 Compression.
file	compress_integer_simple_9_packed.h [code]
	Optimally packed Simple-9.
file	compress_integer_stream_vbyte.h [code]
	Interface to Lemire's Stream VByte source code.
file	compress_integer_variable_byte.h [code]
	Variable byte compression for integer sequences.
file	deserialised_jass_v1.h [code]
	Load and deserialise a JASS v1 index.
file	deserialised_jass_v2.h [code]
	Load and deserialise a JASS v2 index.
file	document.h [code]
	A document withing the indexing pipeline.
file	document_id.h [code]
	A type defining a document id (was compress_integer::integer)
file	dynamic_array.h [code]
	Thread-safe grow-only dynamic array using the thread-safe allocator.
file	evaluate.h [code]
	Base class for metrics (precision, recall, MAP, etc).
file	evaluate_buying_power.h [code]
	Compute the buying power (bp) of the results list.
file	evaluate_buying_power4k.h [code]
	Compute the buying power for K items (bp4K) in the results list.
file	evaluate_buying_power_normalized_discounted_cumulative_gain.h [code]
	Compute the Price Based Normalized Discounted Cumulative Gain of the results list.
file	evaluate_cheapest_precision.h [code]
	Compute the precision against the k cheapest items.
file	evaluate_expected_search_length.h [code]
	Compute the Expected Search Length of the results list.
file	evaluate_f.h [code]
	Compute the F measure of precision and recall.
file	evaluate_map.h [code]
	Compute the mean average precision (MAP) of the results list.
file	evaluate_mean_reciprocal_rank.h [code]
	Compute the mean reciprocal rank of the results list.
file	evaluate_mean_reciprocal_rank4k.h [code]
	Compute the mean reciprocal rank of the mean position of k relevant results (the mean of the RR of the top k items)
file	evaluate_precision.h [code]
	Compute the precision of the results list.
file	evaluate_price_based_normalized_discounted_cumulative_gain.h [code]
	Compute the Price Based Normalized Discounted Cumulative Gain of the results list.
file	evaluate_rank_biased_precision.h [code]
	Compute the Rank Biased Precision (RBP) of the results list.
file	evaluate_recall.h [code]
	Compute the recall of the results list.
file	evaluate_relevant_returned.h [code]
	Compute the precision number of results in the results list that are relevant.
file	evaluate_selling_power.h [code]
	Compute the sellng power of the results list.
file	exception_done.h [code]
	Exception to indicate processing has finished and should be early aborted at a greater depth than return handles.
file	file.h [code]
	Partial file and whole file based I/O methods.
file	forceinline.h [code]
	operating system and compiler independant definition of forceinline
file	global_new_delete.h [code]
	Replacement global new, new[], delete and delete[] operators. NOTE: This file can only be included once per executable.
file	hardware_support.h [code]
	Get and store details of the CPU's feature set.
file	hash_pearson.h [code]
	Faithful implementation of Person's hashing function.
file	hash_table.h [code]
	Thread-safe hash table (without delete).
file	heap.h [code]
	A bare-bones implementaiton of a min-heap.
file	index_manager.h [code]
	Base class for the indexer object that stored the actual index during indexing.
file	index_manager_sequential.h [code]
	Non-thread-Safe indexer object.
file	index_postings.h [code]
	Non-thread-Safe object that holds a single postings list during indexing.
file	index_postings_impact.h [code]
	Holder class for an impact ordered postings list.
file	instream.h [code]
	Base class for reading data from some input source.
file	instream_deflate.h [code]
	Subclass of instream for reading from .gz files (files compressed with deflate).
file	instream_directory_iterator.h [code]
	Subclass of instream for reading data from multiple files in a directory (as if they were all concatinated).
file	instream_document_fasta.h [code]
	Child class of instream for creating documents FASTA genome sequence files.
file	instream_document_html.h [code]
	Child class of instream for creating documents from files of html documents.
file	instream_document_trec.h [code]
	Child class of instream for creating documents from TREC pre-web (i.e. news articles) data.
file	instream_document_unicoil_json.h [code]
	Child class of instream for creating documents from the UniCOIL data in JSON format.
file	instream_document_warc.h [code]
	Child class of instream for creating documents from TREC WARC files.
file	instream_file.h [code]
	Subclass of instream for reading data from a disk file.
file	instream_file_star.h [code]
	Subclass of instream_file for construction using a FILE *.
file	instream_memory.h [code]
	Subclass of instream for reading data from a memory buffer.
file	maths.h [code]
	Basic maths functions.
file	parser.h [code]
	Simple XML parser that does't do either attributes or entities.
file	parser_fasta.h [code]
	Parser to turn DNA sequences in FASTA format into k-mers for indexing.
file	parser_query.h [code]
	Simple parser for queries.
file	parser_unicoil_json.h [code]
	Parser for documents from the UniCOIL data in JSON format.
file	pointer_box.h [code]
	A container type for pointers that allows comparison of the values pointed to the pointer.
file	posting.h [code]
	Tuple for a posting in a traditions <d,tf> postings list.
file	quantize.h [code]
	Quantize the in-memory index.
file	quantize_none.h [code]
	Do not quantize the in-memory index (i.e. generate a tf-ordered index)
file	query.h [code]
	Everything necessary to process a query. Subclassed in order to get add_rsv()
file	query_block_max.h [code]
	Everything necessary to process a query using the block-max approach of IOQP.
file	query_heap.h [code]
	Everything necessary to process a query using a heap to store the top-k.
file	query_simple.h [code]
	Everything necessary to process a query using an array of accumulators with no special handeling.
file	query_term.h [code]
	Details of a term from a query.
file	query_term_list.h [code]
	A list of query terms (i.e. a query)
file	ranking_function.h [code]
	Helper functions for all the rankers.
file	ranking_function_atire_bm25.h [code]
	The ATIRE verison of the BM25 ranking function.
file	ranking_function_none.h [code]
	Ranking function that returns the TF score - used for term frequency scaling into the quantized range.
file	reverse.h [code]
	Use reverse iterators in a for loop.
file	run_export.h [code]
	Export a run in a standard run format.
file	run_export_trec.h [code]
	Export a run in TREC run format.
file	serialise_ci.h [code]
	Serialise an index in source code.
file	serialise_forward_index.h [code]
	Serialise an index into a forward index in XML.
file	serialise_integers.h [code]
	Serialise an index in integer dump format.
file	serialise_jass_v1.h [code]
	Serialise an index in the experimental JASS-CI format used (by JASS version 1) in the RIGOR workshop.
file	serialise_jass_v2.h [code]
	Serialise an index in the format used by JASS version 2.
file	simd.h [code]
	Helpful SIMD methods.
file	slice.h [code]
	Slices (also known as string-descriptors) for C++.
file	statistics.h [code]
	Implementaiton of various statistics usefile for Information Retrieval (such as the t-test)
file	stem.h [code]
	Baseclass for stemmers.
file	stem_porter.h [code]
	Porter's stemer.
file	string_cpp.h [code]
	String type that uses a custom allocator.
file	threads.h [code]
	JASS implementation of C++ threads.
file	timer.h [code]
	Timer methods in nanoseconds and milliseconds.
file	top_k_heap.h [code]
	Implementation of a top-k keeper using a heap.
file	top_k_limit.h [code]
	Management of top-k rsv limiting.
file	top_k_qsort.h [code]
	Implementation of a top-k quick sort using.
file	unicode.h [code]
	Methods that work on Unicode codepoints.
file	unittest_data.h [code]
	Data that can be used and re-used for unittests (and other purposes).
file	version.h [code]
	Details about the current executing version of JASS.