DualBarcodesPairedEndWithDiagnostics.hpp

Go to the documentation of this file.

#ifndef KAORI_DUAL_BARCODES_PAIRED_END_WITH_DIAGNOSTICS_HPP
#define KAORI_DUAL_BARCODES_PAIRED_END_WITH_DIAGNOSTICS_HPP
 
#include "DualBarcodesPairedEnd.hpp"
#include "CombinatorialBarcodesPairedEnd.hpp"
#include "../utils.hpp"
 
namespace kaori {
 
template<SeqLength max_size_>
class DualBarcodesPairedEndWithDiagnostics { 
public:
    DualBarcodesPairedEndWithDiagnostics(
        const char* template_seq1, SeqLength template_length1, const BarcodePool& barcode_pool1,
        const char* template_seq2, SeqLength template_length2, const BarcodePool& barcode_pool2, 
        const typename DualBarcodesPairedEnd<max_size_>::Options& options
    ) :
        my_dual_handler(
            template_seq1,
            template_length1,
            barcode_pool1,
            template_seq2,
            template_length2,
            barcode_pool2,
            options
        ),
        my_combo_handler(
            template_seq1, 
            template_length1, 
            barcode_pool1, 
            template_seq2, 
            template_length2, 
            barcode_pool2, 
            [&]{
                typename CombinatorialBarcodesPairedEnd<max_size_>::Options combopt;
                combopt.use_first = options.use_first;
 
                combopt.max_mismatches1 = options.max_mismatches1;
                combopt.strand1 = options.strand1;
                combopt.max_mismatches2 = options.max_mismatches2;
                combopt.strand2 = options.strand2;
 
                // we allow duplicates in the trie for each individual barcode, as only the pairs are unique in the dual barcode setup.
                combopt.duplicates = DuplicateAction::FIRST; 
                combopt.random = options.random;
                return combopt;
            }()
        )
    {}
 
private:
    DualBarcodesPairedEnd<max_size_> my_dual_handler;
    CombinatorialBarcodesPairedEnd<max_size_> my_combo_handler;
 
public:
    struct State {
        State() {}
        State(typename DualBarcodesPairedEnd<max_size_>::State ds, typename CombinatorialBarcodesPairedEnd<max_size_>::State cs) : dual_state(std::move(ds)), combo_state(std::move(cs)) {}
 
        typename DualBarcodesPairedEnd<max_size_>::State dual_state;
        typename CombinatorialBarcodesPairedEnd<max_size_>::State combo_state;
    };
 
    State initialize() const {
        return State(my_dual_handler.initialize(), my_combo_handler.initialize());
    }
 
    void reduce(State& s) {
        my_dual_handler.reduce(s.dual_state);
        my_combo_handler.reduce(s.combo_state);
    }
 
    constexpr static bool use_names = false;
public:
    void process(State& state, const std::pair<const char*, const char*>& r1, const std::pair<const char*, const char*>& r2) const {
        // Only searching for combinations if we couldn't find a proper dual barcode match.
        if (!my_dual_handler.process(state.dual_state, r1, r2)) {
            my_combo_handler.process(state.combo_state, r1, r2);
        }
    }
public:
    const std::vector<Count>& get_counts() const {
        return my_dual_handler.get_counts();
    }
 
    const std::unordered_map<std::array<BarcodeIndex, 2>, Count, CombinationHash<2> >& get_combinations() const {
        return my_combo_handler.get_combinations();
    }
 
    Count get_total() const {
        return my_dual_handler.get_total();
    }
 
    Count get_barcode1_only() const {
        return my_combo_handler.get_barcode1_only();
    }
 
    Count get_barcode2_only() const {
        return my_combo_handler.get_barcode2_only();
    }
};
 
// Soft-deprecated back-compatible aliases.
template<SeqLength max_size_>
using DualBarcodesWithDiagnostics = DualBarcodesPairedEndWithDiagnostics<max_size_>;
}
 
#endif