fastq_to_fasta
A template for creation of SeqAn3 apps, with a FASTQ to FASTA example app.
Public Member Functions | List of all members
raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins Class Reference

Bookkeeping for user and technical bins. More...

#include <raptor/hierarchical_interleaved_bloom_filter.hpp>

Public Member Functions

size_t num_user_bins () const noexcept
 Returns the number of managed user bins. More...
 
void set_ibf_count (size_t const size)
 Changes the number of managed IBFs. More...
 
void set_user_bin_count (size_t const size)
 Changes the number of managed user bins. More...
 
std::vector< int64_t > & bin_indices_of_ibf (size_t const idx)
 Returns a vector containing user bin indices for each bin in the idxth IBF. More...
 
std::string & filename_of_user_bin (size_t const idx)
 Returns the filename of the idxth user bin. More...
 
std::string const & operator[] (std::pair< size_t, size_t > const &index_pair) const
 For a pair (a,b), returns a const reference to the filename of the user bin at IBF a, bin b. More...
 
auto operator[] (size_t const ibf_idx) const
 Returns a view over the user bin filenames for the ibf_idxth IBF. An empty string is returned for merged bins. More...
 
int64_t filename_index (size_t const ibf_idx, size_t const bin_idx) const
 Returns the filename index of the ibf_idxth IBF for bin bin_idx. More...
 
template<typename stream_t >
void write_filenames (stream_t &out_stream) const
 Writes all filenames to a stream. Index and filename are tab-separated. More...
 

Detailed Description

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
class raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins

Bookkeeping for user and technical bins.

Member Function Documentation

◆ bin_indices_of_ibf()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
std::vector<int64_t>& raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::bin_indices_of_ibf ( size_t const  idx)
inline

Returns a vector containing user bin indices for each bin in the idxth IBF.

◆ filename_index()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
int64_t raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::filename_index ( size_t const  ibf_idx,
size_t const  bin_idx 
) const
inline

Returns the filename index of the ibf_idxth IBF for bin bin_idx.

◆ filename_of_user_bin()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
std::string& raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::filename_of_user_bin ( size_t const  idx)
inline

Returns the filename of the idxth user bin.

◆ num_user_bins()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
size_t raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::num_user_bins ( ) const
inlinenoexcept

Returns the number of managed user bins.

◆ operator[]() [1/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
auto raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::operator[] ( size_t const  ibf_idx) const
inline

Returns a view over the user bin filenames for the ibf_idxth IBF. An empty string is returned for merged bins.

◆ operator[]() [2/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
std::string const& raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::operator[] ( std::pair< size_t, size_t > const &  index_pair) const
inline

For a pair (a,b), returns a const reference to the filename of the user bin at IBF a, bin b.

◆ set_ibf_count()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
void raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::set_ibf_count ( size_t const  size)
inline

Changes the number of managed IBFs.

◆ set_user_bin_count()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
void raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::set_user_bin_count ( size_t const  size)
inline

Changes the number of managed user bins.

◆ write_filenames()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<typename stream_t >
void raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::user_bins::write_filenames ( stream_t &  out_stream) const
inline

Writes all filenames to a stream. Index and filename are tab-separated.

0 <path_to_user_bin_0> 1 <path_to_user_bin_1>


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