bit_manipulation.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <cassert>
 
#include <seqan3/utility/detail/bits_of.hpp>
#include <seqan3/utility/detail/to_little_endian.hpp>
 
SEQAN3_DEPRECATED_HEADER("This header is deprecated and will be removed in SeqAn-3.1.0; Please #include <seqan3/std/bit> XOR <seqan3/utility/detail/bits_of.hpp> XOR <seqan3/utility/detail/to_little_endian.hpp> instead.")
 
#ifdef SEQAN3_DEPRECATED_310
namespace seqan3::detail
{
template <typename type_t>
SEQAN3_DEPRECATED_310 constexpr auto sizeof_bits = seqan3::detail::bits_of<type_t>;
 
SEQAN3_DEPRECATED_310 constexpr bool is_power_of_two(size_t const n)
{
    return std::has_single_bit(n);
}
 
SEQAN3_DEPRECATED_310 constexpr size_t next_power_of_two(size_t n)
{
    return std::bit_ceil(n);
}
 
template <std::unsigned_integral unsigned_t>
SEQAN3_DEPRECATED_310 constexpr uint8_t popcount(unsigned_t const n) noexcept
{
    return std::popcount(n);
}
 
template <std::unsigned_integral unsigned_t>
SEQAN3_DEPRECATED_310 constexpr uint8_t count_leading_zeros(unsigned_t const n) noexcept
{
    assert(n > 0); // n == 0 might have undefined behaviour
    return std::countl_zero(n);
}
 
template <std::unsigned_integral unsigned_t>
SEQAN3_DEPRECATED_310 constexpr uint8_t count_trailing_zeros(unsigned_t const n) noexcept
{
    assert(n > 0); // n == 0 might have undefined behaviour
    return std::countr_zero(n);
}
 
template <std::unsigned_integral unsigned_t>
SEQAN3_DEPRECATED_310 constexpr uint8_t most_significant_bit_set(unsigned_t const n) noexcept
{
    assert(n > 0); // n == 0 might have undefined behaviour
    return std::bit_width(n) - 1;
}
 
} // namespace seqan3::detail
#endif // SEQAN3_DEPRECATED_310