gatb.core-API-1.4.2
Kmer< span >::Count Struct Reference

Structure associating a kmer value with an abundance value. More...

#include <Model.hpp>

Inheritance diagram for Kmer< span >::Count:
Inheritance graph

Public Member Functions

 Count (const Type &val, const CountNumber &abund)
 
 Count ()
 
 Count (const Count &val)
 
bool operator< (const Count &other) const
 
bool operator== (const Count &other) const
 
- Public Member Functions inherited from Abundance< Type, CountNumber >
 Abundance (const Type &val, const CountNumber &abund)
 
Abundanceoperator= (const Abundance &a)
 
const CountNumbergetAbundance () const
 
const Type & getValue () const
 
bool operator== (const Abundance &other) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Abundance< Type, CountNumber >
static hid_t hdf5 (bool &isCompound)
 

Detailed Description

template<size_t span = KMER_DEFAULT_SPAN>
struct gatb::core::kmer::impl::Kmer< span >::Count

Structure associating a kmer value with an abundance value.

This structure is useful for methods that counts kmer, such as the SortingCount algorithm. It is also interesting to save [kmer,abundance] in a HDF5 format.

By default, the abundance value is coded on 32 bits, so abundance up to 1<<32 can be used.

Constructor & Destructor Documentation

Count ( const Type val,
const CountNumber abund 
)
inline

Constructor.

Parameters
[in]val: integer value of the kmer
[in]abund: abundance for the kmer
Count ( )
inline

Default constructor.

Count ( const Count val)
inline

Copy constructor.

Member Function Documentation

bool operator< ( const Count other) const
inline

Comparison operator

Parameters
[in]other: object to be compared to
Returns
true if the provided kmer value is greater than the current one.
bool operator== ( const Count other) const
inline

Equal operator

Parameters
[in]other: object to be compared to
Returns
true if the provided kmer value is greater than the current one.

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