~bzr-pqm/bzr/bzr.dev

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
# Copyright (C) 2009 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Interface definition of a class like PySet but without caching the hash.

This is generally useful when you want to 'intern' objects, etc. Note that this
differs from Set in that we:
  1) Don't have all of the .intersection, .difference, etc functions
  2) Do return the object from the set via queries
     eg. SimpleSet.add(key) => saved_key and SimpleSet[key] => saved_key
"""

cdef extern from "Python.h":
    ctypedef struct PyObject:
        pass


cdef public api class SimpleSet [object SimpleSetObject, type SimpleSet_Type]:
    """A class similar to PySet, but with simpler implementation.

    The main advantage is that this class uses only 2N memory to store N
    objects rather than 4N memory. The main trade-off is that we do not cache
    the hash value of saved objects. As such, it is assumed that computing the
    hash will be cheap (such as strings or tuples of strings, etc.)

    This also differs in that you can get back the objects that are stored
    (like a dict), but we also don't implement the complete list of 'set'
    operations (difference, intersection, etc).
    """

    cdef Py_ssize_t _used   # active
    cdef Py_ssize_t _fill   # active + dummy
    cdef Py_ssize_t _mask   # Table contains (mask+1) slots, a power
                                     # of 2
    cdef PyObject **_table  # Pyrex/Cython doesn't support arrays to 'object'
                            # so we manage it manually

    cdef PyObject *_get(self, object key) except? NULL
    cdef object _add(self, key)
    cdef int _discard(self, key) except -1
    cdef int _insert_clean(self, PyObject *key) except -1
    cdef Py_ssize_t _resize(self, Py_ssize_t min_unused) except -1


# TODO: might want to export the C api here, though it is all available from
#       the class object...
cdef api object SimpleSet_Add(object self, object key)
cdef api SimpleSet SimpleSet_New()
cdef api object SimpleSet_Add(object self, object key)
cdef api int SimpleSet_Contains(object self, object key) except -1
cdef api int SimpleSet_Discard(object self, object key) except -1
cdef api PyObject *SimpleSet_Get(SimpleSet self, object key) except? NULL
cdef api Py_ssize_t SimpleSet_Size(object self) except -1
cdef api int SimpleSet_Next(object self, Py_ssize_t *pos, PyObject **key)