IntaRNA 3.5.0-pre
RNA-RNA interaction prediction | C++ API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
IntaRNA::OutputHandlerMfe Class Reference

#include <OutputHandlerMfe.h>

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

Public Member Functions

 OutputHandlerMfe (OutputHandler *output, const InteractionEnergy &energy, SeedHandler *seedHandler=NULL)
 
virtual ~OutputHandlerMfe () override
 Destruction of the owned output and seed handlers.
 
void add (const Interaction &interaction) override
 
size_t reported () const override
 
void incrementZ (Z_type subZ) override
 Forward partition totals to the wrapped output handler.
 
Z_type getZ () const override
 
void setExactPartition (bool exact) override
 Forward exact-partition presentation policy.
 
- Public Member Functions inherited from IntaRNA::OutputHandler
 OutputHandler (const OutputConstraint &outConstraint)
 
virtual ~OutputHandler ()
 
const OutputConstraint & getOutputConstraint () const
 
bool usesExactPartition () const
 
bool hasNonzeroZ () const
 

Additional Inherited Members

- Static Public Member Functions inherited from IntaRNA::OutputHandler
static std::string reverse (const std::string &str)
 
- Protected Attributes inherited from IntaRNA::OutputHandler
bool exactPartition = false
 scoped to a supported sequence-pair ensemble, legacy outputs default false
 
const OutputConstraint outConstraint
 the output constraints to be applied
 
size_t reportedInteractions
 number of reported interactions
 
Z_type Z
 overall partition function for the sequences provided in Z_energy
 

Detailed Description

Final-output adapter for interactions selected by ensemble energy.

The predictor-provided energy is retained as Interaction::ensembleEnergy. For each interaction that reaches this adapter, the minimum-free-energy structure with the same boundaries and seed requirements is traced and its energy is stored in Interaction::energy before forwarding. This keeps the additional MFE computation proportional to the final reported result count.

Constructor & Destructor Documentation

◆ OutputHandlerMfe()

IntaRNA::OutputHandlerMfe::OutputHandlerMfe ( OutputHandler *  output,
const InteractionEnergy &  energy,
SeedHandler *  seedHandler = NULL 
)

Construction takes ownership of both supplied handlers.

Parameters
outputfinal output handler receiving representative structures
energyinteraction energy model used for the ensemble prediction
seedHandleroptional seed handler; NULL denotes seed-free prediction

◆ ~OutputHandlerMfe()

virtual IntaRNA::OutputHandlerMfe::~OutputHandlerMfe ( )
overridevirtual

Destruction of the owned output and seed handlers.

Member Function Documentation

◆ add()

void IntaRNA::OutputHandlerMfe::add ( const Interaction &  interaction)
overridevirtual

Trace and forward one representative MFE interaction.

Parameters
interactionensemble-selected interaction boundaries

Implements IntaRNA::OutputHandler.

◆ getZ()

Z_type IntaRNA::OutputHandlerMfe::getZ ( ) const
overridevirtual
Returns
partition total of the wrapped output handler

Reimplemented from IntaRNA::OutputHandler.

◆ incrementZ()

void IntaRNA::OutputHandlerMfe::incrementZ ( Z_type  subZ)
overridevirtual

Forward partition totals to the wrapped output handler.

Reimplemented from IntaRNA::OutputHandler.

◆ reported()

size_t IntaRNA::OutputHandlerMfe::reported ( ) const
overridevirtual
Returns
number of interactions forwarded by the wrapped output handler

Reimplemented from IntaRNA::OutputHandler.

◆ setExactPartition()

void IntaRNA::OutputHandlerMfe::setExactPartition ( bool  exact)
overridevirtual

Forward exact-partition presentation policy.

Reimplemented from IntaRNA::OutputHandler.


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