flip_bit.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2024 Tobias Hienzsch
 
#ifndef TETL_BIT_FLIP_BIT_HPP
#define TETL_BIT_FLIP_BIT_HPP
 
#include <etl/_concepts/builtin_unsigned_integer.hpp>
#include <etl/_contracts/check.hpp>
#include <etl/_cstddef/size_t.hpp>
#include <etl/_limits/numeric_limits.hpp>
 
namespace etl {
 
/// Flip bit at position \p pos
/// \details https://stackoverflow.com/questions/47981/how-to-set-clear-and-toggle-a-single-bit
/// \pre Position \p pos must be a valid bit-index for UInt
/// \note Non-standard extension
/// \ingroup bit
template <etl::builtin_unsigned_integer UInt>
[[nodiscard]] constexpr auto flip_bit(UInt word, UInt pos) noexcept -> UInt
{
    TETL_PRECONDITION(static_cast<int>(pos) < etl::numeric_limits<UInt>::digits);
    return static_cast<UInt>(word ^ static_cast<UInt>(UInt(1) << pos));
}
 
/// Flip bit at position Pos
/// \details https://stackoverflow.com/questions/47981/how-to-set-clear-and-toggle-a-single-bit
/// \note Non-standard extension
/// \ingroup bit
template <etl::size_t Pos, etl::builtin_unsigned_integer UInt>
[[nodiscard]] constexpr auto flip_bit(UInt word) noexcept -> UInt
{
    static_assert(Pos < etl::numeric_limits<UInt>::digits);
    return etl::flip_bit(word, static_cast<UInt>(Pos));
}
 
} // namespace etl
 
#endif // TETL_BIT_FLIP_BIT_HPP