vg
tools for working with variation graphs
Public Member Functions | Protected Attributes | List of all members
vg::algorithms::Anchor Class Reference

#include <chain_items.hpp>

Public Member Functions

size_t read_start () const
 Get the start position in the read of this anchor's match. More...
 
const pos_tgraph_start () const
 Get the start position in the graph of this anchor's match. More...
 
size_t length () const
 Get the length of this anchor's match. More...
 
int score () const
 Get the alignment score of the anchor. More...
 
size_t read_end () const
 Get the end position in the read of this anchor's match. More...
 
pos_t graph_end () const
 Get the end position in the graph of this anchor's match. More...
 
 Anchor (size_t read_start, const pos_t &graph_start, size_t length, int score)
 Compose a read start position, graph start position, and match length into an Anchor. More...
 
 Anchor ()=default
 
 Anchor (const Anchor &other)=default
 
Anchoroperator= (const Anchor &other)=default
 
 Anchor (Anchor &&other)=default
 
Anchoroperator= (Anchor &&other)=default
 

Protected Attributes

size_t start
 
size_t size
 
pos_t pos
 
int points
 

Detailed Description

Represents a piece fo a graph node matching to a piece of a read. Can be chained together.

Constructor & Destructor Documentation

◆ Anchor() [1/4]

vg::algorithms::Anchor::Anchor ( size_t  read_start,
const pos_t graph_start,
size_t  length,
int  score 
)
inline

Compose a read start position, graph start position, and match length into an Anchor.

◆ Anchor() [2/4]

vg::algorithms::Anchor::Anchor ( )
default

◆ Anchor() [3/4]

vg::algorithms::Anchor::Anchor ( const Anchor other)
default

◆ Anchor() [4/4]

vg::algorithms::Anchor::Anchor ( Anchor &&  other)
default

Member Function Documentation

◆ graph_end()

pos_t vg::algorithms::Anchor::graph_end ( ) const
inline

Get the end position in the graph of this anchor's match.

◆ graph_start()

const pos_t& vg::algorithms::Anchor::graph_start ( ) const
inline

Get the start position in the graph of this anchor's match.

◆ length()

size_t vg::algorithms::Anchor::length ( ) const
inline

Get the length of this anchor's match.

◆ operator=() [1/2]

Anchor& vg::algorithms::Anchor::operator= ( Anchor &&  other)
default

◆ operator=() [2/2]

Anchor& vg::algorithms::Anchor::operator= ( const Anchor other)
default

◆ read_end()

size_t vg::algorithms::Anchor::read_end ( ) const
inline

Get the end position in the read of this anchor's match.

◆ read_start()

size_t vg::algorithms::Anchor::read_start ( ) const
inline

Get the start position in the read of this anchor's match.

◆ score()

int vg::algorithms::Anchor::score ( ) const
inline

Get the alignment score of the anchor.

Member Data Documentation

◆ points

int vg::algorithms::Anchor::points
protected

◆ pos

pos_t vg::algorithms::Anchor::pos
protected

◆ size

size_t vg::algorithms::Anchor::size
protected

◆ start

size_t vg::algorithms::Anchor::start
protected

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