IntaRNA::Interaction::Seed Class Reference

#include <Interaction.h>

Collaboration diagram for IntaRNA::Interaction::Seed:

Public Member Functions
	Seed ()
	Seed (const BasePair &bp_i, const BasePair &bp_j, const E_type energy)
const bool	operator< (const Seed &s) const
const bool	operator== (const Seed &s) const

Public Attributes
BasePair	bp_i
	left-most base pair of seed
BasePair	bp_j
	right-most base pair of seed
E_type	energy
	overall energy of seed

Detailed Description

Provides the seed information of an Interaction.

Constructor & Destructor Documentation

Seed() [1/2]

IntaRNA::Interaction::Seed::Seed

(

)

empty construction and init with invalid data

Seed() [2/2]

IntaRNA::Interaction::Seed::Seed	(	const BasePair &	bp_i,
		const BasePair &	bp_j,
		const E_type	energy
	)

construction

Parameters

bp_i	left-most base pair of the seed
bp_j	right-most base pair of the seed
energy	overall energy of the seed

Member Function Documentation

operator<()

const bool IntaRNA::Interaction::Seed::operator< ( const Seed &  s ) const

inline

order definition: first by increasing energy, then lexicographically by all seed boundaries as tie breakers.

Parameters

s	the seed to compare to

Returns

true if this seed is considered smaller than s

operator==()

const bool IntaRNA::Interaction::Seed::operator== ( const Seed &  s ) const

inline

equality check

Parameters

s	the seed to compare to

Returns

true if this seed equals s

Member Data Documentation

bp_i

BasePair IntaRNA::Interaction::Seed::bp_i

left-most base pair of seed

bp_j

BasePair IntaRNA::Interaction::Seed::bp_j

right-most base pair of seed

energy

E_type IntaRNA::Interaction::Seed::energy

overall energy of seed

---

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

• src/IntaRNA/Interaction.h