multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Classes | Public Member Functions | List of all members
multovl::prob::Stat Class Reference

#include "stat.hh"

Classes

class  Distr
 
class  NotfoundException
 

Public Member Functions

 Stat ()
 Init to default (empty).
 
void add (unsigned int multiplicity, double val, bool is_actual=false)
 
void evaluate ()
 Evaluates the distributions inside.
 
const Distrdistr (unsigned int multiplicity) const throw (NotfoundException)
 
unsigned int min_mult () const
 
unsigned int max_mult () const
 

Detailed Description

Utility to collect actual overlap data and the corresponding null distribution estimates (obtained by shuffling) grouped by multiplicity. The values collected are of type double although in most cases they are actually integers, but let's stay generic.

Member Function Documentation

void multovl::prob::Stat::add ( unsigned int  multiplicity,
double  val,
bool  is_actual = false 
)

Adds a value to the calling object.

Parameters
multiplicitythe multiplicity of the overlap for which the total overlap length is provided. Should be >= 2
valthe value to be added
is_actualtrue if /value/ is an actual value, ie. before shuffling. false (the default) if /val/ is a value obtained in one of the shuffling rounds.
const Distr& multovl::prob::Stat::distr ( unsigned int  multiplicity) const
throw (NotfoundException
)

Look up the Distr object belonging to a given multiplicity.

Parameters
multiplicityis the multiplicity
Returns
the Distr object belonging to /multiplicity/
Exceptions
Stat::NotfoundExceptionif /multiplicity/ has not been seen
unsigned int multovl::prob::Stat::max_mult ( ) const
inline
Returns
the maximal multiplicity seen so far
unsigned int multovl::prob::Stat::min_mult ( ) const
inline
Returns
the minimal multiplicity seen so far

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