ppALIGN API documentation

DriverFirstMoment Class Reference

#include <firstmoment.hpp>

Inheritance diagram for DriverFirstMoment:
PartitionDriverBase

List of all members.

Public Member Functions

 DriverFirstMoment (const ScoreMatrix &score, int gap_open, int gap_extension)
virtual bool NeedForward ()
virtual void OnForward (long i, const PartitionWorkspace::RowInfo &last_row, const PartitionWorkspace::RowInfo &curr_row, const PartitionWorkspace::const_iterator last, const PartitionWorkspace::const_iterator curr)
double FirstMoment ()
events before and after the computation



virtual void BeforeComputation ()
virtual void AfterComputation ()

Detailed Description

A driver to compute the expected score.

This driver computes the expected score according to the probabilistic alignment model.

Examples:

freescore.cpp.

Definition at line 83 of file firstmoment.hpp.


Constructor & Destructor Documentation

DriverFirstMoment::DriverFirstMoment ( const ScoreMatrix score,
int  gap_open,
int  gap_extension 
)

Constructor. The constructor requires the parameters of the scoring function for which the expected score should be computed.

Parameters:
score the scoring matrix
gap_open the gap open parameter
gap_extension the gap extension parameter

Member Function Documentation

virtual void DriverFirstMoment::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 DriverFirstMoment::BeforeComputation (  )  [virtual]

An event that is thrown before the acutal computation begins.

Reimplemented from PartitionDriverBase.

double DriverFirstMoment::FirstMoment (  ) 

The result. The computed first moment is available after the computation.

Returns:
expected score
Examples:
freescore.cpp.
virtual bool DriverFirstMoment::NeedForward (  )  [inline, virtual]

Requirement. We need the forward partition functions from the main algorithm.

Reimplemented from PartitionDriverBase.

Definition at line 103 of file firstmoment.hpp.

virtual void DriverFirstMoment::OnForward ( long  i,
const PartitionWorkspace::RowInfo last_row,
const PartitionWorkspace::RowInfo curr_row,
const PartitionWorkspace::const_iterator  last,
const PartitionWorkspace::const_iterator  curr 
) [virtual]

Callback. The main computation of the weighted partition functions.

Reimplemented from PartitionDriverBase.


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