Represents an approximate Longest Common Prefix (LCP) length in a memory-efficient format. More...

#include <ZipTrie.hpp>

Public Member Functions
auto	operator<=> (const MemoryEfficientLCP &) const =default
	Default comparison operator.

unsigned	value () const noexcept
	Calculates the approximate actual LCP value represented by this struct.

std::ostream &	print (std::ostream &os) const noexcept
	Prints the LCP representation (e.g., "2^3 * 5") to an output stream.

Public Attributes
uint8_t	exp_of_2 = 0
	The exponent part of the LCP representation (base 2).

uint8_t	multiple = 0
	The multiple (mantissa) part of the LCP representation.

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, const MemoryEfficientLCP &lcp)
	Overloaded stream insertion operator (`<<`) for `MemoryEfficientLCP`.

Detailed Description

Represents an approximate Longest Common Prefix (LCP) length in a memory-efficient format.

Stores the LCP value approximately as multiple * 2^exp_of_2. This allows representing potentially large LCP values using fewer bits (typically two uint8_t) at the cost of precision for larger values. The scaling depends on the expected maximum size of the trie.

See also: ZipTrie::get_memory_efficient_lcp

Definition at line 36 of file ZipTrie.hpp.

Member Function Documentation

◆ operator<=>()

auto MemoryEfficientLCP::operator<=> ( const MemoryEfficientLCP & ) const

default

Default comparison operator.

Compares exp_of_2 first, then multiple for tie-breaking. This allows comparing approximate LCP values directly.

◆ print()

std::ostream & MemoryEfficientLCP::print ( std::ostream & os ) const

inlinenoexcept

Prints the LCP representation (e.g., "2^3 * 5") to an output stream.

Parameters

os	The output stream to write to.

Returns: std::ostream& Reference to the output stream after writing.

Definition at line 1062 of file ZipTrie.hpp.

{
    // Cast uint8_t to unsigned for correct stream output as numbers.
    return os << "2^" << static_cast<unsigned>(exp_of_2) << "*" << static_cast<unsigned>(multiple);
}

◆ value()

unsigned MemoryEfficientLCP::value ( ) const

inlinenoexcept

Calculates the approximate actual LCP value represented by this struct.

Returns: unsigned The calculated LCP value (multiple * 2^exp_of_2).

Definition at line 1055 of file ZipTrie.hpp.

{
    // Calculate the value by left-shifting 1 by exp_of_2 and multiplying by multiple.
    // Ensure intermediate shift doesn't overflow if exp_of_2 is large, though unlikely for uint8_t.
    return (1u << exp_of_2) * multiple;
}

Friends And Related Symbol Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		const MemoryEfficientLCP &	lcp
	)

Allows printing MemoryEfficientLCP objects directly to output streams (e.g., std::cout << lcp;). Delegates formatting to the MemoryEfficientLCP::print method.

Parameters

os	The output stream (e.g., `std::cout`, `std::ofstream`).
lcp	The `MemoryEfficientLCP` object to print.

Returns: std::ostream& Reference to the output stream after printing.

Definition at line 1077 of file ZipTrie.hpp.

{
    // Delegate the actual printing logic to the struct's print method.
    return lcp.print(os);
}

Member Data Documentation

◆ exp_of_2

uint8_t MemoryEfficientLCP::exp_of_2 = 0

The exponent part of the LCP representation (base 2).

Definition at line 39 of file ZipTrie.hpp.

◆ multiple

uint8_t MemoryEfficientLCP::multiple = 0

The multiple (mantissa) part of the LCP representation.

Definition at line 41 of file ZipTrie.hpp.

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

src/ZipTrie.hpp

Public Member Functions

Public Attributes

Related Symbols