BankStats Struct Reference

Statistics about banks. More...

#include <BankKmers.hpp>

Public Member Functions
	BankStats ()
void	update (bank::Sequence &sequence)
BankStats &	operator+= (const BankStats &other)
double	getSeqMean ()
double	getSeqDeviation ()

Detailed Description

Statistics about banks.

This structure allows to gather information about sequences while iterating banks. An BankStats object can be updated through the update method during such an iteration.

Constructor & Destructor Documentation

BankStats ( )

inline

Constructor.

Member Function Documentation

double getSeqDeviation ( )

inline

Get the deviation size of sequences.

Returns

the deviation size.

double getSeqMean ( )

inline

Get the mean size of sequences.

Returns

the mean size.

BankStats& operator+= ( const BankStats &  other )

inline

Concatenation of the current BankStats object with another one.

Parameters

[in]

other

: the instance used to update the current instance.

void update ( bank::Sequence &  sequence )

inline

Update the statistics with the information of the provided sequence

Parameters

[in]

sequence

: sequence used to update the statistics.

---

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

• /builds/workspace/publish-doc-api-gitlab/gatb-core/src/gatb/kmer/impl/BankKmers.hpp