Public Member Functions
	index_count_summary (const size_t id=0, const std::string &index1="", const std::string &index2="", const std::string &sample_id="", const std::string &project_name="", const ::uint64_t count=0, const float fraction_mapped=0.0f)

size_t	id () const

const std::string &	index1 () const

const std::string &	index2 () const

float	fraction_mapped () const

::uint64_t	cluster_count () const

const std::string &	sample_id () const

const std::string &	project_name () const

void	id (const size_t n)

index_count_summary &	operator+= (const ::uint64_t cluster_count)

void	update_fraction_mapped (const double total_pf_cluster_count)

bool	operator< (const index_count_summary &rhs) const

Friends
template<class MetricType , int Version>
struct	io::generic_layout

Detailed Description

Summary of index counts

Constructor & Destructor Documentation

inline

Constructor

Parameters

id	index unique identifier (based on a counter)
index1	index sequence 1
index2	index sequence 2
sample_id	sample id
project_name	project name
count	number of indices
fraction_mapped	fraction of reads mapped

void id ( const size_t n )

inline

Set the index unique identifier (based on a counter)

Parameters

n	index identifier

index_count_summary& operator+= ( const ::uint64_t cluster_count )

inline

Update the count

Parameters

cluster_count count to add

bool operator< ( const index_count_summary & rhs ) const

inline

Compare two index count summaries by their ids

Parameters

rhs	index_count_summary on the right hand side (rhs) of the < symbol

void update_fraction_mapped ( const double total_pf_cluster_count )

inline

Update the fraction mapped from the total PF cluster count

Parameters

total_pf_cluster_count total PF cluster count

friend

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