IntaRNA::Interaction::BasePair Class Reference

type of a base pair index encoding More...

#include <Interaction.h>

Classes
struct	Hash
	hash value computation More...

Public Member Functions
	BasePair (const size_t first=RnaSequence::lastPos, const size_t second=RnaSequence::lastPos)
const bool	operator< (const BasePair &bp) const
const bool	operator== (const BasePair &bp) const

Public Attributes
size_t	first
	index in first sequence
size_t	second
	index in second sequence

Detailed Description

type of a base pair index encoding

Constructor & Destructor Documentation

BasePair()

IntaRNA::Interaction::BasePair::BasePair ( const size_t  first = RnaSequence::lastPos, const size_t  second = RnaSequence::lastPos  )

inline

Construction

Parameters

first	index in first sequence
second	index in second sequence

Member Function Documentation

operator<()

const bool IntaRNA::Interaction::BasePair::operator< ( const BasePair &  bp ) const

inline

Parameters

bp	the BasePair to compare to

Returns

true if first index of this is smaller or it is equal but second is smaller

operator==()

const bool IntaRNA::Interaction::BasePair::operator== ( const BasePair &  bp ) const

inline

equality check

Parameters

bp	the BasePair to compare to

Returns

true if this BasePair equals bp (same positions)

Member Data Documentation

first

size_t IntaRNA::Interaction::BasePair::first

index in first sequence

second

size_t IntaRNA::Interaction::BasePair::second

index in second sequence

---

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

• src/IntaRNA/Interaction.h