(C) Zeriph Enterprises, LLC
omni/util/bits.hpp
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:
186:
187:
188:
189:
190:
191:
192:
193:
194:
195:
196:
197:
198:
199:
200:
201:
202:
203:
204:
205:
206:
207:
208:
209:
210:
211:
212:
213:
214:
215:
216:
217:
218:
219:
220:
221:
222:
223:
224:
































































































































































































































/*
* 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>

#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 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::exceptions::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::exceptions::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::exceptions::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::exceptions::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 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