summary_by_lane_read< T > Class Template Reference

#include <summary_statistics.h>

Public Types
typedef std::vector< T >	vector_t
typedef std::vector< vector_t >	vector2d_t
typedef std::vector< vector2d_t >	vector3d_t
typedef vector_t::const_iterator	const_iterator
typedef vector3d_t::iterator	read_iterator
typedef vector_t::const_reference	const_reference

Public Member Functions
	summary_by_lane_read (const model::summary::run_summary &run, const ptrdiff_t n, const size_t surface_count=1)
vector_t &	operator() (const size_t read, const size_t lane, const size_t surface=0)
void	clear ()
size_t	size () const
size_t	read_count () const
size_t	lane_count () const
size_t	surface_count () const

Detailed Description

template<typename T>
class illumina::interop::logic::summary::summary_by_lane_read< T >

Collection of values organized by read, then lane per read

Member Typedef Documentation

typedef vector_t::const_iterator const_iterator

Iterator to vector of values

typedef vector_t::const_reference const_reference

Constant reference to value

typedef vector3d_t::iterator read_iterator

Iterator over read vector (vector of vector of vector of values)

typedef std::vector<vector_t> vector2d_t

Vector of vector of values

typedef std::vector<vector2d_t> vector3d_t

Vector of vector of vector of values

typedef std::vector<T> vector_t

Vector of values

Constructor & Destructor Documentation

summary_by_lane_read ( const model::summary::run_summary &  run, const ptrdiff_t  n, const size_t  surface_count = 1  )

inline

Constructor

Parameters

run	run summary
n	maximum number of values expected
surface_count	number of surfaces

Member Function Documentation

void clear ( )

inline

Clear the vector of values in each read/lane

size_t lane_count ( ) const

inline

Number of lanes

Returns

number of lanes

vector_t& operator() ( const size_t  read, const size_t  lane, const size_t  surface = 0  )

inline

Access vector of values at given read and lane

Parameters

read	read index (0-indexed)
lane	lane index (0-indexed)
surface	surface index (0-indexed)

Returns

vector of values

size_t read_count ( ) const

inline

Size of read vector

Returns

number of reads

size_t size ( ) const

inline

Size of vector

Returns

number of reads

size_t surface_count ( ) const

inline

Number of surfaces

Returns

number of surfaces

---

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

• /io/interop/logic/summary/summary_statistics.h