index_metadata.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2026 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2026 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <cstddef>
#include <filesystem>
#include <optional>
#include <vector>
 
#include <raptor/argument_parsing/inspect_arguments.hpp>
#include <raptor/index.hpp>
 
namespace raptor::detail
{
 
struct ibf_metadata
{
    size_t id{};
    size_t level{};
    std::optional<seqan::hibf::hierarchical_interleaved_bloom_filter::previous_ibf_id_pair> parent{};
    size_t technical_bins{};
    size_t capacity{};
    size_t merged_bins{};
    size_t deleted_bins{};
    size_t bin_size{};
    size_t hash_function_count{};
    size_t bit_size{};
};
 
struct structure_metadata
{
    std::vector<ibf_metadata> ibfs{};
    std::vector<size_t> retired_ibfs{};
    std::vector<size_t> deleted_user_bins{};
    size_t levels{};
};
 
struct index_metadata
{
    std::filesystem::path index_file{};
    size_t size_in_bytes{};
    raptor_index<index_structure::hibf> parameters{};
    std::optional<structure_metadata> structure{};
};
 
index_metadata read_index_metadata(inspect_arguments const & arguments);
 
} // namespace raptor::detail