cds/algo/split_bitstring.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_ALGO_SPLIT_BITSTRING_H
  32 #define CDSLIB_ALGO_SPLIT_BITSTRING_H
  33
  34 #include <cds/algo/base.h>
  35
  36 namespace cds { namespace algo {
  37
  38     /// Cuts a bit sequence from fixed-size bit-string
  39     /**
  40         The splitter can be used as iterator over bit-string.
  41         Each call of \p cut() or \p safe_cut() cuts the bit count specified
  42         and keeps the position inside bit-string for the next call.
  43
  44         The splitter stores a const reference to bit-string, not a copy.
  45         The maximum count of bits that can be cut in a single call is <tt> sizeof(UInt) * 8 </tt>
  46
  47         Template parameters:
  48         - \p BitString - a fixed-sized type that interprets as bit string
  49         - \p BitStringSize - the size of \p BitString in bytes, default is <tt>sizeof( BitString )</tt>.
  50              You can specify 0 for default.
  51         - \p UInt - an unsigned integer, return type of \p cut()
  52     */
  53     template <typename BitString, size_t BitStringSize = sizeof( BitString ), typename UInt = typename std::conditional< BitStringSize % sizeof(size_t) == 0, size_t, unsigned >::type >
  54     class split_bitstring
  55     {
  56     public:
  57         typedef BitString bitstring;    ///< Bit-string type
  58         typedef UInt      uint_type;    ///< Bit-string portion type
  59         static CDS_CONSTEXPR size_t const c_bitstring_size = BitStringSize ? BitStringSize : sizeof( BitString ); ///< size of \p BitString in bytes
  60
  61         //@cond
  62         static CDS_CONSTEXPR size_t const c_nHashSize   = (c_bitstring_size + sizeof(uint_type) - 1) / sizeof(uint_type);
  63         static CDS_CONSTEXPR size_t const c_nBitPerByte = 8;
  64         static CDS_CONSTEXPR size_t const c_nBitPerHash = c_bitstring_size * c_nBitPerByte;
  65         static CDS_CONSTEXPR size_t const c_nBitPerInt  = sizeof( uint_type ) * c_nBitPerByte;
  66         //@endcond
  67
  68     public:
  69         /// Initializises the splitter with reference to \p h and zero start bit offset
  70         explicit split_bitstring( bitstring const& h )
  71             : m_ptr(reinterpret_cast<uint_type const*>( &h ))
  72             , m_offset(0)
  73             , m_first( m_ptr )
  74 #   ifdef _DEBUG
  75             , m_last( m_ptr + c_nHashSize )
  76 #   endif
  77         {}
  78
  79         /// Initializises the splitter with reference to \p h and start bit offset \p nBitOffset
  80         split_bitstring( bitstring const& h, size_t nBitOffset )
  81             : m_ptr( reinterpret_cast<uint_type const*>( &h ) + nBitOffset / c_nBitPerInt )
  82             , m_offset( nBitOffset )
  83             , m_first( reinterpret_cast<uint_type const*>(&h))
  84 #   ifdef _DEBUG
  85             , m_last( m_first + c_nHashSize )
  86 #   endif
  87         {}
  88
  89
  90         /// Returns \p true if end-of-string is not reached yet
  91         explicit operator bool() const
  92         {
  93             return !eos();
  94         }
  95
  96         /// Returns \p true if end-of-stream encountered
  97         bool eos() const
  98         {
  99             return m_offset >= c_nBitPerHash;
 100         }
 101
 102         /// Cuts next \p nBits from bit-string
 103         /**
 104             Precondition: <tt>nBits <= sizeof(uint_type) * 8</tt>
 105
 106             This function does not manage out-of-bound condition.
 107             To control that use \p safe_cut().
 108         */
 109         uint_type cut( size_t nBits )
 110         {
 111             assert( !eos());
 112             assert( nBits <= c_nBitPerInt );
 113             assert( m_offset + nBits <= c_nBitPerHash );
 114 #   ifdef _DEBUG
 115             assert( m_ptr < m_last );
 116 #   endif
 117             uint_type result;
 118
 119             uint_type const nRest = c_nBitPerInt - m_offset % c_nBitPerInt;
 120             m_offset += nBits;
 121             if ( nBits < nRest ) {
 122                 result = *m_ptr << ( nRest - nBits );
 123                 result = result >> ( c_nBitPerInt - nBits );
 124             }
 125             else if ( nBits == nRest ) {
 126                 result = *m_ptr >> ( c_nBitPerInt - nRest );
 127                 ++m_ptr;
 128                 assert( m_offset % c_nBitPerInt == 0 );
 129             }
 130             else {
 131                 uint_type const lsb = *m_ptr >> ( c_nBitPerInt - nRest );
 132                 nBits -= nRest;
 133                 ++m_ptr;
 134
 135                 result = *m_ptr << ( c_nBitPerInt - nBits );
 136                 result = result >> ( c_nBitPerInt - nBits );
 137                 result = (result << nRest) + lsb;
 138             }
 139
 140             assert( m_offset <= c_nBitPerHash );
 141 #   ifdef _DEBUG
 142             assert( m_ptr <= m_last );
 143 #   endif
 144             return result;
 145         }
 146
 147         /// Cuts up to \p nBits from the bit-string
 148         /**
 149             Analog of \p cut() but if \p nBits is more than the rest of bit-string,
 150             only the rest is returned.
 151             If \p eos() is \p true the function returns 0.
 152         */
 153         uint_type safe_cut( size_t nBits )
 154         {
 155             if ( eos())
 156                 return 0;
 157
 158             assert( nBits <= sizeof(uint_type) * c_nBitPerByte );
 159
 160             if ( m_offset + nBits > c_nBitPerHash )
 161                 nBits = c_nBitPerHash - m_offset;
 162             return nBits ? cut( nBits ) : 0;
 163         }
 164
 165         /// Resets the splitter
 166         void reset() CDS_NOEXCEPT
 167         {
 168             m_ptr = m_first;
 169             m_offset = 0;
 170         }
 171
 172         /// Returns pointer to source bitstring
 173         bitstring const * source() const
 174         {
 175             return reinterpret_cast<bitstring const *>( m_first );
 176         }
 177
 178         /// Returns current bit offset from beginning of bit-string
 179         size_t bit_offset() const
 180         {
 181             return m_offset;
 182         }
 183
 184     private:
 185         //@cond
 186         uint_type const* m_ptr;     ///< current position in the hash
 187         size_t           m_offset;  ///< current bit offset in bit-string
 188         uint_type const* m_first;   ///< first position
 189 #   ifdef _DEBUG
 190         uint_type const* m_last;    ///< last position
 191 #   endif
 192         //@endcond
 193     };
 194
 195 }} // namespace cds::algo
 196
 197 #endif // #ifndef CDSLIB_ALGO_SPLIT_BITSTRING_H