kaori
A C++ library for barcode extraction and matching
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
kaori::BarcodePool Struct Reference

Pool of barcode sequences for a variable region. More...

#include <BarcodePool.hpp>

Public Member Functions

 BarcodePool ()
 
 BarcodePool (std::vector< const char * > barcode_pool, size_t barcode_length)
 
 BarcodePool (const std::vector< std::string > &barcode_pool)
 
size_t size () const
 
const char * operator[] (size_t i) const
 

Public Attributes

std::vector< const char * > pool
 
size_t length = 0
 

Detailed Description

Pool of barcode sequences for a variable region.

The BarcodePool class defines the pool of possible barcode sequences for a given variable region in the template sequence. All sequences in this set are assumed to have the same length.

Constructor & Destructor Documentation

◆ BarcodePool() [1/3]

kaori::BarcodePool::BarcodePool ( )
inline

Default constructor.

◆ BarcodePool() [2/3]

kaori::BarcodePool::BarcodePool ( std::vector< const char * >  barcode_pool,
size_t  barcode_length 
)
inline
Parameters
barcode_poolVector of pointers to sequences of length l, containing the pool of possible barcode sequences.
barcode_lengthLength of each sequence.

◆ BarcodePool() [3/3]

kaori::BarcodePool::BarcodePool ( const std::vector< std::string > &  barcode_pool)
inline
Parameters
barcode_poolVector of sequences of the same length, containing the pool of possible barcode sequences.

It is assumed that the lifetime of barcode_pool (and its strings) exceeds that of the constructed BarcodePool.

Member Function Documentation

◆ operator[]()

const char * kaori::BarcodePool::operator[] ( size_t  i) const
inline
Parameters
iIndex of the barcode sequence of interest.
Returns
Pointer to the i-th sequence in the pool.

◆ size()

size_t kaori::BarcodePool::size ( ) const
inline
Returns
Number of sequences in the pool.

Member Data Documentation

◆ length

size_t kaori::BarcodePool::length = 0

Length of each sequence in pool.

◆ pool

std::vector<const char*> kaori::BarcodePool::pool

Vector containing pointers to sequences of length len.


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