Fixed-width pack integers into as few 64-bit words as possible. More...

#include <compress_integer_bitpack_64.h>

Inheritance diagram for JASS::compress_integer_bitpack_64:

Collaboration diagram for JASS::compress_integer_bitpack_64:

Public Member Functions
virtual size_t	encode (void encoded, size_t encoded_buffer_length, const integer source, size_t source_integers)
	Encode a sequence of integers returning the number of bytes used for the encoding, or 0 if the encoded sequence doesn't fit in the buffer. More...

virtual void	decode (integer decoded, size_t integers_to_decode, const void source, size_t source_length)
	Decode a sequence of integers encoded with this codex. More...

Public Member Functions inherited from JASS::compress_integer_bitpack
template<int32_t WIDTH_IN_BITS>
size_t	encode (void encoded, size_t encoded_buffer_length, const integer array, size_t source_integers, const uint32_t bits_to_use=bits_to_use_complete, const uint32_t selector_to_use=selector_to_use_complete)
	Encode a sequence of integers returning the number of bytes used for the encoding, or 0 if the encoded sequence doesn't fit in the buffer. More...

Public Member Functions inherited from JASS::compress_integer
	compress_integer ()
	Constructor.

virtual	~compress_integer ()
	Destructor.

Static Public Member Functions
static void	unittest (void)
	Unit test this class.

Static Public Member Functions inherited from JASS::compress_integer_bitpack
static uint32_t	bits_needed (uint32_t integer)
	retur the number of bits needed to represent the given integer. More...

Static Public Member Functions inherited from JASS::compress_integer
static size_t	d1_encode (integer encoded, const integer source, size_t source_integers)
	Convert an array of integers into an array of D1 (delta, d-gap) encoded integers. More...

static size_t	d1_decode (integer decoded, const integer source, size_t source_integers)
	Convert a D1 encoded array of integers into an array of integers. More...

static size_t	dn_encode (integer encoded, const integer source, size_t source_integers, size_t n=1)
	Convert an array of integers into an array of Dn (delta, d-gap) encoded integers with a gap of n. More...

static size_t	dn_decode (integer decoded, const integer source, size_t source_integers, size_t n=1)
	Convert a Dn encoded array of integers into an array of integers. More...

static void	unittest_one (compress_integer &encoder, const std::vector< uint32_t > &sequence)
	Test one sequence to make sure it encodes and decodes to the same thing. Assert if not. More...

static void	unittest (compress_integer &compressor, uint32_t staring_from=0)
	Unit test this class, assert on failure. More...

Additional Inherited Members
Public Types inherited from JASS::compress_integer
typedef uint32_t	integer
	This class and descendants will work on integers of this size. Do not change without also changing JASS_COMPRESS_INTEGER_BITS_PER_INTEGER.

Detailed Description

Fixed-width pack integers into as few 64-bit words as possible.

Pack into 64-bit word a bunch of same-width integers, so: 32 * 2 * 1-bit integers 16 * 2 * 2-bit integers 10 * 2 * 3-bit integers 8 * 2 * 4-bit integers 6 * 2 * 5-bit integers 5 * 2 * 6-bit integers 4 * 2 * 8-bit integers 3 * 2 * 10-bit integers 2 * 2 * 16-bit integers 1 * 2 * 32-bit integers

Member Function Documentation

◆ decode()

void JASS::compress_integer_bitpack_64::decode	(	integer *	decoded,
		size_t	integers_to_decode,
		const void *	source,
		size_t	source_length
	)

virtual

Decode a sequence of integers encoded with this codex.

Parameters

decoded	[out] The sequence of decoded integers.
integers_to_decode	[in] The minimum number of integers to decode (it may decode more).
source	[in] The encoded integers.
source_length	[in] The length (in bytes) of the source buffer.

< AND mask for 16-bit integers

< AND mask for 10-bit integers

< AND mask for 8-bit integers

< AND mask for 6-bit integers

< AND mask for 5-bit integers

< AND mask for 4-bit integers

< AND mask for 3-bit integers

< AND mask for 2-bit integers

< AND mask for 1-bit integers

Implements JASS::compress_integer.

◆ encode()

virtual size_t JASS::compress_integer_bitpack_64::encode	(	void *	encoded,
		size_t	encoded_buffer_length,
		const integer *	source,
		size_t	source_integers
	)

inlinevirtual

Encode a sequence of integers returning the number of bytes used for the encoding, or 0 if the encoded sequence doesn't fit in the buffer.

Parameters

encoded	[out] The sequence of bytes that is the encoded sequence.
encoded_buffer_length	[in] The length (in bytes) of the output buffer, encoded.
source	[in] The sequence of integers to encode.
source_integers	[in] The length (in integers) of the source buffer.

Returns: The number of bytes used to encode the integer sequence, or 0 on error (i.e. overflow).

Implements JASS::compress_integer.

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

source/compress_integer_bitpack_64.h
source/compress_integer_bitpack_64.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ decode()

◆ encode()