HIBF 1.0.0-rc.1
All Classes Namespaces Files Functions Variables Typedefs Friends Macros Modules Pages Concepts
seqan::hibf::layout::hierarchical_binning Class Reference

Hierarchical binning algorithm. More...

#include <hibf/layout/hierarchical_binning.hpp>

Public Member Functions

size_t execute ()
 Executes the hierarchical binning algorithm and layouts user bins into technical bins.
 
 hierarchical_binning ()=default
 Defaulted.
 
 hierarchical_binning (data_store &data_, seqan::hibf::config const &config_)
 The constructor from user bin names, their kmer counts and a config.
 
 hierarchical_binning (hierarchical_binning &&)=default
 Defaulted.
 
 hierarchical_binning (hierarchical_binning const &)=delete
 Deleted. Would modify same data.
 
hierarchical_binningoperator= (hierarchical_binning &&)=default
 Defaulted.
 
hierarchical_binningoperator= (hierarchical_binning const &)=delete
 Deleted. Would modify same data.
 
 ~hierarchical_binning ()=default
 Defaulted.
 

Detailed Description

Hierarchical binning algorithm.

Constructor & Destructor Documentation

◆ hierarchical_binning()

seqan::hibf::layout::hierarchical_binning::hierarchical_binning ( data_store & data_,
seqan::hibf::config const & config_ )
inline

The constructor from user bin names, their kmer counts and a config.

Parameters
[in,out]data_Stores all data that is needed to compute the layout.
[in]config_A config object that holds information from the user that influence the computation.

Each entry in the names_ and input vector respectively is considered a user bin (both vectors must have the same length).


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