EnrichmentRecord< S, T > Struct Template Reference

#include <enrichment.h>

List of all members.

Public Member Functions
string	itoa (int in)
void	print (ostream &fstr)
string	reason ()
const bool	operator< (const EnrichmentRecord< S, T > &comp) const
const bool	operator== (const EnrichmentRecord< S, T > &comp) const
Public Attributes
double	score
T	relation
int	gTotal
int	gTrue
int	lTotal
int	lTrue
set< S >	annotated

---

Detailed Description

template<class S, class T>
struct EnrichmentRecord< S, T >

A structure returned to encapsulate a T object enrichment score in respect to a set of S objects. Typically, T is a function and S is a set of objects (genes or protein, for example) annotated with that function.

---

Member Function Documentation

template<class S, class T>

const bool EnrichmentRecord< S, T >::operator<

(

const EnrichmentRecord< S, T > &

comp

)

const [inline]

Less than comparison operator for sorting purposes, orders first by score, then by T element

template<class S, class T>

const bool EnrichmentRecord< S, T >::operator==

(

const EnrichmentRecord< S, T > &

comp

)

const [inline]

Equality comparison operator for sorting purposes, score and T element must be equal for equality

template<class S, class T>

string EnrichmentRecord< S, T >::reason

(

)

[inline]

Returns the hypergeometric values in a human readable "explanation" format

---

Member Data Documentation

template<class S, class T>

set<S> EnrichmentRecord< S, T >::annotated

The set of S objects that have the function described by relation

template<class S, class T>

int EnrichmentRecord< S, T >::gTotal

The hypergeometric value for Global Total that resulted in the score calculated

template<class S, class T>

int EnrichmentRecord< S, T >::gTrue

The hypergeometric value for Global True that resulted in the score calculated

template<class S, class T>

int EnrichmentRecord< S, T >::lTotal

The hypergeometric value for Local Total that resulted in the score calculated

template<class S, class T>

int EnrichmentRecord< S, T >::lTrue

The hypergeometric value for Local True that resulted in the score calculated

template<class S, class T>

T EnrichmentRecord< S, T >::relation

The T object that this enrichment score was calculated for

template<class S, class T>

double EnrichmentRecord< S, T >::score

The functional enrichment score calculated

---

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

• /home/poirel/src/c++/biorithm/libutil/enrichment.h