001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
117:
118:
119:
120:
121:
122:
123:
124:
125:
126:
127:
128:
129:
130:
131:
132:
133:
134:
135:
136:
137:
138:
139:
140:
141:
142:
143:
144:
145:
146:
147:
148:
149:
150:
151:
152:
153:
154:
155:
156:
157:
158:
159:
160:
161:
162:
163:
164:
165:
166:
167:
168:
169:
170:
171:
172:
173:
174:
175:
176:
177:
178:
179:
180:
181:
182:
183:
184:
185:
/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if !defined(OMNI_BITS_HPP)
#define OMNI_BITS_HPP 1
#include <omni/defs/global.hpp>
#include <climits>
#define OMNI_XOR_SWAP(a, b) a ^= b; b ^= a; a ^= b
#define OMNI_VAL_HAS_FLAG_BIT(val, flag) ((val & flag) == flag)
#define OMNI_VAL_SET_FLAG_BOOL(val, flag, onoff) val = (onoff ? (val | flag) : ((val | flag) ^ flag))
#define OMNI_VAL_SET_FLAG_BIT(val, flag) val = (val | flag)
#define OMNI_VAL_UNSET_FLAG_BIT(val, flag) val = ((val | flag) ^ flag)
#define OMNI_IS_N_BIT_SET(val, n) ((val & (1 << n)) == (1 << n))
#define OMNI_SET_N_BIT(val, n) val = (val | (1 << n))
#define OMNI_UNSET_N_BIT(val, n) val = ((val | (1 << n)) ^ (1 << n))
#define OMNI_SIZEOF_BITS(T) (sizeof(T) * CHAR_BIT)
namespace omni {
namespace util {
namespace bits {
/**
* @brief Brief
*
* @details Details
*
* @exception Errors
*
* @warning Consideration
*
* @attention Platform
*
* @note Notes
*
* @tparam T Parameter_Description
* @tparam F Parameter_Description
*
* @param t Parameter_Description
* @param flag Parameter_Description
*
* @return Return_Description
*/
template <
typename T,
typename F >
inline bool has_flag(
const T& t, F flag)
{
return OMNI_VAL_HAS_FLAG_BIT(t, flag);
}
template <
typename T,
typename F >
inline T& set_flag(T& t, F flag,
bool set)
{
if (set) {
return (
OMNI_VAL_SET_FLAG_BIT(t, flag)); }
return (
OMNI_VAL_UNSET_FLAG_BIT(t, flag));
}
template <
typename T,
typename F >
inline T& set_flag(T& t, F flag)
{
return (
OMNI_VAL_SET_FLAG_BIT(t, flag));
}
template <
typename T,
typename F >
inline T& unset_flag(T& t, F flag)
{
return (
OMNI_VAL_UNSET_FLAG_BIT(t, flag));
}
template <
typename T >
inline bool is_set_nc(
const T& t,
unsigned short n)
{
std::size_t v = (
1 << n);
return ((t & v) == v);
}
template <
typename T >
inline T& set_nc(T& t,
unsigned short n,
bool s)
{
std::size_t v = (
1 << n);
if (s) {
return (t = (t | v)); }
// set
return (t = ((t | v) ^ v));
// unset
}
template <
typename T >
inline T& set_nc(T& t,
unsigned short n)
{
return (t = (t | (
1 << n)));
}
template <
typename T >
inline T& unset_nc(T& t,
unsigned short n)
{
std::size_t v = (
1 << n);
return (t = ((t | v) ^ v));
}
template <
typename T >
inline bool is_set(
const T& t,
unsigned short n)
{
if (n >
OMNI_SIZEOF_BITS(T)) {
OMNI_ERRV_RETV_FW(n,
" > sizeof(T)",
omni::index_out_of_range(
"Invalid bit", n),
false)
}
std::size_t v = (
1 << n);
return ((t & v) == v);
}
template <
typename T >
inline T& set(T& t,
unsigned short n,
bool s)
{
if (n >
OMNI_SIZEOF_BITS(T)) {
OMNI_ERRV_RETV_FW(n,
" > sizeof(T)",
omni::index_out_of_range(
"Invalid bit", n),
false)
}
std::size_t v = (
1 << n);
if (s) {
return (t = (t | v)); }
return (t = ((t | v) ^ v));
}
template <
typename T >
inline T& set(T& t,
unsigned short n)
{
if (n >
OMNI_SIZEOF_BITS(T)) {
OMNI_ERRV_RETV_FW(n,
" > sizeof(T)",
omni::index_out_of_range(
"Invalid bit", n),
false)
}
return (t = (t | (
1 << n)));
}
template <
typename T >
inline T& unset(T& t,
unsigned short n)
{
if (n >
OMNI_SIZEOF_BITS(T)) {
OMNI_ERRV_RETV_FW(n,
" > sizeof(T)",
omni::index_out_of_range(
"Invalid bit", n),
false)
}
std::size_t v = (
1 << n);
return (t = ((t | v) ^ v));
}
template <
typename T >
inline void xor_swap(T& a, T& b)
{
if (a != b) {
OMNI_XOR_SWAP(a, b);
// a ^= b; b ^= a; a ^= b
}
}
template <
typename T >
inline std::size_t size()
{
return OMNI_SIZEOF_BITS(T);
// (sizeof(T) * CHAR_BIT)
}
template <
typename T >
inline std::size_t size(
const T& obj)
{
return OMNI_SIZEOF_BITS(obj);
// (sizeof(obj) * CHAR_BIT)
}
}
// namespace bits
}
// namespace util
}
#endif // OMNI_BITS_HPP