vg
tools for working with variation graphs
Public Member Functions | Public Attributes | List of all members
vg::read_alignment_index_t Struct Reference

Type to point to an alignment of a known read. More...

Public Member Functions

template<typename NestedArray >
auto lookup_for_read_in (bool read, NestedArray &a) const -> typename std::add_lvalue_reference< decltype(a[0][0][0])>::type
 
template<typename NestedArray >
void check_for_read_in (bool read, NestedArray &a) const
 
bool operator== (const read_alignment_index_t &other)
 
bool operator!= (const read_alignment_index_t &other)
 

Public Attributes

size_t fragment
 
size_t alignment
 

Detailed Description

Type to point to an alignment of a known read.

Member Function Documentation

◆ check_for_read_in()

template<typename NestedArray >
void vg::read_alignment_index_t::check_for_read_in ( bool  read,
NestedArray &  a 
) const
inline

Make sure that this index actually points to an alignment of the given read in the given structure. Throws if not.

◆ lookup_for_read_in()

template<typename NestedArray >
auto vg::read_alignment_index_t::lookup_for_read_in ( bool  read,
NestedArray &  a 
) const -> typename std::add_lvalue_reference<decltype(a[0][0][0])>::type
inline

Allow looking up this index in a structure organized by fragment, read, and alignment, such as in alignments, or alignment_indices.

◆ operator!=()

bool vg::read_alignment_index_t::operator!= ( const read_alignment_index_t other)
inline

◆ operator==()

bool vg::read_alignment_index_t::operator== ( const read_alignment_index_t other)
inline

Member Data Documentation

◆ alignment

size_t vg::read_alignment_index_t::alignment

◆ fragment

size_t vg::read_alignment_index_t::fragment

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