IntaRNA 3.4.1
RNA-RNA interaction prediction | C++ API
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
IntaRNA::PredictorMfeEns2dHeuristic Class Reference

#include <PredictorMfeEns2dHeuristic.h>

Inheritance diagram for IntaRNA::PredictorMfeEns2dHeuristic:
Inheritance graph
[legend]
Collaboration diagram for IntaRNA::PredictorMfeEns2dHeuristic:
Collaboration graph
[legend]

Public Member Functions

 PredictorMfeEns2dHeuristic (const InteractionEnergy &energy, OutputHandler &output, PredictionTracker *predTracker)
 
virtual ~PredictorMfeEns2dHeuristic ()
 
virtual void predict (const IndexRange &r1=IndexRange(0, RnaSequence::lastPos), const IndexRange &r2=IndexRange(0, RnaSequence::lastPos))
 
- Public Member Functions inherited from IntaRNA::PredictorMfeEns2d
 PredictorMfeEns2d (const InteractionEnergy &energy, OutputHandler &output, PredictionTracker *predTracker)
 
virtual ~PredictorMfeEns2d ()
 
- Public Member Functions inherited from IntaRNA::PredictorMfeEns
 PredictorMfeEns (const InteractionEnergy &energy, OutputHandler &output, PredictionTracker *predTracker)
 
virtual ~PredictorMfeEns ()
 
- Public Member Functions inherited from IntaRNA::PredictorMfe
 PredictorMfe (const InteractionEnergy &energy, OutputHandler &output, PredictionTracker *predTracker)
 
virtual ~PredictorMfe ()
 
- Public Member Functions inherited from IntaRNA::Predictor
 Predictor (const InteractionEnergy &energy, OutputHandler &output, PredictionTracker *predTracker)
 
virtual ~Predictor ()
 
Z_type getZall () const
 

Protected Types

typedef Matrix< BestInteractionZ > Z2dMatrix
 matrix type to hold the mfe energies and boundaries for interaction site starts
 
- Protected Types inherited from IntaRNA::PredictorMfeEns2d
typedef Matrix< Z_type > Z2dMatrix
 matrix type to hold the partition functions for interaction site starts
 
- Protected Types inherited from IntaRNA::PredictorMfe
typedef BestInteraction< E_type > BestInteractionE
 BestInteraction that stores an energy value.
 
typedef BestInteraction< Z_type > BestInteractionZ
 BestInteraction that stores a partition function value.
 
typedef std::list< Interaction > InteractionList
 list of interactions
 
typedef boost::unordered_map< Interaction::BasePair, BestInteractionE, Interaction::BasePair::Hash > HashIdx2E
 hash to map index pairs to BestInteractionE entries
 

Protected Member Functions

virtual void fillHybridZ ()
 
- Protected Member Functions inherited from IntaRNA::PredictorMfeEns2d
virtual void fillHybridZ (const size_t j1, const size_t j2, const size_t i1init, const size_t i2init, const bool callUpdateZ)
 
- Protected Member Functions inherited from IntaRNA::PredictorMfeEns
virtual void initZ ()
 
virtual void updateZ (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const Z_type partFunct, const bool isHybridZ)
 
void updateCompleteZ (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const Z_type partFunct, const bool isHybridZ)
 
virtual void reportOptima ()
 
virtual void traceBack (Interaction &interaction)
 
- Protected Member Functions inherited from IntaRNA::PredictorMfe
virtual void initOptima ()
 
bool isValidOutputSite (const size_t i1, const size_t j1, const size_t i2, const size_t j2) const
 
virtual void updateOptima (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const E_type energy, const bool isHybridE, const bool incrementZall)
 
virtual void getNextBest (Interaction &curBest)
 
virtual void updateMfe4leftEnd (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const Interaction &curInteraction)
 
- Protected Member Functions inherited from IntaRNA::Predictor
virtual void updateZall (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const E_type energy, const bool isHybridE)
 
void incrementZall (const Z_type partZ)
 

Protected Attributes

Z2dMatrix hybridZ
 energy of all interaction hybrids starting in i1,i2
 
InteractionEnergyIdxOffset energy
 access to the interaction energy handler of the super class
 
OutputHandler & output
 access to the output handler of the super class
 
- Protected Attributes inherited from IntaRNA::PredictorMfeEns2d
Z2dMatrix hybridZ
 
InteractionEnergyIdxOffset energy
 access to the interaction energy handler of the super class
 
OutputHandler & output
 access to the output handler of the super class
 
- Protected Attributes inherited from IntaRNA::PredictorMfeEns
std::unordered_map< Interaction::Boundary, Z_type, Interaction::Boundary::Hash > Z_partition
 map storing the partition of Zall for all considered interaction sites
 
bool updateZisComplete
 whether updateZ() currently receives one complete boundary partition
 
InteractionEnergyIdxOffset energy
 access to the interaction energy handler of the super class
 
OutputHandler & output
 access to the output handler of the super class
 
PredictionTracker * predTracker
 access to the prediction tracker of the super class
 
- Protected Attributes inherited from IntaRNA::PredictorMfe
InteractionList mfeInteractions
 mfe interaction boundaries
 
HashIdx2E mfe4leftEnd
 
std::pair< IndexRangeList, IndexRangeList > reportedInteractions
 
InteractionEnergyIdxOffset energy
 access to the interaction energy handler of the super class
 
OutputHandler & output
 access to the output handler of the super class
 
PredictionTracker * predTracker
 access to the prediction tracker of the super class
 
- Protected Attributes inherited from IntaRNA::Predictor
InteractionEnergyIdxOffset energy
 energy computation handler
 
OutputHandler & output
 interaction output handler
 
PredictionTracker * predTracker
 prediction tracker to be used
 
Z_type Zall
 

Additional Inherited Members

- Static Public Member Functions inherited from IntaRNA::Predictor
static size_t getMaxInteractionWidth (const size_t w, const size_t maxLoopSize)
 

Detailed Description

Memory efficient ensemble interaction predictor that uses a heuristic to find the mfe or a close-to-mfe interaction.

To this end, for each interaction start i1,i2 only the optimal right side interaction with boundaries j1,j2 is considered in the recursion instead of all possible interaction ranges.

This yields a quadratic time and space complexity.

Author
Martin Raden
Frank Gelhausen

Member Typedef Documentation

◆ Z2dMatrix

matrix type to hold the mfe energies and boundaries for interaction site starts

Constructor & Destructor Documentation

◆ PredictorMfeEns2dHeuristic()

IntaRNA::PredictorMfeEns2dHeuristic::PredictorMfeEns2dHeuristic ( const InteractionEnergy &  energy,
OutputHandler &  output,
PredictionTracker *  predTracker 
)

Constructs a predictor and stores the energy and output handler

Parameters
energythe interaction energy handler
outputthe output handler to report mfe interactions to
predTrackerthe prediction tracker to be used or NULL if no tracking is to be done; if non-NULL, the tracker gets deleted on this->destruction.

◆ ~PredictorMfeEns2dHeuristic()

virtual IntaRNA::PredictorMfeEns2dHeuristic::~PredictorMfeEns2dHeuristic ( )
virtual

Member Function Documentation

◆ fillHybridZ()

virtual void IntaRNA::PredictorMfeEns2dHeuristic::fillHybridZ ( )
protectedvirtual

Computes all entries of the hybridE matrix and reports all valid interactions via updateOptima()

◆ predict()

virtual void IntaRNA::PredictorMfeEns2dHeuristic::predict ( const IndexRange &  r1 = IndexRange(0, RnaSequence::lastPos),
const IndexRange &  r2 = IndexRange(0, RnaSequence::lastPos) 
)
virtual

Computes the mfe for the given sequence ranges (i1-j1) in the first sequence and (i2-j2) in the second sequence and reports it to the output handler.

Parameters
r1the index range of the first sequence interacting with r2
r2the index range of the second sequence interacting with r1

Reimplemented from IntaRNA::PredictorMfeEns2d.

Member Data Documentation

◆ energy

InteractionEnergyIdxOffset IntaRNA::Predictor::energy
protected

access to the interaction energy handler of the super class

◆ hybridZ

Z2dMatrix IntaRNA::PredictorMfeEns2dHeuristic::hybridZ
protected

energy of all interaction hybrids starting in i1,i2

◆ output

OutputHandler& IntaRNA::Predictor::output
protected

access to the output handler of the super class


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