File: lexico.py

package info (click to toggle)
python-bitarray 3.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,320 kB
  • sloc: python: 11,753; ansic: 7,680; makefile: 73; sh: 6
file content (231 lines) | stat: -rw-r--r-- 7,373 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# issue 6
# http://www-graphics.stanford.edu/~seander/bithacks.html#NextBitPermutation

from bitarray import bitarray
from bitarray.util import zeros, ba2int, int2ba


def lexico_all(n, k, endian=None):
    """lexico_all(n, k, endian=None) -> iterator

Return an iterator over all bitarrays of length `n` and
population count `k` in lexicographical order.
"""
    if n < 0:
        raise ValueError("length must be >= 0")

    # error check inputs and handle edge cases
    if k <= 0 or k > n:
        if k == 0:
            yield zeros(n, endian)
            return
        raise ValueError("k must be in range 0 <= k <= n, got %s" % k)

    v = (1 << k) - 1
    while True:
        try:
            yield int2ba(v, length=n, endian=endian)
        except OverflowError:
            return
        t = (v | (v - 1)) + 1
        v = t | ((((t & -t) // (v & -v)) >> 1) - 1)


def lexico_next(__a):
    """lexico_next(a, /) -> bitarray

Return the next lexicographical permutation of bitarray `a`.
The length and population count of the result remains unchanged.
The integer value (`ba2int()`) of the next permutation will always increase,
except when the cycle is completed.  In that case, the lowest lexicographical
permutation will be returned.
"""
    if not __a:
        return __a

    v = ba2int(__a)
    if v == 0:
        return __a

    t = (v | (v - 1)) + 1
    v = t | ((((t & -t) // (v & -v)) >> 1) - 1)
    try:
        return int2ba(v, length=len(__a), endian=__a.endian)
    except OverflowError:
        return __a[::-1]

# ---------------------- lexicographical permutations -----------------------

import math
import unittest
from random import choice, getrandbits, randrange
from itertools import pairwise

from bitarray import frozenbitarray
from bitarray.util import random_k


class LexicoTests(unittest.TestCase):

    def test_errors(self):
        N = lexico_next
        self.assertRaises(TypeError, N)
        self.assertRaises(TypeError, N, bitarray('1'), 1)
        self.assertRaises(TypeError, N, '1')

        A = lexico_all
        self.assertRaises(TypeError, A)
        self.assertRaises(TypeError, A, 4)
        self.assertRaises(TypeError, next, A("4", 2))
        self.assertRaises(TypeError, next, A(1, "0.5"))
        self.assertRaises(TypeError, A, 1, p=1)
        self.assertRaises(TypeError, next, A(11, 5.5))
        self.assertRaises(ValueError, next, A(-1, 0))
        for k in -1, 11:  # k is not 0 <= k <= n
            self.assertRaises(ValueError, next, A(10, k))
        self.assertRaises(ValueError, next, A(10, 7, 'foo'))
        self.assertRaises(ValueError, next, A(10, 7, endian='foo'))

    def test_zeros_ones(self):
        for n in range(30):
            endian = choice(["little", "big"])
            a = bitarray(n, endian)
            a.setall(getrandbits(1))
            b = lexico_next(a)
            self.assertEqual(b.endian, endian)
            # nothing to permute
            self.assertEqual(b, a)

    def test_next_explicit(self):
        for perm, endian in [
                (['100', '010', '001', '100'], 'little'),
                (['00001', '00010', '00100', '01000', '10000'], 'big'),
                (['0011', '0101', '0110', '1001', '1010',
                  '1100', '0011'], 'big'),
                (['0000111', '1110000'], 'little'),
        ]:
            a = bitarray(perm[0], endian)
            for s in perm[1:]:
                a = lexico_next(a)
                self.assertEqual(a, bitarray(s))

    def check_cycle(self, n, k):
        endian = choice(["little", "big"])
        a0 = bitarray(n, endian)
        a0[:k] = 1
        if endian == "big":
            a0.reverse()

        ncycle = math.comb(n, k)  # cycle length
        self.assertTrue(ncycle >= 2)
        coll = set()
        a = a0.copy()
        for i in range(ncycle):
            coll.add(frozenbitarray(a))
            b = lexico_next(a)
            self.assertEqual(len(b), n)
            self.assertEqual(b.count(), k)
            self.assertEqual(b.endian, endian)
            self.assertNotEqual(a, b)
            if b == a0:
                self.assertEqual(i, ncycle - 1)
                self.assertTrue(ba2int(b) < ba2int(a))
                break
            self.assertTrue(ba2int(b) > ba2int(a))
            a = b
        else:
            self.fail()

        self.assertEqual(len(coll), ncycle)

    def test_cycle(self):
        for _ in range(20):
            n = randrange(2, 10)
            k = randrange(1, n)
            self.check_cycle(n, k)

    def test_next_random(self):
        for _ in range(100):
            endian = choice(["little", "big"])
            n = randrange(2, 1_000)
            k = randrange(1, n)
            a = random_k(n, k, endian)
            b = lexico_next(a)
            self.assertEqual(len(b), n)
            self.assertEqual(b.count(), k)
            self.assertEqual(b.endian, endian)
            self.assertNotEqual(a, b)
            if ba2int(a) > ba2int(b):
                c = a.copy()
                c.sort(endian == 'big')
                self.assertEqual(a, c)
                self.assertEqual(b, a[::-1])

    # -------------------  lexico_all  -------------------

    def test_all_explicit(self):
        for n, k, res in [
                (0, 0, ['']),
                (1, 0, ['0']),
                (1, 1, ['1']),
                (2, 0, ['00']),
                (2, 1, ['01', '10']),
                (2, 2, ['11']),
                (3, 0, ['000']),
                (3, 1, ['001', '010', '100']),
                (3, 2, ['011', '101', '110']),
                (3, 3, ['111']),
                (4, 2, ['0011', '0101', '0110', '1001', '1010', '1100']),
        ]:
            lst = list(lexico_all(n, k, 'big'))
            self.assertEqual(len(lst), math.comb(n, k))
            self.assertEqual(lst, [bitarray(s) for s in res])
            if n == 0:
                continue
            a = lst[0]
            for i in range(20):
                self.assertEqual(a, bitarray(res[i % len(lst)]))
                a = lexico_next(a)

    def test_all_perm(self):
        n, k = 17, 5
        endian=choice(["little", "big"])

        prev = None
        cnt = 0
        coll = set()
        for a in lexico_all(n, k, endian):
            self.assertEqual(type(a), bitarray)
            self.assertEqual(len(a), n)
            self.assertEqual(a.count(), k)
            self.assertEqual(a.endian, endian)
            coll.add(frozenbitarray(a))
            if prev is None:
                first = a.copy()
                c = a.copy()
                c.sort(c.endian == "little")
                self.assertEqual(a, c)
            else:
                self.assertNotEqual(a, first)
                self.assertEqual(lexico_next(prev), a)
                self.assertTrue(ba2int(prev) < ba2int(a))
            prev = a
            cnt += 1

        self.assertEqual(cnt, math.comb(n, k))
        self.assertEqual(len(coll), cnt)

        # a is now the last permutation
        last = a.copy()
        self.assertTrue(ba2int(first) < ba2int(last))
        self.assertEqual(last, first[::-1])

    def test_all_order(self):
        n, k = 10, 5
        for a, b in pairwise(lexico_all(n, k, 'little')):
            self.assertTrue(ba2int(b) > ba2int(a))
            self.assertEqual(lexico_next(a), b)


if __name__ == '__main__':
    unittest.main()