ppALIGN API documentation

DriverPosterDecode Class Reference

#include <posterdecode.hpp>

Inheritance diagram for DriverPosterDecode:
PartitionDriverBase

List of all members.

Classes

struct  Cell

Public Member Functions

void SetMaxSize (size_t mem)
virtual void BeforeComputation ()
virtual bool NeedForwardBackward ()
virtual void OnForwardBackward (PartitionWorkspace::ForwardBackwardInfo &fb_info)
virtual void AfterComputation ()
double Decode (Align &a)
double Decode ()

Detailed Description

Driver for max. posterior decoding

Examples:

alternative_alignments.cpp.

Definition at line 28 of file posterdecode.hpp.

Member Function Documentation

virtual void DriverPosterDecode::AfterComputation (  )  [virtual]

An event that is thrown when the complete computation has been finished, forward and evtl. backward if required.

Reimplemented from PartitionDriverBase.

virtual void DriverPosterDecode::BeforeComputation (  )  [virtual]

An event that is thrown before the acutal computation begins.

Reimplemented from PartitionDriverBase.

double DriverPosterDecode::Decode (  ) 

Determine the marginalized max. posterior alignment. The field PartitionDriverBase::alternative_alignments is resized to 1 and the result is written to PartitionDriverBase::alternative_alignments[0]

Returns:
averge posterior probability of the alignment
double DriverPosterDecode::Decode ( Align &  a  ) 

Determine the marginalized max. posterior alignment.

Parameters:
a reference alignment to be written
Returns:
averge posterior probability of the alignment
Examples:
alternative_alignments.cpp.
virtual bool DriverPosterDecode::NeedForwardBackward (  )  [inline, virtual]

Tell the main algorithm that a callback of OnForwardBackward() for each row is needed when the forward and backward rows are available simulationasly.

Returns:
true if the OnForwardBackward() method is to be called for each row every time the row is (re-)computed.

Reimplemented from PartitionDriverBase.

Definition at line 37 of file posterdecode.hpp.

virtual void DriverPosterDecode::OnForwardBackward ( PartitionWorkspace::ForwardBackwardInfo &  fb_info  )  [virtual]

An event that is thrown when both, the forward and the backward sums are available. The the checkpoint method in the main algorithm in PartitionWorkspace assures that each row is available in increasing index i

Parameters:
fb_info forward and backward data

Reimplemented from PartitionDriverBase.

void DriverPosterDecode::SetMaxSize ( size_t  mem  ) 

define the maximum memory to be used

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