Raptor 4.0.0-rc.1
A fast and space-efficient pre-filter
Loading...
Searching...
No Matches
update_arguments.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2006-2026 Knut Reinert & Freie Universität Berlin
2// SPDX-FileCopyrightText: 2016-2026 Knut Reinert & MPI für molekulare Genetik
3// SPDX-License-Identifier: BSD-3-Clause
4
10#pragma once
11
12#include <filesystem>
13#include <vector>
14
15#include <seqan3/search/kmer_index/shape.hpp>
16
17namespace raptor
18{
19
21{
24 std::filesystem::path out_path{};
25
29 uint8_t threads{1u};
30
31 // Read from the index, not from the command line.
32 uint32_t window_size{20u};
33 seqan3::shape shape{seqan3::ungapped{20u}};
34 uint8_t shape_size{shape.size()};
35 uint8_t shape_weight{shape.count()};
36 uint8_t parts{1u};
37 bool is_hibf{false};
38 double fpr{0.05};
39
46 bool stats{false};
47
52
54 mutable size_t partial_rebuilds{};
58 mutable size_t full_rebuilds{};
59
61 void print_stats() const;
62};
63
64} // namespace raptor
Definition update_arguments.hpp:21
std::vector< size_t > user_bins_to_delete
The IDs of the user bins to delete.
Definition update_arguments.hpp:49
std::filesystem::path bin_file
The --insert argument: a single sequence file, or a file containing file names.
Definition update_arguments.hpp:28
size_t full_rebuilds
The number of full rebuilds performed by raptor::insert_user_bin.
Definition update_arguments.hpp:58
bool disable_partial_rebuild
Whether to replace every partial rebuild by a full one.
Definition update_arguments.hpp:44
void print_stats() const
Prints the number of inserted user bins and of the rebuilds they required to stderr.
Definition update_arguments.cpp:17
std::filesystem::path index_file
The index to update. Left untouched; the result is written to out_path.
Definition update_arguments.hpp:23
std::vector< std::vector< std::string > > user_bins_to_insert
The user bins to insert, one entry per user bin.
Definition update_arguments.hpp:51
bool stats
Whether to print a summary of the insertion to stderr, see raptor::update_arguments::print_stats.
Definition update_arguments.hpp:46
size_t partial_rebuilds
The number of partial rebuilds performed by raptor::insert_user_bin.
Definition update_arguments.hpp:54
Hide me