source: trunk/lib/bitblock_iterator.hpp @ 3140

Last change on this file since 3140 was 3140, checked in by cameron, 6 years ago

Add BitBlockForwardScanner?; replace incorrect '=' with '=='

File size: 15.3 KB
Line 
1#ifndef BITBLOCK_ITERATOR_H_
2#define BITBLOCK_ITERATOR_H_
3
4#include <iterator>
5#include <iostream>
6#include "bitblock.hpp"
7
8/*=============================================================================
9  bitblock_iterator.hpp
10
11  Created on: Sept 2011
12  Author: Ken Herdy
13
14  Description:
15
16        Scanner classes implement the low level methods to scan through
17        the 'scanwords' of a 'bitblock'. Scanner classes are templated
18        on bitblock type and scanword type.
19
20        BitBlock iterator classes provide Standard Template Library (STL)
21        Input iterator 'like' interface implementations as a programmer
22        convenience and allow iterator classes to be used
23        with STL Algorithms.
24        Forward iterators can only step forward (++) marker-bit by marker-bit.
25        Reverse iterators can only step backwards (--) marker-bit by marker-bit.
26
27        BitStream iterator class provide an STL Input iterator interface to scan
28        through an array of scanwords (stream) in the forward direction.
29
30
31  Classes Descriptions:
32
33        *       BitBlock Scanners
34
35        Scanner - Scanner base class.
36        ForwardScanner - Scans a bitblock of scanwords in the forward direction.
37        ReverseScanner - Scans a bitblock of scanwords in the reverse direction.
38
39        * BitBlock Iterators
40
41  ForwardIterator template class wraps ForwardScanner.
42       
43        - Implements STL Input iterator interface.
44        - Reads elements only once.     
45  - '->' - Not implemented.
46
47  ReverseIterator template class wraps ReverseScanner.
48
49        - An STL 'like' iterator that implements prefix and postfix decrement operators.
50    Under STL, a reverse iterator implementation necessitates the implementation of
51                the STL bidirectional interface and hence scanning in both directions.
52                This functionality is not yet required and hence not implemented.
53        - Reads elements only once.
54  - '->' - Not implemented.
55
56        BitBlockForwardIterator - ForwardIterator derived specialization of ForwardIterator<BitBlock, Scanword>
57
58        BitBlockReverseIterator - ForwardIterator derived specialization of ReverseIterator<BitBlock, Scanword>
59
60        * BitStreamIterators
61
62  BitStreamIterator class wraps ForwardScanner.
63        - Scans an array (stream) of scanwords in contiguous memory.
64        - Implements STL Input iterator interface.
65        - Reads elements only once.     
66  - '->' - Not implemented.
67        - May be more appropriately named ForwardBitStreamIterator.
68
69=============================================================================*/
70//
71// Scanner Classes
72//
73#define has_bit(x) (x != 0)
74
75template <class bitblock_t, class scanblock_t>
76class Scanner {
77
78protected:
79        Scanner(): strm(NULL), pos(-1), blk(-1), scan_blk(-1) {}
80        Scanner(const bitblock_t * s, uint32_t start_pos, uint32_t start_blk, scanblock_t start_scan_blk): strm(s), pos(start_pos), blk(start_blk), scan_blk(start_scan_blk) {}
81
82        const bitblock_t * strm;
83        int32_t pos;
84        int32_t blk;
85        scanblock_t scan_blk;
86};
87
88template <class bitblock_t, class scanblock_t>
89class ForwardScanner: public Scanner<bitblock_t, scanblock_t> {
90
91public:
92
93        ForwardScanner(){}
94        ForwardScanner(const bitblock_t * s) {
95                init(s);
96        }
97
98        IDISA_ALWAYS_INLINE void init(const bitblock_t * s) {
99                this->strm = s;
100                this->pos = 0;
101                this->blk = 0;
102                this->scan_blk = *(scanblock_t *)s;
103        }
104
105        IDISA_ALWAYS_INLINE int32_t scan_to_next() {
106                while (this->blk < BLOCK_COUNT){
107                        if(has_bit(this->scan_blk)){
108                                this->pos = scan_forward_zeroes(this->scan_blk) + (this->blk * (sizeof(scanblock_t)*8));
109                                this->scan_blk = this->scan_blk & (this->scan_blk-1);  // clear rightmost bit
110
111                                return (this->pos);
112                        }
113
114                        this->blk++;
115                        this->scan_blk = *((scanblock_t *)this->strm + this->blk);
116                };
117
118                this->pos = -1;
119                return (this->pos);
120        }
121
122        /* Set or reset the iterator to position new_pos. */
123        IDISA_ALWAYS_INLINE void move_to(uint32_t new_pos) {           
124                const scanblock_t one_bit = 1;
125                this->blk = new_pos / (sizeof(scanblock_t)*8);
126                this->pos = new_pos % (sizeof(scanblock_t)*8);
127                this->scan_blk = ((scanblock_t *)this->strm)[this->blk];
128                // clear bit at pos and all positions to the right.
129                scanblock_t marker = one_bit << this->pos;
130                this->scan_blk = this->scan_blk &~((marker-1)|marker); 
131        }
132
133        IDISA_ALWAYS_INLINE bool is_done() {return (-1==this->pos);}
134        IDISA_ALWAYS_INLINE void set_strm(const bitblock_t * strm) {this->strm = strm;}
135        IDISA_ALWAYS_INLINE const bitblock_t * get_strm() const {return this->strm;}
136        IDISA_ALWAYS_INLINE int32_t get_pos() const {return this->pos;}
137
138        static const int32_t BLOCK_COUNT = sizeof(bitblock_t)/sizeof(scanblock_t);
139
140};
141
142class BitBlockForwardScanner: public ForwardScanner<BitBlock, ScanWord> {
143public:
144        BitBlockForwardScanner(){}
145        BitBlockForwardScanner(BitBlock * s): ForwardScanner<BitBlock, ScanWord>(s){}
146};
147
148
149template <class bitblock_t, class scanblock_t>
150class ReverseScanner: public Scanner<bitblock_t, scanblock_t> {
151
152public:
153        ReverseScanner(){}
154        ReverseScanner(const bitblock_t * s) {
155                init(s);
156        }
157        IDISA_ALWAYS_INLINE void init(const bitblock_t * s) {
158                this->strm = s;
159                this->pos = 0;
160                this->blk = BLOCK_COUNT-1;
161                this->scan_blk = *((scanblock_t *)s + (BLOCK_COUNT-1));
162        }
163
164        IDISA_ALWAYS_INLINE int32_t scan_to_next() {
165                const scanblock_t one_bit = 1;  /* ensure enough bits for shift: one_bit << this->pos */
166                while (this->blk > -1){
167                        if(has_bit(this->scan_blk)){
168                                this->pos = (sizeof(scanblock_t)*8 - scan_backward_zeroes(this->scan_blk) -1) + ( (this->blk) * sizeof(scanblock_t)*8 );
169                                this->scan_blk = this->scan_blk ^ (one_bit << this->pos); // clear leftmost bit
170                                return (this->pos);
171                        }
172
173                        this->blk--;
174                        this->scan_blk = *((scanblock_t *)this->strm + this->blk);
175                };
176
177                this->pos = -1;
178                return (this->pos);
179        }
180
181        /* Set or reset the iterator to position new_pos. */
182        IDISA_ALWAYS_INLINE void move_to(uint32_t new_pos) {
183                const scanblock_t one_bit = 1;
184                this->blk = (new_pos / (sizeof(scanblock_t)*8));
185                this->pos = new_pos % (sizeof(scanblock_t)*8);
186                this->scan_blk = ((scanblock_t *)this->strm)[this->blk];
187                // clear bit at pos and all positions to the left.
188                scanblock_t marker = one_bit << this->pos;
189                this->scan_blk = this->scan_blk & (marker-1);
190        }
191
192        IDISA_ALWAYS_INLINE bool is_done() {return (-1==this->pos);}
193        IDISA_ALWAYS_INLINE void set_strm(const bitblock_t * strm) {this->strm = strm;}
194        IDISA_ALWAYS_INLINE const bitblock_t * get_strm() const {return this->strm;}
195        IDISA_ALWAYS_INLINE int32_t get_pos() const {return this->pos;}
196
197        static const uint32_t BLOCK_COUNT = sizeof(bitblock_t)/sizeof(scanblock_t);
198
199};
200
201
202//
203// BitBlock Iterator Classses
204//
205template<class bitblock_t, class scanblock_t>
206class ForwardIterator : public std::iterator<std::input_iterator_tag, int>
207{
208public:
209        ForwardIterator() {}
210
211        ForwardIterator(bitblock_t * s): scanner(s)
212        {
213                scanner.scan_to_next();
214        }
215
216        void init(bitblock_t * s)
217        {
218                scanner.init(s);
219                scanner.scan_to_next();
220        }
221
222        // equal position and stream
223        bool operator==(const ForwardIterator& iter)
224        {
225                return ((scanner.get_strm() == iter.scanner.get_strm()) && 
226                        (scanner.get_pos() == iter.scanner.get_pos()));
227        }
228
229        // not equal position and stream
230        bool operator!=(const ForwardIterator& iter)
231        {
232                return ((scanner.get_strm() != iter.scanner.get_strm()) && 
233                        (scanner.get_pos() != iter.scanner.get_pos()));
234        }
235
236        // Returns absolute position.
237        IDISA_ALWAYS_INLINE int32_t operator*()
238        {
239                return scanner.get_pos();
240        }
241
242        // prefix increment
243        IDISA_ALWAYS_INLINE ForwardIterator& operator++()
244        {
245                scanner.scan_to_next();
246                return(*this);
247        }
248
249        // postfix increment
250        ForwardIterator operator++(int)
251        {
252                ForwardIterator temp(*this);
253                ++(*this);
254                return(temp);
255        }
256
257private:
258        ForwardScanner<bitblock_t, scanblock_t> scanner;
259};
260
261class BitBlockForwardIterator: public ForwardIterator<BitBlock, ScanWord> {
262public:
263        BitBlockForwardIterator(){}
264        BitBlockForwardIterator(BitBlock * s): ForwardIterator<BitBlock, ScanWord>(s){}
265};
266
267
268template<class bitblock_t, class scanblock_t>
269class ReverseIterator 
270{
271public:
272        ReverseIterator() {}
273        ReverseIterator(BitBlock * s): scanner(s)
274        {
275                scanner.scan_to_next();
276        }
277
278        void init(bitblock_t * s)
279        {
280                scanner.init(s);
281                scanner.scan_to_next();
282        }
283
284        // equal position and stream
285        bool operator==(const ReverseIterator& iter)
286        {
287                return ((scanner.get_strm() == iter.scanner.get_strm()) && (scanner.get_pos() == iter.scanner.get_pos));
288        }
289
290        // not equal position and stream
291        bool operator!=(const ReverseIterator& iter)
292        {
293                return ((scanner.get_strm() != iter.scanner.get_strm()) && (scanner.get_pos() != iter.scanner.get_pos()));
294        }
295
296        // Returns absolute position.
297        IDISA_ALWAYS_INLINE int32_t operator*()
298        {
299                return scanner.get_pos();
300        }
301
302        // prefix decrement
303        IDISA_ALWAYS_INLINE ReverseIterator& operator--()
304        {
305                scanner.scan_to_next();
306                return(*this);
307        }
308
309        // postfix decrement
310        ReverseIterator operator--(int)
311        {
312                ReverseIterator temp(*this);
313                --(*this);
314                return(temp);
315        }
316
317private:
318        ReverseScanner<bitblock_t, scanblock_t> scanner;
319};
320
321class BitBlockReverseIterator: public ReverseIterator<BitBlock, ScanWord> {
322public:
323        BitBlockReverseIterator(){}
324        BitBlockReverseIterator(BitBlock * s): ReverseIterator<BitBlock, ScanWord>(s){}
325};
326
327//
328// BitStream Iterator classes
329//
330class BitStreamIterator: public std::iterator<std::input_iterator_tag, int>
331{
332public:
333        BitStreamIterator():pos(-1), blk(-1), blk_pos(-1), strm(NULL), scan_blk(-1), scan_blk_cnt(0)
334        {
335                // default constructor defines past-the-end of bit stream semantics, pos == -1
336        }
337
338        BitStreamIterator(const BitBlock * s, int cnt):pos(0), 
339                                                                                         blk(0),
340                                                                                         blk_pos(0),
341                                                                                         strm((ScanWord *)s),
342                                                                                         scan_blk(*((ScanWord *)s)),
343                                                                                         scan_blk_cnt(cnt)
344        {
345                scan_to_next();
346        }
347
348        virtual ~BitStreamIterator() {};
349
350        // shallow copy, bit stream iterators refer to shared data
351        BitStreamIterator& operator=(const BitStreamIterator& iter)
352        {
353                pos = iter.pos;
354                blk = iter.blk;
355                blk_pos = iter.blk_pos;
356                strm = iter.strm;                       // No copy, both
357                scan_blk =  iter.scan_blk;
358                scan_blk_cnt = iter.scan_blk_cnt;
359                return(*this);
360        }
361
362        // equal position and stream
363        bool operator==(const BitStreamIterator& iter)
364        {
365                return((strm == iter.strm) && (pos == iter.pos));
366        }
367
368        // not equal position and stream
369        bool operator!=(const BitStreamIterator& iter)
370        {
371                return((strm != iter.strm) || (pos != iter.pos));
372        }
373
374        // prefix
375        inline BitStreamIterator& operator++()
376        {
377                scan_to_next();
378                return(*this);
379        }
380
381        // postfix
382        BitStreamIterator operator++(int)
383        {
384                BitStreamIterator temp(*this);
385                ++(*this);
386                return(temp);
387        }
388
389        // Returns absolute position.
390        inline int32_t operator*()
391        {
392                return pos;
393        }
394
395        /*
396        int operator->()
397        {
398                return(&*(BitStreamIterator)*this);
399        }
400        */
401
402        void debug() {
403        std::cout << "pos: " << pos << std::endl;
404        std::cout << "blk: " << blk << std::endl;
405        std::cout << "blk_pos: " << blk_pos << std::endl;
406        }
407
408private:
409        int32_t pos;
410        uint32_t blk;
411        int32_t blk_pos;
412        const ScanWord * strm;
413        ScanWord scan_blk;
414        uint32_t scan_blk_cnt;
415
416        // Helpers
417        inline void scan_to_next() {
418                while (blk<scan_blk_cnt) {
419                        if(scan_blk > 0){
420                                pos = scan_forward_zeroes(scan_blk) + blk_pos;
421                                scan_blk = scan_blk & (scan_blk-1);  // clear rightmost bit
422                                return;
423                        }
424
425                        blk_pos += (sizeof(ScanWord)*8);
426                        blk++;
427                        scan_blk = strm[blk];
428                };
429
430                pos = -1;
431                return;
432        }
433};
434
435/*=============================================================================
436 
437   Special iterators for content buffers with 16-bit right deletion results.
438   Input: (a) a bitblock with undeleted positions rightmost in each 16-bit field.
439          (b) a bitblock of 16-bit fields with a partial sum of the nondeleted
440              positions in this field and all the ones to the right.
441         
442          The partial sum may be computed given B, a bitblock containg the count
443          of nondeleted positions in each field using PartialSum16(B).
444       
445   
446*/
447
448
449static inline BitBlock PartialSum16(BitBlock BaseCounts16) {
450        BitBlock t = simd<16>::add(BaseCounts16, mvmd<16>::slli<1>(BaseCounts16));
451        BitBlock u = simd<16>::add(t, mvmd<16>::slli<2>(t));
452        return simd<16>::add(u, mvmd<16>::slli<4>(u));
453}
454
455template <class bitblock_t, class scanblock_t>
456class ForwardScannerWithBaseCounts16: public Scanner<bitblock_t, scanblock_t> {
457
458public:
459
460        ForwardScannerWithBaseCounts16(){}
461        ForwardScannerWithBaseCounts16(const bitblock_t * s, bitblock_t partial_sums_16) {
462                init(s, partial_sums_16);
463        }
464
465        IDISA_ALWAYS_INLINE void init(const bitblock_t * s, bitblock_t partial_sums_16) {
466                this->strm = s;
467                this->pos = 0;
468                this->blk = 0;
469                this->scan_blk = *(scanblock_t *)s;
470                /* Shift by one field so that the base is the sum for the prev. fields. */
471                this->base_per_field16._128 = mvmd<16>::slli<1>(partial_sums_16);
472        }
473
474        IDISA_ALWAYS_INLINE int32_t scan_to_next() {
475                while (this->blk < BLOCK_COUNT){
476                        if(has_bit(this->scan_blk)){
477                                int pos = scan_forward_zeroes(this->scan_blk) + (this->blk * (sizeof(scanblock_t)*8));
478                                this->scan_blk = this->scan_blk & (this->scan_blk-1);  // clear rightmost bit
479               
480                                this->pos = this->base_per_field16._16[pos/16] + (pos & 15);
481
482                                return (this->pos);
483                        }
484
485                        this->blk++;
486                        this->scan_blk = *((scanblock_t *)this->strm + this->blk);
487                };
488
489                this->pos = -1;
490                return (this->pos);
491        }
492
493
494        IDISA_ALWAYS_INLINE bool is_done() {return (-1==this->pos);}
495        IDISA_ALWAYS_INLINE void set_strm(const bitblock_t * strm) {this->strm = strm;}
496        IDISA_ALWAYS_INLINE const bitblock_t * get_strm() const {return this->strm;}
497        IDISA_ALWAYS_INLINE int32_t get_pos() const {return this->pos;}
498
499        static const int32_t BLOCK_COUNT = sizeof(bitblock_t)/sizeof(scanblock_t);
500        ubitblock base_per_field16;
501};
502
503template <class bitblock_t> static inline bool eq_bitblocks(bitblock_t x, bitblock_t y) {
504  return bitblock::all(simd<16>::eq(x, y));
505}
506
507
508template<class bitblock_t, class scanblock_t>
509class ForwardIteratorWithBaseCounts16 : public std::iterator<std::input_iterator_tag, int>
510{
511public:
512        ForwardIteratorWithBaseCounts16() {}
513
514        ForwardIteratorWithBaseCounts16(bitblock_t * s, bitblock_t partial_sums_16): scanner(s, partial_sums_16)
515        {
516                scanner.scan_to_next();
517        }
518
519        void init(bitblock_t * s, bitblock_t partial_sums_16)
520        {
521                scanner.init(s, partial_sums_16);
522                scanner.scan_to_next();
523        }
524
525        // equal position and stream
526        bool operator==(const ForwardIteratorWithBaseCounts16& iter)
527        {
528                return (scanner.get_strm() == iter.scanner.get_strm()) && 
529                       (scanner.get_pos() == iter.scanner.get_pos) &&
530                       (eq_bitblocks<bitblock_t>(scanner.base_per_field16, iter.scanner.base_per_field16));
531        }
532
533        // not equal position and stream
534        bool operator!=(const ForwardIteratorWithBaseCounts16& iter)
535        {
536                return (scanner.get_strm() != iter.scanner.get_strm()) || 
537                       (scanner.get_pos() != iter.scanner.get_pos) ||
538                       (!eq_bitblocks<bitblock_t>(scanner.base_per_field16, iter.scanner.base_per_field16));
539        }
540
541        // Returns absolute position.
542        IDISA_ALWAYS_INLINE int32_t operator*()
543        {
544                return scanner.get_pos();
545        }
546
547        // prefix increment
548        IDISA_ALWAYS_INLINE ForwardIteratorWithBaseCounts16& operator++()
549        {
550                scanner.scan_to_next();
551                return(*this);
552        }
553
554        // postfix increment
555        ForwardIteratorWithBaseCounts16 operator++(int)
556        {
557                ForwardIteratorWithBaseCounts16 temp(*this);
558                ++(*this);
559                return(temp);
560        }
561
562private:
563        ForwardScannerWithBaseCounts16<bitblock_t, scanblock_t> scanner;
564};
565
566
567class BitBlockForwardIteratorWithBaseCounts16: public ForwardIteratorWithBaseCounts16<BitBlock, ScanWord> {
568public:
569        BitBlockForwardIteratorWithBaseCounts16(){}
570        BitBlockForwardIteratorWithBaseCounts16(BitBlock * s, BitBlock partial_sums_16): ForwardIteratorWithBaseCounts16<BitBlock, ScanWord>(s, partial_sums_16){}
571};
572
573
574#undef has_bit
575
576
577#endif // BITBLOCK_ITERATOR_H_
578
Note: See TracBrowser for help on using the repository browser.