shape.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <seqan3/utility/container/dynamic_bitset.hpp>
 
namespace seqan3
{
 
struct ungapped
{
    uint8_t value;
};
 
struct bin_literal
{
    uint64_t value;
};
 
class shape : public dynamic_bitset<58>
{
public:
    constexpr shape() noexcept = default;                          
    constexpr shape(shape const &) noexcept = default;             
    constexpr shape(shape &&) noexcept = default;                  
    constexpr shape & operator=(shape const &) noexcept = default; 
    constexpr shape & operator=(shape &&) noexcept = default;      
    ~shape() noexcept = default;                                   
 
    constexpr shape(ungapped k) noexcept : dynamic_bitset<58>((1ULL << k.value) - 1)
    {
        assert(k.value > 0);
    }
 
    constexpr shape(bin_literal const literal) noexcept : dynamic_bitset<58>(literal.value)
    {
        assert(front() == 1); // First position must be 1, e.g. no 0111 shape
        assert(back() == 1);  // Last position must be 1, e.g. no 1110 shape
    }
};
 
inline namespace literals
{
 
constexpr shape operator""_shape(unsigned long long const value)
{
    return shape{bin_literal{value}};
}
 
} // namespace literals
 
} // namespace seqan3