source: icGREP/icgrep-devel/icgrep/UCD/unicode_set.h @ 4627

Last change on this file since 4627 was 4627, checked in by nmedfort, 4 years ago

Temporary check-in.

File size: 6.3 KB
RevLine 
[4189]1#ifndef UNICODE_SET_H
2#define UNICODE_SET_H
3#include <stdint.h>
4#include <vector>
[4617]5#include <re/re_cc.h>
[4616]6#include <boost/iterator/iterator_facade.hpp>
[4611]7
[4189]8//
9// unicode_set.h - representing and manipulating sets of Unicode
10// characters, based on data from UCD - the Unicode Character Database
11//
12// Robert D. Cameron
13// September 18, 2014
14//
15// Licensed under Open Software License 3.0.
16//
17// Unicode Sparse Bitset Representation
18//
19// The Unicode Sparse Bitset representation is based on
20// (a) Dividing the Unicode codepoint space into groups of 2^k codepoints called quads.
21// (b) Specifying the quads using a run-length encoding, in which each run
22//     is Empty (quads contain no members), Mixed (quads contain some members and
23//     some nonmembers) or Full (all codepoints in each quad are members of the set).
24// (c) Explicitly listing all the quads of Mixed type.
25//
26
27//
28// The internal datatype for quads - bitsets of 2^k codepoints.
29// Default: 64 codepoints (k=6).
30//
[4616]31
[4618]32namespace llvm {
33class raw_ostream;
34}
35
[4621]36namespace UCD {
[4189]37
38enum run_type_t : uint16_t {Empty, Mixed, Full};
39
[4620]40class UnicodeSet {
41public:
42
[4621]43    using bitquad_t = uint32_t;
44    using length_t = uint16_t;
45    using run_t = std::pair<run_type_t, length_t>;
[4622]46    using quad_iterator_return_t = std::pair<run_t, bitquad_t>;
[4621]47
[4618]48    using codepoint_t = re::codepoint_t;
49    using interval_t = re::interval_t;
[4621]50    using RunVector = std::vector<run_t>;
[4618]51    using QuadVector = std::vector<bitquad_t>;
[4616]52
[4620]53    class iterator : public boost::iterator_facade<iterator, interval_t, boost::forward_traversal_tag, interval_t> {
[4616]54        friend class UnicodeSet;
[4617]55        friend class boost::iterator_core_access;
[4616]56    protected:
[4627]57
58        iterator(const RunVector::const_iterator runIterator, const QuadVector::const_iterator quadIterator, const codepoint_t baseCodePoint)
[4620]59        : mRunIterator(runIterator), mQuadIterator(quadIterator)
[4627]60        , mMixedRunIndex(0), mQuadOffset(0), mBaseCodePoint(baseCodePoint), mMinCodePoint(baseCodePoint), mMaxCodePoint(baseCodePoint) {
[4617]61
[4618]62        }
63
[4620]64        void advance(const unsigned n);
[4617]65
[4622]66        inline interval_t dereference() const {
[4618]67            return std::make_pair(mMinCodePoint, mMaxCodePoint);
68        }
[4617]69
[4616]70        inline void increment() {
71            advance(1);
72        }
[4617]73
[4622]74        inline bool equal(const iterator & other) const {
[4627]75            return (mMinCodePoint == other.mMinCodePoint);
[4616]76        }
77    private:
[4626]78        RunVector::const_iterator           mRunIterator;
79        QuadVector::const_iterator          mQuadIterator;
80        unsigned                            mMixedRunIndex;
81        bitquad_t                           mQuadOffset;
82        codepoint_t                         mBaseCodePoint;
83        codepoint_t                         mMinCodePoint;
84        codepoint_t                         mMaxCodePoint;
[4616]85    };
86
[4618]87    inline iterator begin() const {
[4627]88        // note: preincrement forces the iterator to advance onto and capture the first interval.
89        return ++iterator(mRuns.cbegin(), mQuads.cbegin(), 0);
[4618]90    }
91
92    inline iterator end() const {
[4627]93        return iterator(mRuns.cend(), mQuads.cend(), 0x110000);
[4618]94    }
95
[4622]96    class quad_iterator : public boost::iterator_facade<quad_iterator, quad_iterator_return_t, boost::random_access_traversal_tag, quad_iterator_return_t> {
[4617]97        friend class UnicodeSet;
98        friend class boost::iterator_core_access;
[4618]99    public:
[4620]100        quad_iterator(RunVector::const_iterator runIterator, QuadVector::const_iterator quadIterator)
101            : mRunIterator(runIterator), mQuadIterator(quadIterator), mOffset(0) {}
[4617]102
103        void advance(unsigned n);
104
[4622]105        inline quad_iterator_return_t dereference() const {
106            return std::make_pair(run(), quad());
[4617]107        }
108
109        inline void increment() {
110            advance(1);
111        }
112
[4622]113        inline run_t run() const {
[4626]114            return std::make_pair(std::get<0>(*mRunIterator), std::get<1>(*mRunIterator) - mOffset);
[4618]115        }
116
[4622]117        inline bitquad_t quad() const {
[4620]118            return *mQuadIterator;
[4618]119        }
120
121        inline bool equal(const quad_iterator & other) const {
[4620]122            return (mRunIterator == other.mRunIterator) && (mQuadIterator == other.mQuadIterator);
[4617]123        }
[4618]124
[4617]125    private:
[4620]126        RunVector::const_iterator   mRunIterator;
127        QuadVector::const_iterator  mQuadIterator;
[4618]128        unsigned                    mOffset;
[4617]129    };
130
131    inline quad_iterator quad_begin() const {
[4620]132        return quad_iterator(mRuns.cbegin(), mQuads.cbegin());
[4617]133    }
134
135    inline quad_iterator quad_end() const {
[4620]136        return quad_iterator(mRuns.cend(), mQuads.cend());
[4617]137    }
138
[4620]139    bool contains(const codepoint_t codepoint) const;
[4616]140
[4620]141    void dump(llvm::raw_ostream & out) const;
[4616]142
[4621]143    UnicodeSet operator~() const;
144    UnicodeSet operator&(const UnicodeSet & other) const;
145    UnicodeSet operator+(const UnicodeSet & other) const;
146    UnicodeSet operator-(const UnicodeSet & other) const;
147    UnicodeSet operator^(const UnicodeSet & other) const;
[4622]148    inline UnicodeSet & operator=(const UnicodeSet & other) = default;
149    inline UnicodeSet & operator=(UnicodeSet && other) = default;
[4621]150    UnicodeSet operator==(const UnicodeSet & other) const;
[4620]151
152    UnicodeSet();
153    UnicodeSet(const codepoint_t codepoint);
154    UnicodeSet(const codepoint_t lo_codepoint, const codepoint_t hi_codepoint);
[4622]155    inline UnicodeSet(const UnicodeSet & other) = default;
[4621]156    UnicodeSet(std::initializer_list<run_t> r, std::initializer_list<bitquad_t> q) : mRuns(r), mQuads(q) {}
157    UnicodeSet(std::vector<run_t> && r, std::vector<bitquad_t> && q) : mRuns(r), mQuads(q) {}
[4620]158
[4621]159    inline void swap(UnicodeSet & other);
160    inline void swap(UnicodeSet && other);
161
[4618]162private:
163
[4622]164    RunVector       mRuns;
165    QuadVector      mQuads;
[4189]166};
167
[4621]168inline void UnicodeSet::swap(UnicodeSet & other) {
[4622]169    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
[4621]170}
171
172inline void UnicodeSet::swap(UnicodeSet && other) {
[4622]173    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
[4621]174}
175
[4618]176inline UnicodeSet uset_complement(const UnicodeSet & s) {
[4621]177    return ~s;
[4618]178}
[4189]179
[4618]180inline UnicodeSet uset_intersection(const UnicodeSet & s1, const UnicodeSet & s2) {
181    return s1 & s2;
182}
183
184inline UnicodeSet uset_union(const UnicodeSet & s1, const UnicodeSet & s2) {
185    return s1 + s2;
186}
187
188inline UnicodeSet uset_difference(const UnicodeSet & s1, const UnicodeSet & s2) {
189    return s1 - s2;
190}
191
192inline UnicodeSet uset_symmetric_difference(const UnicodeSet & s1, const UnicodeSet & s2) {
193    return s1 ^ s2;
194}
195
[4621]196}
197
[4189]198#endif
199
Note: See TracBrowser for help on using the repository browser.