simple random-access iterator class for VariantFilters objects
More...
#include <variant_filters_iterator.h>
|
| VariantFiltersIterator (const std::shared_ptr< bcf_hdr_t > &header, const std::shared_ptr< bcf1_t > &body, const uint32_t position) |
| simple constructor used by the VariantFilters begin/end member functions More...
|
|
std::string | operator[] (int index) const |
| returns a new string for the element at position 'index' More...
|
|
std::string | operator* () const |
| returns a new string for the element at the current position More...
|
|
VariantFiltersIterator | operator++ () |
| advances the iterator by one position More...
|
|
VariantFiltersIterator | operator-- () |
| rewinds the iterator by one position More...
|
|
VariantFiltersIterator | operator+= (const int n) |
| advances the iterator by n positions More...
|
|
VariantFiltersIterator | operator-= (const int n) |
| rewinds the iterator by n positions More...
|
|
bool | operator!= (const VariantFiltersIterator &other) |
| can be compared for equivalence using the equality/inequality operators More...
|
|
bool | operator== (const VariantFiltersIterator &other) |
| can be compared for equivalence using the equality/inequality operators More...
|
|
bool | operator<= (const VariantFiltersIterator &other) |
| Can be compared with inequality relational operators (<, >, <= and >=). More...
|
|
bool | operator>= (const VariantFiltersIterator &other) |
| Can be compared with inequality relational operators (<, >, <= and >=). More...
|
|
bool | operator< (const VariantFiltersIterator &other) |
| Can be compared with inequality relational operators (<, >, <= and >=). More...
|
|
bool | operator> (const VariantFiltersIterator &other) |
| Can be compared with inequality relational operators (<, >, <= and >=). More...
|
|
uint32_t | size () const |
| returns the number of filters in this object More...
|
|
simple random-access iterator class for VariantFilters objects
gamgee::VariantFiltersIterator::VariantFiltersIterator |
( |
const std::shared_ptr< bcf_hdr_t > & |
header, |
|
|
const std::shared_ptr< bcf1_t > & |
body, |
|
|
const uint32_t |
position |
|
) |
| |
|
inline |
simple constructor used by the VariantFilters begin/end member functions
- Parameters
-
header | an htslib variant header to keep shared ownership of the memory |
body | an htslib variant body to keep shared ownership of the memory |
position | current position in the iterator (starts at 0, normally) |
can be compared for equivalence using the equality/inequality operators
std::string gamgee::VariantFiltersIterator::operator* |
( |
| ) |
const |
|
inline |
returns a new string for the element at the current position
advances the iterator by one position
advances the iterator by n positions
rewinds the iterator by one position
rewinds the iterator by n positions
Can be compared with inequality relational operators (<, >, <= and >=).
Can be compared with inequality relational operators (<, >, <= and >=).
can be compared for equivalence using the equality/inequality operators
Can be compared with inequality relational operators (<, >, <= and >=).
Can be compared with inequality relational operators (<, >, <= and >=).
std::string gamgee::VariantFiltersIterator::operator[] |
( |
int |
index | ) |
const |
|
inline |
returns a new string for the element at position 'index'
uint32_t gamgee::VariantFiltersIterator::size |
( |
| ) |
const |
|
inline |
returns the number of filters in this object
The documentation for this class was generated from the following file: