00001:
00002:
00003:
00004:
00005:
00006:
00007:
00008:
00009:
000010:
000011:
000012:
000013:
000014:
000015:
000016:
000017:
000018:
000019:
000020:
000021:
000022:
000023:
000024:
000025:
000026:
000027:
000028:
000029:
000030:
000031:
000032:
000033:
000034:
000035:
000036:
000037:
000038:
000039:
000040:
000041:
000042:
000043:
000044:
000045:
000046:
000047:
000048:
000049:
000050:
000051:
000052:
000053:
000054:
000055:
000056:
000057:
000058:
000059:
000060:
000061:
000062:
000063:
000064:
000065:
000066:
000067:
000068:
000069:
000070:
000071:
000072:
000073:
000074:
000075:
000076:
000077:
000078:
000079:
000080:
000081:
000082:
000083:
000084:
000085:
000086:
000087:
000088:
000089:
000090:
000091:
000092:
000093:
000094:
000095:
000096:
000097:
000098:
000099:
0000100:
0000101:
0000102:
0000103:
0000104:
0000105:
0000106:
0000107:
0000108:
0000109:
0000110:
0000111:
0000112:
0000113:
0000114:
0000115:
0000116:
0000117:
0000118:
0000119:
0000120:
0000121:
0000122:
0000123:
0000124:
0000125:
0000126:
0000127:
0000128:
0000129:
0000130:
0000131:
0000132:
0000133:
0000134:
0000135:
0000136:
0000137:
0000138:
0000139:
0000140:
0000141:
0000142:
0000143:
0000144:
0000145:
0000146:
0000147:
0000148:
0000149:
0000150:
0000151:
0000152:
0000153:
0000154:
0000155:
0000156:
0000157:
0000158:
0000159:
0000160:
0000161:
0000162:
0000163:
0000164:
0000165:
0000166:
0000167:
0000168:
0000169:
0000170:
0000171:
0000172:
0000173:
0000174:
0000175:
0000176:
0000177:
0000178:
0000179:
0000180:
0000181:
0000182:
0000183:
0000184:
0000185:
0000186:
0000187:
0000188:
0000189:
0000190:
0000191:
0000192:
0000193:
0000194:
0000195:
0000196:
0000197:
0000198:
0000199:
0000200:
0000201:
0000202:
0000203:
0000204:
0000205:
0000206:
0000207:
0000208:
0000209:
0000210:
0000211:
0000212:
0000213:
0000214:
0000215:
0000216:
0000217:
0000218:
0000219:
0000220:
0000221:
0000222:
0000223:
0000224:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* 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>
#if defined(OMNI_CHECK_ARITHMETIC_OVERFLOW)
// TODO: finish this
#define OMNI_BITS_WILL_ADD_OVER_FW if (omni::bits::will_addition_overflow(a,b)) { error }
#else
#define OMNI_BITS_WILL_ADD_OVER_FW
#endif
#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_BOOL_T(T, val, flag, onoff) val = static_cast<T>(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 bits {
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 unsafe_is_set(const T& t, unsigned short n)
{
return omni::bits::has_flag(t, (1 << n));
}
template < typename T >
inline T& unsafe_set(T& t, unsigned short n, bool s)
{
if (s) { return omni::bits::set_flag(t, (1 << n)); } // set
return omni::bits::unset_flag(t, (1 << n));
}
template < typename T >
inline T& unsafe_set(T& t, unsigned short n)
{
return omni::bits::set_flag(t, (1 << n));
}
template < typename T >
inline T& unsafe_unset(T& t, unsigned short n)
{
return omni::bits::unset_flag(t, (1 << n));
}
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::exceptions::index_out_of_range("Invalid bit", n), false)
}
return omni::bits::unsafe_is_set(t, n);
}
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::exceptions::index_out_of_range("Invalid bit", n), false)
}
return omni::bits::unsafe_set(t, n, s);
}
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::exceptions::index_out_of_range("Invalid bit", n), false)
}
return omni::bits::unsafe_set(t, 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::exceptions::index_out_of_range("Invalid bit", n), false)
}
return omni::bits::unsafe_unset(t, n);
}
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 T1, typename T2 >
inline void xor_swap(T1& a, T2& 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)
}
template < typename T >
inline bool test_overflow(T a, T b, char op)
{
switch (op) {
case '+': return ((b > 0) && (a > std::numeric_limits<T>::max() - b));
case '-': return ((b < 0) && (a > std::numeric_limits<T>::max() + b));
case '*':
return ((a > std::numeric_limits<T>::max() / b) ||
((a == -1) && (b == std::numeric_limits<T>::min())) ||
((b == -1) && (a == std::numeric_limits<T>::min())));
default: break;
}
return false;
}
template < typename T >
inline bool test_underflow(T a, T b, char op)
{
switch (op) {
case '+': return ((b < 0) && (a < std::numeric_limits<T>::min() - b));
case '-': return ((b > 0) && (a < std::numeric_limits<T>::min() + b));
case '*': return ((a < std::numeric_limits<T>::min() / b));
default: break;
}
return false;
}
inline bool will_addition_overflow(int8_t a, int8_t b) { return test_overflow<int8_t>(a, b, '+'); }
inline bool will_addition_overflow(int16_t a, int16_t b) { return test_overflow<int16_t>(a, b, '+'); }
inline bool will_addition_overflow(int32_t a, int32_t b) { return test_overflow<int32_t>(a, b, '+'); }
inline bool will_addition_overflow(int64_t a, int64_t b) { return test_overflow<int64_t>(a, b, '+'); }
inline bool will_addition_overflow(char a, char b) { return test_overflow<char>(a, b, '+'); }
inline bool will_addition_underflow(int8_t a, int8_t b) { return test_underflow<int8_t>(a, b, '+'); }
inline bool will_addition_underflow(int16_t a, int16_t b) { return test_underflow<int16_t>(a, b, '+'); }
inline bool will_addition_underflow(int32_t a, int32_t b) { return test_underflow<int32_t>(a, b, '+'); }
inline bool will_addition_underflow(int64_t a, int64_t b) { return test_underflow<int64_t>(a, b, '+'); }
inline bool will_addition_underflow(char a, char b) { return test_underflow<char>(a, b, '+'); }
inline bool will_subtraction_overflow(int8_t a, int8_t b) { return test_overflow<int8_t>(a, b, '-'); }
inline bool will_subtraction_overflow(int16_t a, int16_t b) { return test_overflow<int16_t>(a, b, '-'); }
inline bool will_subtraction_overflow(int32_t a, int32_t b) { return test_overflow<int32_t>(a, b, '-'); }
inline bool will_subtraction_overflow(int64_t a, int64_t b) { return test_overflow<int64_t>(a, b, '-'); }
inline bool will_subtraction_overflow(char a, char b) { return test_overflow<char>(a, b, '-'); }
inline bool will_subtraction_underflow(int8_t a, int8_t b) { return test_underflow<int8_t>(a, b, '-'); }
inline bool will_subtraction_underflow(int16_t a, int16_t b) { return test_underflow<int16_t>(a, b, '-'); }
inline bool will_subtraction_underflow(int32_t a, int32_t b) { return test_underflow<int32_t>(a, b, '-'); }
inline bool will_subtraction_underflow(int64_t a, int64_t b) { return test_underflow<int64_t>(a, b, '-'); }
inline bool will_subtraction_underflow(char a, char b) { return test_underflow<char>(a, b, '-'); }
inline bool will_multiplication_overflow(int8_t a, int8_t b) { return test_overflow<int8_t>(a, b, '*'); }
inline bool will_multiplication_overflow(int16_t a, int16_t b) { return test_overflow<int16_t>(a, b, '*'); }
inline bool will_multiplication_overflow(int32_t a, int32_t b) { return test_overflow<int32_t>(a, b, '*'); }
inline bool will_multiplication_overflow(int64_t a, int64_t b) { return test_overflow<int64_t>(a, b, '*'); }
inline bool will_multiplication_overflow(char a, char b) { return test_overflow<char>(a, b, '*'); }
inline bool will_multiplication_underflow(int8_t a, int8_t b) { return test_underflow<int8_t>(a, b, '*'); }
inline bool will_multiplication_underflow(int16_t a, int16_t b) { return test_underflow<int16_t>(a, b, '*'); }
inline bool will_multiplication_underflow(int32_t a, int32_t b) { return test_underflow<int32_t>(a, b, '*'); }
inline bool will_multiplication_underflow(int64_t a, int64_t b) { return test_underflow<int64_t>(a, b, '*'); }
inline bool will_multiplication_underflow(char a, char b) { return test_underflow<char>(a, b, '*'); }
} // namespace bits
}
#endif // OMNI_BITS_HPP