simple_binning.hpp

// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <cassert>   // for assert
#include <cstddef>   // for size_t
#include <memory>    // for addressof
#include <stdexcept> // for runtime_error
#include <vector>    // for vector
 
#include <hibf/layout/data_store.hpp>        // for data_store
#include <hibf/misc/next_multiple_of_64.hpp> // for next_multiple_of_64
 
namespace seqan::hibf::layout
{
 
class simple_binning
{
private:
    data_store * data{nullptr};
 
    size_t num_user_bins{};
 
    size_t num_technical_bins{};
 
public:
    simple_binning() = default;                                  
    simple_binning(simple_binning const &) = delete;             
    simple_binning & operator=(simple_binning const &) = delete; 
    simple_binning(simple_binning &&) = default;                 
    simple_binning & operator=(simple_binning &&) = default;     
    ~simple_binning() = default;                                 
 
    simple_binning(data_store & data_, size_t const num_bins = 0) :
        data{std::addressof(data_)},
        num_user_bins{data->positions.size()},
        num_technical_bins{num_bins ? num_bins : next_multiple_of_64(num_user_bins)}
    {
        assert(data != nullptr);
 
        if (num_user_bins > num_technical_bins)
        {
            throw std::runtime_error{"You cannot have less technical bins than user bins for this simple binning "
                                     "algorithm. Please see the hierarchical_binning algorithm or increase the number "
                                     "of technical bins."};
        }
    }
 
    size_t get_num_technical_bins() const
    {
        return num_technical_bins;
    }
 
    size_t execute();
};
 
} // namespace seqan::hibf::layout