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

Manages counting ranges of values for the hibf::hierarchical_interleaved_bloom_filter. More...

#include <raptor/hierarchical_interleaved_bloom_filter.hpp>

Public Member Functions

Counting
template<std::ranges::forward_range value_range_t>
seqan3::counting_vector< value_t > const & bulk_count (value_range_t &&values, size_t const threshold=1u) &noexcept
 Counts the occurrences in each bin for all values in a range. More...
 
template<std::ranges::range value_range_t>
seqan3::counting_vector< value_t > const & bulk_count (value_range_t &&values, size_t const threshold=1u) &&noexcept=delete
 

Public Attributes

seqan3::counting_vector< value_t > result_buffer
 Stores the result of bulk_count(). More...
 

Constructors, destructor and assignment

 counting_agent_type ()=default
 Defaulted. More...
 
 counting_agent_type (counting_agent_type const &)=default
 Defaulted. More...
 
counting_agent_typeoperator= (counting_agent_type const &)=default
 Defaulted. More...
 
 counting_agent_type (counting_agent_type &&)=default
 Defaulted. More...
 
counting_agent_typeoperator= (counting_agent_type &&)=default
 Defaulted. More...
 
 ~counting_agent_type ()=default
 Defaulted. More...
 

Detailed Description

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
class raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >

Manages counting ranges of values for the hibf::hierarchical_interleaved_bloom_filter.

Constructor & Destructor Documentation

◆ counting_agent_type() [1/3]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::counting_agent_type ( )
default

Defaulted.

◆ counting_agent_type() [2/3]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::counting_agent_type ( counting_agent_type< value_t > const &  )
default

Defaulted.

◆ counting_agent_type() [3/3]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::counting_agent_type ( counting_agent_type< value_t > &&  )
default

Defaulted.

◆ ~counting_agent_type()

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::~counting_agent_type ( )
default

Defaulted.

Member Function Documentation

◆ bulk_count() [1/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
template<std::ranges::range value_range_t>
seqan3::counting_vector< value_t > const & raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::bulk_count ( value_range_t &&  values,
size_t const  threshold = 1u 
) &&
deletenoexcept

◆ bulk_count() [2/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
template<std::ranges::forward_range value_range_t>
seqan3::counting_vector< value_t > const & raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::bulk_count ( value_range_t &&  values,
size_t const  threshold = 1u 
) &
inlinenoexcept

Counts the occurrences in each bin for all values in a range.

Template Parameters
value_range_tThe type of the range of values. Must model std::ranges::forward_range. The reference type must model std::unsigned_integral.
Parameters
[in]valuesThe range of values to process.
[in]thresholdDo not recurse into merged bins with less than this many hits. Default: 1.
Attention
The result of this function must always be bound via reference, e.g. auto &, to prevent copying.
Sequential calls to this function invalidate the previously returned reference.

Thread safety

Concurrent invocations of this function are not thread safe, please create a hibf::hierarchical_interleaved_bloom_filter::counting_agent_type for each thread.

◆ operator=() [1/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
counting_agent_type & raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::operator= ( counting_agent_type< value_t > &&  )
default

Defaulted.

◆ operator=() [2/2]

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
counting_agent_type & raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::operator= ( counting_agent_type< value_t > const &  )
default

Defaulted.

Member Data Documentation

◆ result_buffer

template<seqan3::data_layout data_layout_mode_ = seqan3::data_layout::uncompressed>
template<std::integral value_t>
seqan3::counting_vector<value_t> raptor::hierarchical_interleaved_bloom_filter< data_layout_mode_ >::counting_agent_type< value_t >::result_buffer

Stores the result of bulk_count().


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