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

Last change on this file since 5278 was 5278, checked in by cameron, 2 years ago

Alphabet class: initial check-in

File size: 6.5 KB
RevLine 
[4189]1#ifndef UNICODE_SET_H
2#define UNICODE_SET_H
3#include <stdint.h>
4#include <vector>
[4616]5#include <boost/iterator/iterator_facade.hpp>
[4983]6#include <util/slab_allocator.h>
[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
[5278]38typedef unsigned codepoint_t;
39enum : codepoint_t { UNICODE_MAX = 0x10FFFF };
40
[4189]41enum run_type_t : uint16_t {Empty, Mixed, Full};
42
[4620]43class UnicodeSet {
44public:
45
[4621]46    using bitquad_t = uint32_t;
47    using length_t = uint16_t;
48    using run_t = std::pair<run_type_t, length_t>;
[4622]49    using quad_iterator_return_t = std::pair<run_t, bitquad_t>;
[4621]50
[4812]51    using interval_t = std::pair<codepoint_t, codepoint_t>;
52
[5240]53    using RunVector = std::vector<run_t, ProxyAllocator<run_t>>;
54    using QuadVector = std::vector<bitquad_t, ProxyAllocator<bitquad_t>>;
[4860]55    using RunIterator = RunVector::const_iterator;
56    using QuadIterator = QuadVector::const_iterator;
57
[4812]58    using size_type = RunVector::size_type;
59
[4620]60    class iterator : public boost::iterator_facade<iterator, interval_t, boost::forward_traversal_tag, interval_t> {
[4616]61        friend class UnicodeSet;
[4617]62        friend class boost::iterator_core_access;
[4616]63    protected:
[4627]64
65        iterator(const RunVector::const_iterator runIterator, const QuadVector::const_iterator quadIterator, const codepoint_t baseCodePoint)
[4620]66        : mRunIterator(runIterator), mQuadIterator(quadIterator)
[4627]67        , mMixedRunIndex(0), mQuadOffset(0), mBaseCodePoint(baseCodePoint), mMinCodePoint(baseCodePoint), mMaxCodePoint(baseCodePoint) {
[4617]68
[4618]69        }
70
[4620]71        void advance(const unsigned n);
[4617]72
[4622]73        inline interval_t dereference() const {
[4618]74            return std::make_pair(mMinCodePoint, mMaxCodePoint);
75        }
[4617]76
[4616]77        inline void increment() {
78            advance(1);
79        }
[4617]80
[4622]81        inline bool equal(const iterator & other) const {
[4627]82            return (mMinCodePoint == other.mMinCodePoint);
[4616]83        }
84    private:
[4860]85        RunIterator         mRunIterator;
86        QuadIterator        mQuadIterator;
87        unsigned            mMixedRunIndex;
88        bitquad_t           mQuadOffset;
89        codepoint_t         mBaseCodePoint;
90        codepoint_t         mMinCodePoint;
91        codepoint_t         mMaxCodePoint;
[4616]92    };
93
[4618]94    inline iterator begin() const {
[4627]95        // note: preincrement forces the iterator to advance onto and capture the first interval.
96        return ++iterator(mRuns.cbegin(), mQuads.cbegin(), 0);
[4618]97    }
98
99    inline iterator end() const {
[4627]100        return iterator(mRuns.cend(), mQuads.cend(), 0x110000);
[4618]101    }
102
[4860]103    bool contains(const codepoint_t codepoint) const;
104
105    bool intersects(const codepoint_t lo, const codepoint_t hi) const;
106
107    void insert(const codepoint_t cp);
108
109    void insert_range(const codepoint_t lo, const codepoint_t hi);
110
111    bool empty() const;
112
113    size_type size() const;
114
115    interval_t front() const;
116
117    interval_t back() const;
118
119    void dump(llvm::raw_ostream & out) const;
120
121    UnicodeSet operator~() const;
122    UnicodeSet operator&(const UnicodeSet & other) const;
123    UnicodeSet operator+(const UnicodeSet & other) const;
124    UnicodeSet operator-(const UnicodeSet & other) const;
125    UnicodeSet operator^(const UnicodeSet & other) const;
126
127    inline UnicodeSet & operator=(const UnicodeSet & other) = default;
128    inline UnicodeSet & operator=(UnicodeSet && other) = default;
129    bool operator==(const UnicodeSet & other) const;
130    bool operator<(const UnicodeSet & other) const;
131
132    UnicodeSet();
133    UnicodeSet(const codepoint_t codepoint);
134    UnicodeSet(const codepoint_t lo, const codepoint_t hi);
135    UnicodeSet(const UnicodeSet & other);
136    UnicodeSet(std::initializer_list<run_t> r, std::initializer_list<bitquad_t> q);
137    UnicodeSet(std::initializer_list<interval_t>::iterator begin, std::initializer_list<interval_t>::iterator end);
138    UnicodeSet(const std::vector<interval_t>::iterator begin, const std::vector<interval_t>::iterator end);
139
140    inline void swap(UnicodeSet & other);
141    inline void swap(UnicodeSet && other);
142
143protected:
144
145    UnicodeSet(std::vector<run_t> && r, std::vector<bitquad_t> && q);
146
[4622]147    class quad_iterator : public boost::iterator_facade<quad_iterator, quad_iterator_return_t, boost::random_access_traversal_tag, quad_iterator_return_t> {
[4617]148        friend class UnicodeSet;
149        friend class boost::iterator_core_access;
[4618]150    public:
[4860]151        quad_iterator(RunIterator runIterator, QuadIterator quadIterator)
[4620]152            : mRunIterator(runIterator), mQuadIterator(quadIterator), mOffset(0) {}
[4617]153
154        void advance(unsigned n);
155
[4622]156        inline quad_iterator_return_t dereference() const {
[4629]157            return std::make_pair(std::make_pair(type(), length()), quad());
[4617]158        }
159
160        inline void increment() {
161            advance(1);
162        }
163
[4629]164        inline run_type_t type() const {
[4812]165            return mRunIterator->first;
[4618]166        }
167
[4629]168        inline length_t length() const {
[4812]169            return mRunIterator->second - mOffset;
[4629]170        }
171
[4622]172        inline bitquad_t quad() const {
[4620]173            return *mQuadIterator;
[4618]174        }
175
176        inline bool equal(const quad_iterator & other) const {
[4620]177            return (mRunIterator == other.mRunIterator) && (mQuadIterator == other.mQuadIterator);
[4617]178        }
[4618]179
[4617]180    private:
[4860]181        RunIterator     mRunIterator;
182        QuadIterator    mQuadIterator;
183        unsigned        mOffset;
[4617]184    };
185
186    inline quad_iterator quad_begin() const {
[4620]187        return quad_iterator(mRuns.cbegin(), mQuads.cbegin());
[4617]188    }
189
190    inline quad_iterator quad_end() const {
[4620]191        return quad_iterator(mRuns.cend(), mQuads.cend());
[4617]192    }
193
[4618]194private:
195
[5037]196    RunVector               mRuns;
197    QuadVector              mQuads;
[5240]198    static SlabAllocator<>  mAllocator;
[4189]199};
200
[4812]201
[4621]202inline void UnicodeSet::swap(UnicodeSet & other) {
[4622]203    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
[4621]204}
205
206inline void UnicodeSet::swap(UnicodeSet && other) {
[4622]207    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
[4621]208}
209
[4618]210}
[4189]211
212#endif
213
Note: See TracBrowser for help on using the repository browser.