countl_zero.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2019 Tobias Hienzsch
 
#ifndef TETL_BIT_COUNTL_ZERO_HPP
#define TETL_BIT_COUNTL_ZERO_HPP
 
#include <etl/_concepts/builtin_unsigned_integer.hpp>
#include <etl/_limits/numeric_limits.hpp>
 
namespace etl {
 
/// \brief Returns the number of consecutive 0 bits in the value of x, starting
/// from the most significant bit ("left").
///
/// \details This overload only participates in overload resolution if UInt is an
/// unsigned integer type (that is, unsigned char, unsigned short, unsigned int,
/// unsigned long, unsigned long long, or an extended unsigned integer type).
///
/// \returns The number of consecutive 0 bits in the value of x, starting from
/// the most significant bit.
///
/// \ingroup bit
template <etl::builtin_unsigned_integer UInt>
[[nodiscard]] constexpr auto countl_zero(UInt x) noexcept -> int
{
    auto const totalBits = etl::numeric_limits<UInt>::digits;
    if (x == UInt(0)) {
        return etl::numeric_limits<UInt>::digits;
    }
 
    auto res = 0;
    while (not(x & (UInt(1) << (static_cast<UInt>(totalBits) - UInt(1))))) {
        x = static_cast<UInt>(x << UInt(1));
        ++res;
    }
 
    return res;
}
 
} // namespace etl
 
#endif // TETL_BIT_COUNTL_ZERO_HPP