vg::Haplotypes::Header Struct Reference

Header of the serialized file. More...

#include <recombinator.hpp>

Public Attributes
std::uint32_t	magic_number = MAGIC_NUMBER
	A magic number that identifies the file. More...
std::uint32_t	version = VERSION
	Version of the file. More...
std::uint64_t	top_level_chains = 0
	Number of top-level chains in the graph. More...
std::uint64_t	construction_jobs = 0
	Number of GBWT construction jobs for the chains. More...
std::uint64_t	total_subchains = 0
	Total number of subchains in all chains. More...
std::uint64_t	total_kmers = 0
	Total number of kmers in all subchains. More...
std::uint64_t	k = DEFAULT_K
	Length of the kmers. More...

Static Public Attributes
constexpr static std::uint32_t	MAGIC_NUMBER = 0x4C504148
constexpr static std::uint32_t	VERSION = 2
constexpr static std::uint32_t	MIN_VERSION = 1
constexpr static std::uint64_t	DEFAULT_K = 29

Detailed Description

Header of the serialized file.

Member Data Documentation

construction_jobs

std::uint64_t vg::Haplotypes::Header::construction_jobs = 0

Number of GBWT construction jobs for the chains.

DEFAULT_K

constexpr std::uint64_t vg::Haplotypes::Header::DEFAULT_K = 29

staticconstexpr

k

std::uint64_t vg::Haplotypes::Header::k = DEFAULT_K

Length of the kmers.

MAGIC_NUMBER

constexpr std::uint32_t vg::Haplotypes::Header::MAGIC_NUMBER = 0x4C504148

staticconstexpr

magic_number

std::uint32_t vg::Haplotypes::Header::magic_number = MAGIC_NUMBER

A magic number that identifies the file.

MIN_VERSION

constexpr std::uint32_t vg::Haplotypes::Header::MIN_VERSION = 1

staticconstexpr

top_level_chains

std::uint64_t vg::Haplotypes::Header::top_level_chains = 0

Number of top-level chains in the graph.

total_kmers

std::uint64_t vg::Haplotypes::Header::total_kmers = 0

Total number of kmers in all subchains.

total_subchains

std::uint64_t vg::Haplotypes::Header::total_subchains = 0

Total number of subchains in all chains.

VERSION

constexpr std::uint32_t vg::Haplotypes::Header::VERSION = 2

staticconstexpr

version

std::uint32_t vg::Haplotypes::Header::version = VERSION

Version of the file.

---

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

• src/recombinator.hpp
• src/recombinator.cpp