types.py 10 KB
Newer Older
1
import ctypes
2
import sympy as sp
3
import numpy as np
4
from sympy.core.cache import cacheit
5
from pystencils.cache import memorycache
6
7
8


class TypedSymbol(sp.Symbol):
Martin Bauer's avatar
Martin Bauer committed
9
10
    def __new__(cls, *args, **kwds):
        obj = TypedSymbol.__xnew_cached_(cls, *args, **kwds)
11
12
        return obj

13
    def __new_stage2__(cls, name, dtype):
14
        obj = super(TypedSymbol, cls).__xnew__(cls, name)
15
16
17
18
19
        try:
            obj._dtype = createType(dtype)
        except TypeError:
            # on error keep the string
            obj._dtype = dtype
20
21
22
23
24
25
26
27
28
29
30
        return obj

    __xnew__ = staticmethod(__new_stage2__)
    __xnew_cached_ = staticmethod(cacheit(__new_stage2__))

    @property
    def dtype(self):
        return self._dtype

    def _hashable_content(self):
        superClassContents = list(super(TypedSymbol, self)._hashable_content())
31
        return tuple(superClassContents + [hash(repr(self._dtype))])
32
33

    def __getnewargs__(self):
34
35
36
        return self.name, self.dtype


37
def createType(specification):
Jan Hoenig's avatar
Jan Hoenig committed
38
39
40
41
42
    """
    Create a subclass of Type according to a string or an object of subclass Type
    :param specification: Type object, or a string
    :return: Type object, or a new Type object parsed from the string
    """
43
44
45
46
47
48
    if isinstance(specification, Type):
        return specification
    elif isinstance(specification, str):
        return createTypeFromString(specification)
    else:
        npDataType = np.dtype(specification)
49
50
51
52
        if npDataType.fields is None:
            return BasicType(npDataType, const=False)
        else:
            return StructType(npDataType, const=False)
53
54
55


def createTypeFromString(specification):
Jan Hoenig's avatar
Jan Hoenig committed
56
57
58
59
60
    """
    Creates a new Type object from a c-like string specification
    :param specification: Specification string
    :return: Type object
    """
61
62
63
64
65
66
67
    specification = specification.lower().split()
    parts = []
    current = []
    for s in specification:
        if s == '*':
            parts.append(current)
            current = [s]
68
        else:
69
70
71
            current.append(s)
    if len(current) > 0:
        parts.append(current)
Jan Hoenig's avatar
Jan Hoenig committed
72
        # Parse native part
73
74
75
76
77
78
    basePart = parts.pop(0)
    const = False
    if 'const' in basePart:
        const = True
        basePart.remove('const')
    assert len(basePart) == 1
Jan Hoenig's avatar
Jan Hoenig committed
79
80
81
    if basePart[0][-1] == "*":
        basePart[0] = basePart[0][:-1]
        parts.append('*')
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
    baseType = BasicType(basePart[0], const)
    currentType = baseType
    # Parse pointer parts
    for part in parts:
        restrict = False
        const = False
        if 'restrict' in part:
            restrict = True
            part.remove('restrict')
        if 'const' in part:
            const = True
            part.remove("const")
        assert len(part) == 1 and part[0] == '*'
        currentType = PointerType(currentType, const, restrict)
    return currentType


def getBaseType(type):
    while type.baseType is not None:
        type = type.baseType
    return type


def toCtypes(dataType):
Jan Hoenig's avatar
Jan Hoenig committed
106
107
108
109
110
    """
    Transforms a given Type into ctypes
    :param dataType: Subclass of Type
    :return: ctypes type object
    """
111
112
    if isinstance(dataType, PointerType):
        return ctypes.POINTER(toCtypes(dataType.baseType))
113
114
    elif isinstance(dataType, StructType):
        return ctypes.POINTER(ctypes.c_uint8)
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
    else:
        return toCtypes.map[dataType.numpyDtype]

toCtypes.map = {
    np.dtype(np.int8): ctypes.c_int8,
    np.dtype(np.int16): ctypes.c_int16,
    np.dtype(np.int32): ctypes.c_int32,
    np.dtype(np.int64): ctypes.c_int64,

    np.dtype(np.uint8): ctypes.c_uint8,
    np.dtype(np.uint16): ctypes.c_uint16,
    np.dtype(np.uint32): ctypes.c_uint32,
    np.dtype(np.uint64): ctypes.c_uint64,

    np.dtype(np.float32): ctypes.c_float,
    np.dtype(np.float64): ctypes.c_double,
}


134
135
136
137
def getTypeOfExpression(expr):
    if isinstance(expr, TypedSymbol):
        return expr.dtype

138
139


140
141
142
class Type(sp.Basic):
    def __new__(cls, *args, **kwargs):
        return sp.Basic.__new__(cls)
143

Jan Hoenig's avatar
Jan Hoenig committed
144
145
146
147
148
149
    def __lt__(self, other):
        # Needed for sorting the types inside an expression
        if isinstance(self, BasicType):
            if isinstance(other, BasicType):
                return self.numpyDtype < other.numpyDtype  # TODO const
            if isinstance(other, PointerType):
150
                return False
Jan Hoenig's avatar
Jan Hoenig committed
151
152
153
154
            if isinstance(other, StructType):
                raise NotImplementedError("Struct type comparison is not yet implemented")
        if isinstance(self, PointerType):
            if isinstance(other, BasicType):
155
                return True
Jan Hoenig's avatar
Jan Hoenig committed
156
157
158
159
160
161
            if isinstance(other, PointerType):
                return self.baseType < other.baseType  # TODO const, restrict
            if isinstance(other, StructType):
                raise NotImplementedError("Struct type comparison is not yet implemented")
        if isinstance(self, StructType):
            raise NotImplementedError("Struct type comparison is not yet implemented")
162
163
164
165
166


class BasicType(Type):
    @staticmethod
    def numpyNameToC(name):
Jan Hoenig's avatar
Jan Hoenig committed
167
168
169
170
        if name == 'float64':
            return 'double'
        elif name == 'float32':
            return 'float'
171
172
173
174
        elif name.startswith('int'):
            width = int(name[len("int"):])
            return "int%d_t" % (width,)
        elif name.startswith('uint'):
175
            width = int(name[len("uint"):])
176
177
178
179
180
181
182
183
            return "uint%d_t" % (width,)
        elif name == 'bool':
            return 'bool'
        else:
            raise NotImplemented("Can map numpy to C name for %s" % (name,))

    def __init__(self, dtype, const=False):
        self.const = const
184
185
186
187
        if isinstance(dtype, Type):
            self._dtype = dtype.numpyDtype
        else:
            self._dtype = np.dtype(dtype)
188
189
190
191
        assert self._dtype.fields is None, "Tried to initialize NativeType with a structured type"
        assert self._dtype.hasobject is False
        assert self._dtype.subdtype is None

192
193
194
    def __getnewargs__(self):
        return self.numpyDtype, self.const

195
196
197
    @property
    def baseType(self):
        return None
198

199
200
201
202
    @property
    def numpyDtype(self):
        return self._dtype

203
204
205
206
    @property
    def itemSize(self):
        return 1

207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    def is_int(self):
        return self.numpyDtype in np.sctypes['int']

    def is_float(self):
        return self.numpyDtype in np.sctypes['float']

    def is_uint(self):
        return self.numpyDtype in np.sctypes['uint']

    def is_comlex(self):
        return self.numpyDtype in np.sctypes['complex']

    def is_other(self):
        return self.numpyDtype in np.sctypes['others']

222
223
224
225
    @property
    def baseName(self):
        return BasicType.numpyNameToC(str(self._dtype))

Jan Hoenig's avatar
Jan Hoenig committed
226
    def __str__(self):
227
228
229
230
        result = BasicType.numpyNameToC(str(self._dtype))
        if self.const:
            result += " const"
        return result
Jan Hoenig's avatar
Jan Hoenig committed
231
232

    def __eq__(self, other):
233
234
        if not isinstance(other, BasicType):
            return False
Jan Hoenig's avatar
Jan Hoenig committed
235
        else:
236
237
238
239
240
241
242
243
244
245
246
247
            return (self.numpyDtype, self.const) == (other.numpyDtype, other.const)

    def __hash__(self):
        return hash(str(self))


class PointerType(Type):
    def __init__(self, baseType, const=False, restrict=True):
        self._baseType = baseType
        self.const = const
        self.restrict = restrict

248
249
250
    def __getnewargs__(self):
        return self.baseType, self.const, self.restrict

251
252
253
254
255
256
257
258
    @property
    def alias(self):
        return not self.restrict

    @property
    def baseType(self):
        return self._baseType

259
260
261
262
    @property
    def itemSize(self):
        return self.baseType.itemSize

263
264
    def __eq__(self, other):
        if not isinstance(other, PointerType):
Jan Hoenig's avatar
Jan Hoenig committed
265
            return False
266
267
268
        else:
            return (self.baseType, self.const, self.restrict) == (other.baseType, other.const, other.restrict)

Jan Hoenig's avatar
Jan Hoenig committed
269
    def __str__(self):
Jan Hoenig's avatar
Jan Hoenig committed
270
        return "%s *%s%s" % (self.baseType, " RESTRICT " if self.restrict else "", " const " if self.const else "")
271
272
273
274

    def __hash__(self):
        return hash(str(self))

Jan Hoenig's avatar
Jan Hoenig committed
275

276
class StructType(object):
277
278
    def __init__(self, numpyType, const=False):
        self.const = const
279
        self._dtype = np.dtype(numpyType)
Martin Bauer's avatar
Martin Bauer committed
280

281
282
283
    def __getnewargs__(self):
        return self.numpyDtype, self.const

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    @property
    def baseType(self):
        return None

    @property
    def numpyDtype(self):
        return self._dtype

    @property
    def itemSize(self):
        return self.numpyDtype.itemsize

    def getElementOffset(self, elementName):
        return self.numpyDtype.fields[elementName][1]

    def getElementType(self, elementName):
        npElementType = self.numpyDtype.fields[elementName][0]
        return BasicType(npElementType, self.const)

303
304
305
    def hasElement(self, elementName):
        return elementName in self.numpyDtype.fields

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
    def __eq__(self, other):
        if not isinstance(other, StructType):
            return False
        else:
            return (self.numpyDtype, self.const) == (other.numpyDtype, other.const)

    def __str__(self):
        # structs are handled byte-wise
        result = "uint8_t"
        if self.const:
            result += " const"
        return result

    def __hash__(self):
        return hash((self.numpyDtype, self.const))
321

Jan Hoenig's avatar
Jan Hoenig committed
322
    # TODO this should not work at all!!!
Jan Hoenig's avatar
Jan Hoenig committed
323
324
325
326
327
328
329
    def __gt__(self, other):
        if self.ptr and not other.ptr:
            return True
        if self.dtype > other.dtype:
            return True


Jan Hoenig's avatar
Jan Hoenig committed
330
def get_type_from_sympy(node):
Jan Hoenig's avatar
Jan Hoenig committed
331
332
333
334
335
    """
    Creates a Type object from a Sympy object
    :param node: Sympy object
    :return: Type object
    """
Jan Hoenig's avatar
Jan Hoenig committed
336
337
338
339
340
341
342
343
344
345
    # Rational, NumberSymbol?
    # Zero, One, NegativeOne )= Integer
    # Half )= Rational
    # NAN, Infinity, Negative Inifinity,
    # Exp1, Imaginary Unit, Pi, EulerGamma, Catalan, Golden Ratio
    # Pow, Mul, Add, Mod, Relational
    if not isinstance(node, sp.Number):
        raise TypeError(node, 'is not a sp.Number')

    if isinstance(node, sp.Float) or isinstance(node, sp.RealNumber):
Jan Hoenig's avatar
Jan Hoenig committed
346
        return createType('double'), float(node)
Jan Hoenig's avatar
Jan Hoenig committed
347
    elif isinstance(node, sp.Integer):
Jan Hoenig's avatar
Jan Hoenig committed
348
        return createType('int'), int(node)
Jan Hoenig's avatar
Jan Hoenig committed
349
350
351
    elif isinstance(node, sp.Rational):
        raise NotImplementedError('Rationals are not supported yet')
    else:
Jan Hoenig's avatar
Jan Hoenig committed
352
        raise TypeError(node, ' is not a supported type (yet)!')