Per-database construction metadata decoded from the A48 file-level header. More...

#include <a48.hpp>

Public Attributes
uint32_t	kmer_length {}
	K-mer length (`#k`). Present when the file was written with an explicit k.

bool	has_kmer_length {}

uint64_t	seed {}
	Hash seed (`#seed`). Present when the file was written with a nonzero seed.

bool	has_seed {}

uint8_t	exponent_bits {6U}
	Exponent bit width (`#exponent`) of each 16-bit bucket value.

bool	has_exponent {}

std::string	blacklist
	Blacklist filenames recorded in the header (`#blacklist`), if any.

size_t	record_count {}
	Number of decoded records.

Detailed Description

Per-database construction metadata decoded from the A48 file-level header.

These mirror the BBTools DDL TSV header fields that define how the score rows were produced (#k, #seed, #exponent, #blacklist, #date). They are used both to decode the relative score rows and to assert provenance before any result is accepted.

Definition at line 21 of file a48.hpp.

Member Data Documentation

◆ blacklist

std::string cuddl::a48::database_metadata::blacklist

Blacklist filenames recorded in the header (#blacklist), if any.

Definition at line 33 of file a48.hpp.

◆ exponent_bits

uint8_t cuddl::a48::database_metadata::exponent_bits {6U}

Exponent bit width (#exponent) of each 16-bit bucket value.

The mantissa gets 16 - exponent_bits bits. Defaults to 6 (the BBTools DDL default) when absent.

Definition at line 30 of file a48.hpp.

30{6U};

◆ has_exponent

bool cuddl::a48::database_metadata::has_exponent {}

Definition at line 31 of file a48.hpp.

31{};

◆ has_kmer_length

bool cuddl::a48::database_metadata::has_kmer_length {}

Definition at line 24 of file a48.hpp.

24{};

◆ has_seed

bool cuddl::a48::database_metadata::has_seed {}

Definition at line 27 of file a48.hpp.

27{};

◆ kmer_length

uint32_t cuddl::a48::database_metadata::kmer_length {}

K-mer length (#k). Present when the file was written with an explicit k.

Definition at line 23 of file a48.hpp.

23{};

◆ record_count

size_t cuddl::a48::database_metadata::record_count {}

Number of decoded records.

Definition at line 35 of file a48.hpp.

35{};

◆ seed

uint64_t cuddl::a48::database_metadata::seed {}

Hash seed (#seed). Present when the file was written with a nonzero seed.

Definition at line 26 of file a48.hpp.

26{};

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

a48.hpp

Public Attributes