BitIterator.hpp

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: BitIterator
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/BitFlag.h>
#include <NDEVR/BitReference.h>
#include <iterator>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Simple bit iterator, typically used for parsing Buffer of bools in loops.
 
    **/
    class BitIterator
    {
    public:
        BitIterator(BitFlag* flag, const sint04 offset)
            : m_flag(flag)
            , m_bit(offset)
        {
            checkBitLocationPositive();
        }
        BitIterator(const BitIterator& iter) = default;
 
        bool operator!() const
        {
            return !(*m_flag)[m_bit_ref];
        }
        constexpr operator bool() const
        {
            return (*m_flag)[m_bit_ref];
        }
        BitReference operator*()
        {
            return BitReference(*m_flag, m_bit_ref);
        }
        const BitReference operator*() const
        {
            return BitReference(*m_flag, m_bit_ref);
        }
 
        BitIterator& operator++()
        {
            m_bit++;
            checkBitLocationPositive();
            return *this;
        }
        BitIterator& operator--()
        {
            m_bit--;
            checkBitLocationNegative();
            return *this;
        }
        BitIterator operator++(int)
        {
            BitIterator old_value(*this);
            m_bit++;
            checkBitLocationPositive();
            return old_value;
        }
        BitIterator operator--(int)
        {
            BitIterator old_value(*this);
            m_bit--;
            checkBitLocationNegative();
            return old_value;
        }
        template<class t_type>
        BitIterator& operator+=(const t_type& movement)
        {
            m_bit += cast<sint04>(movement);
            checkBitLocationPositive();
            return (*this);
        }
        template<class t_type>
        BitIterator& operator-=(const t_type& movement)
        {
            m_bit -= cast<sint04>(movement);
            checkBitLocationNegative();
            return (*this);
        }
        bool operator>(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit > other.m_bit;
            else
                return m_flag > other.m_flag;
        }
        bool operator<(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit < other.m_bit;
            else
                return m_flag < other.m_flag;
        }
        ptrdiff_t operator-(const BitIterator& rawIterator)
        {
            return std::distance(rawIterator.m_flag, this->m_flag) + cast<ptrdiff_t>(rawIterator.m_bit - this->m_bit);
        }
        template<class t_type>
        BitIterator operator+(t_type distance) const
        {
            BitIterator sum = *this;
            sum.m_bit += cast<sint04>(distance);
            sum.checkBitLocationPositive();
            return sum;
        }
        template<class t_type>
        BitIterator operator-(t_type distance) const
        {
            BitIterator sum = *this;
            sum.m_bit -= cast<sint04>(distance);
            sum.checkBitLocationNegative();
            return sum;
        }
    public:
        BitIterator& operator=(const BitIterator& rawIterator) = default;
 
        bool operator==(const BitIterator& rawIterator) const { return (m_bit == rawIterator.m_bit && m_flag == rawIterator.m_flag); }
        bool operator!=(const BitIterator& rawIterator) const { return (m_bit != rawIterator.m_bit || m_flag != rawIterator.m_flag); }
 
    private:
        void checkBitLocationPositive() const
        {
            if (m_bit >= 8)
            {
                m_flag += (m_bit / 8);
                m_bit = m_bit % 8;
            }
            m_bit_ref = cast<uint01>(m_bit);
        }
        void checkBitLocationNegative() const
        {
            if (m_bit <= 0)
            {
                m_bit = -m_bit + 8;
                m_flag -= (m_bit / 8);
                m_bit = m_bit % 8;
            }
            m_bit_ref = cast<uint01>(m_bit);
        }
        mutable BitFlag* m_flag;
        mutable sint04 m_bit;
        mutable uint01 m_bit_ref = Constant<uint01>::Invalid;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Simple bit iterator, typically used for parsing Buffer of bools in loops.
 
    **/
    class ConstBitIterator
    {
    public:
        ConstBitIterator(const BitFlag* flag, sint04 offset)
            : m_flag(flag)
            , m_bit(offset)
        {
            checkBitLocationPositive();
        }
        ConstBitIterator(const BitFlag* flag, uint04 offset)
            : m_flag(flag)
            , m_bit(cast<sint04>(offset))
        {
            checkBitLocationPositive();
        }
        ConstBitIterator(const ConstBitIterator& iter) = default;
 
        bool operator*()
        {
            return (*m_flag)[m_bit_ref];
        }
        bool operator*() const
        {
            return (*m_flag)[m_bit_ref];
        }
        bool operator==(bool ref) const
        {
            return (*m_flag)[m_bit_ref] == ref;
        }
        bool operator!() const
        {
            return !(*m_flag)[m_bit_ref];
        }
        constexpr operator bool() const
        {
            return (*m_flag)[m_bit_ref];
        }
        ConstBitIterator& operator++()
        {
            m_bit++;
            checkBitLocationPositive();
            return *this;
        }
        ConstBitIterator& operator--()
        {
            m_bit--;
            checkBitLocationNegative();
            return *this;
        }
        ConstBitIterator operator++(int)
        {
            ConstBitIterator old_value(*this);
            m_bit++;
            checkBitLocationPositive();
            return old_value;
        }
        ConstBitIterator operator--(int)
        {
            ConstBitIterator old_value(*this);
            m_bit--;
            checkBitLocationNegative();
            return old_value;
        }
        template<class t_type>
        ConstBitIterator& operator+=(const t_type& movement)
        {
            m_bit += cast<sint04>(movement);
            checkBitLocationPositive();
            return (*this);
        }
        template<class t_type>
        ConstBitIterator& operator-=(const t_type& movement)
        {
            m_bit -= cast<sint04>(movement);
            checkBitLocationNegative();
            return (*this);
        }
 
        ptrdiff_t operator-(const ConstBitIterator& rawIterator)
        {
            return std::distance(rawIterator.m_flag, this->m_flag) + cast<ptrdiff_t>(rawIterator.m_bit - this->m_bit);
        }
 
    public:
        ConstBitIterator& operator=(const ConstBitIterator& rawIterator) = default;
 
        bool operator==(const ConstBitIterator& rawIterator) const { return (m_bit == rawIterator.m_bit && m_flag == rawIterator.m_flag); }
        bool operator!=(const ConstBitIterator& rawIterator) const { return (m_bit != rawIterator.m_bit || m_flag != rawIterator.m_flag); }
 
        template<class t_type>
        ConstBitIterator operator+(const t_type& movement)
        {
            ConstBitIterator sum(*this);
            sum += movement;
            return sum;
        }
        template<class t_type>
        ConstBitIterator operator-(const t_type& movement)
        {
            ConstBitIterator sum(*this);
            sum -= movement;
            return sum;
        }
    private:
        void checkBitLocationPositive() const
        {
            if (m_bit >= 8)
            {
                m_flag += (m_bit / 8);
                m_bit = m_bit % 8;
            }
            m_bit_ref = cast<uint01>(m_bit);
        }
        void checkBitLocationNegative() const
        {
            if (m_bit <= 0)
            {
                m_bit = -m_bit + 8;
                m_flag -= (m_bit / 8);
                m_bit = m_bit % 8;
            }
            m_bit_ref = cast<uint01>(m_bit);
        }
        mutable const BitFlag* m_flag;
        mutable sint04 m_bit;
        mutable uint01 m_bit_ref = Constant<uint01>::Invalid;
    };
}