LocARNA::BasePairs__Arc Class Reference

Represents a base pair. More...

#include <basepairs.hh>

Inheritance diagram for LocARNA::BasePairs__Arc:

Public Member Functions
	BasePairs__Arc (size_t idx, size_t left, size_t right)
size_t	left () const
size_t	right () const
size_t	idx () const

Detailed Description

Represents a base pair.

stores base pair left end, right end and an arc index

Note

index uniqueness is not guaranteed by the class itself but can be used to locate the arc in a vector by the caller

To indicate the relation to the BasePair class, we define with prefix BasePairs__. Using a nested class does not work properly (C++ does not support forward references to nested classes.) Using a namespace instead of prefix should work as well, but caused problems at first when including the adjecency entry classes in the namespace!

Constructor & Destructor Documentation

BasePairs__Arc()

LocARNA::BasePairs__Arc::BasePairs__Arc ( size_t  idx, size_t  left, size_t  right  )

inline

Construct from member values

Parameters

idx	Index
left	Left position of arc
right	Right position of arc

Member Function Documentation

idx()

size_t LocARNA::BasePairs__Arc::idx ( ) const

inline

Read access

Returns

index of arc

left()

size_t LocARNA::BasePairs__Arc::left ( ) const

inline

Read access

Returns

left arc end

right()

size_t LocARNA::BasePairs__Arc::right ( ) const

inline

Read access

Returns

right arc end

---

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

• src/LocARNA/basepairs.hh
• src/LocARNA/basepairs.cc