Detailed Description

Declaration of bit manipulation utility functions for the General Utility Library.

Date: Created on 17 October 2019

Copyright: Copyright 2019-2023 Deutsches Elektronen-Synchrotron (DESY), Hamburg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#include <cassert>
#include <type_traits>
#include "gul17/internal.h"

Include dependency graph for bit_manip.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	gul17
	Namespace gul17 contains all functions and classes of the General Utility Library.

Typedefs
template<typename T >
using	gul17::BitFunctionReturnType = std::enable_if_t< std::is_integral< T >::value and not std::is_same< std::decay_t< T >, bool >::value, std::decay_t< T > >
	Return type of the bit manipulation functions.

Enumerations
enum class	gul17::endian { gul17::endian::little , gul17::endian::big , gul17::endian::native }
	An enum to determine the endianness of multi-byte scalars on the current platform. More...

Functions
template<typename T = unsigned, typename ReturnT = BitFunctionReturnType<T>>
auto constexpr	gul17::bit_set (unsigned bit) noexcept -> ReturnT
	Set a bit in an integral type.

template<typename T , typename ReturnT = BitFunctionReturnType<T>>
auto constexpr	gul17::bit_set (T previous, unsigned bit) noexcept -> ReturnT
	Set a bit in an integral value.

template<typename T , typename ReturnT = BitFunctionReturnType<T>>
auto constexpr	gul17::bit_reset (T previous, unsigned bit) noexcept -> ReturnT
	Reset a bit in an integral value.

template<typename T , typename ReturnT = BitFunctionReturnType<T>>
auto constexpr	gul17::bit_flip (T previous, unsigned bit) noexcept -> ReturnT
	Flip a bit in an integral value.

template<typename T >
bool constexpr	gul17::bit_test (T bits, unsigned bit) noexcept
	Test a bit in an integral value.

constexpr bool	gul17::is_big_endian ()
	Determine whether this platform uses big-endian (Motorola) order for storing multi-byte quantities in memory.

constexpr bool	gul17::is_little_endian ()
	Determine whether this platform uses little-endian (Intel) order for storing multi-byte quantities in memory.

Detailed Description

Namespaces

Typedefs

Enumerations

Functions