1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
// --------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2022, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2022, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/raptor/blob/main/LICENSE.md
// --------------------------------------------------------------------------------------------------
#pragma once
#include <sharg/exceptions.hpp>
#include <raptor/argument_parsing/build_arguments.hpp>
#include <raptor/hierarchical_interleaved_bloom_filter.hpp>
#include <raptor/strong_types.hpp>
namespace raptor
{
namespace index_structure
{
using ibf = seqan3::interleaved_bloom_filter<seqan3::data_layout::uncompressed>;
using ibf_compressed = seqan3::interleaved_bloom_filter<seqan3::data_layout::compressed>;
using hibf = hierarchical_interleaved_bloom_filter<seqan3::data_layout::uncompressed>;
using hibf_compressed = hierarchical_interleaved_bloom_filter<seqan3::data_layout::compressed>;
template <typename return_t, typename input_t>
concept compressible_from = (std::same_as<return_t, ibf_compressed> && std::same_as<input_t, ibf>)
|| (std::same_as<return_t, hibf_compressed> && std::same_as<input_t, hibf>);
} // namespace index_structure
template <typename data_t = index_structure::ibf>
class raptor_index
{
private:
template <typename friend_data_t>
friend class raptor_index;
uint64_t window_size_{};
seqan3::shape shape_{};
uint8_t parts_{};
bool compressed_{};
std::vector<std::vector<std::string>> bin_path_{};
data_t ibf_{};
public:
static constexpr seqan3::data_layout data_layout_mode = data_t::data_layout_mode;
static constexpr uint32_t version{1u};
raptor_index() = default;
raptor_index(raptor_index const &) = default;
raptor_index(raptor_index &&) = default;
raptor_index & operator=(raptor_index const &) = default;
raptor_index & operator=(raptor_index &&) = default;
~raptor_index() = default;
explicit raptor_index(window const window_size,
seqan3::shape const shape,
uint8_t const parts,
bool const compressed,
std::vector<std::vector<std::string>> const & bin_path,
data_t && ibf) :
window_size_{window_size.v},
shape_{shape},
parts_{parts},
compressed_{compressed},
bin_path_{bin_path},
ibf_{std::move(ibf)}
{}
explicit raptor_index(build_arguments const & arguments) :
window_size_{arguments.window_size},
shape_{arguments.shape},
parts_{arguments.parts},
compressed_{arguments.compressed},
bin_path_{arguments.bin_path},
ibf_{seqan3::bin_count{arguments.bins},
seqan3::bin_size{arguments.bits / arguments.parts},
seqan3::hash_function_count{arguments.hash}}
{
static_assert(data_layout_mode == seqan3::data_layout::uncompressed);
}
template <typename other_data_t>
explicit raptor_index(raptor_index<other_data_t> const & other)
{
static_assert(index_structure::compressible_from<data_t, other_data_t>);
window_size_ = other.window_size_;
shape_ = other.shape_;
parts_ = other.parts_;
compressed_ = true;
bin_path_ = other.bin_path_;
ibf_ = data_t{other.ibf_};
}
template <typename other_data_t>
explicit raptor_index(raptor_index<other_data_t> && other)
{
static_assert(index_structure::compressible_from<data_t, other_data_t>);
window_size_ = std::move(other.window_size_);
shape_ = std::move(other.shape_);
parts_ = std::move(other.parts_);
compressed_ = true;
bin_path_ = std::move(other.bin_path_);
ibf_ = std::move(data_t{std::move(other.ibf_)});
}
uint64_t window_size() const
{
return window_size_;
}
seqan3::shape shape() const
{
return shape_;
}
uint8_t parts() const
{
return parts_;
}
bool compressed() const
{
return compressed_;
}
std::vector<std::vector<std::string>> const & bin_path() const
{
return bin_path_;
}
data_t & ibf()
{
return ibf_;
}
data_t const & ibf() const
{
return ibf_;
}
/*!\cond DEV
* \brief Serialisation support function.
* \tparam archive_t Type of `archive`; must satisfy seqan3::cereal_archive.
* \param[in] archive The archive being serialised from/to.
*
* \attention These functions are never called directly, see \ref serialisation for more details.
*/
template <seqan3::cereal_archive archive_t>
void CEREAL_SERIALIZE_FUNCTION_NAME(archive_t & archive)
{
uint32_t parsed_version{raptor_index<>::version};
archive(parsed_version);
if (parsed_version == raptor_index<>::version)
{
try
{
archive(window_size_);
archive(shape_);
archive(parts_);
archive(compressed_);
if ((data_layout_mode == seqan3::data_layout::compressed && !compressed_)
|| (data_layout_mode == seqan3::data_layout::uncompressed && compressed_))
{
throw sharg::parser_error{"Data layouts of serialised and specified index differ."};
}
archive(bin_path_);
archive(ibf_);
}
catch (std::exception const & e)
{
throw sharg::parser_error{"Cannot read index: " + std::string{e.what()}};
}
}
else
{
throw sharg::parser_error{"Unsupported index version. Check raptor upgrade."}; // GCOVR_EXCL_LINE
}
}
/* \brief Serialisation support function. Do not load the actual data.
* \tparam archive_t Type of `archive`; must satisfy seqan3::cereal_input_archive.
* \param[in] archive The archive being serialised from/to.
* \param[in] version Index version.
*
* \attention These functions are never called directly, see \ref serialisation for more details.
*/
template <seqan3::cereal_input_archive archive_t>
void load_parameters(archive_t & archive)
{
uint32_t parsed_version{};
archive(parsed_version);
if (parsed_version == version)
{
try
{
archive(window_size_);
archive(shape_);
archive(parts_);
archive(compressed_);
archive(bin_path_);
}
// GCOVR_EXCL_START
catch (std::exception const & e)
{
throw sharg::parser_error{"Cannot read index: " + std::string{e.what()}};
}
// GCOVR_EXCL_STOP
}
else
{
throw sharg::parser_error{"Unsupported index version. Check raptor upgrade."}; // GCOVR_EXCL_LINE
}
}
//!\endcond
};
} // namespace raptor
|
