cbackend.py 26.1 KB
Newer Older
Martin Bauer's avatar
Martin Bauer committed
1
from collections import namedtuple
2
from typing import Set
3

4
import numpy as np
5
6
import sympy as sp
from sympy.core import S
7
from sympy.printing.ccode import C89CodePrinter
8

9
from pystencils.astnodes import KernelFunction, Node
10
from pystencils.cpu.vectorization import vec_all, vec_any
Martin Bauer's avatar
Martin Bauer committed
11
from pystencils.data_types import (
12
13
    PointerType, VectorType, address_of, cast_func, create_type, get_type_of_expression,
    reinterpret_cast_func, vector_memory_access)
Martin Bauer's avatar
Martin Bauer committed
14
15
from pystencils.fast_approximation import fast_division, fast_inv_sqrt, fast_sqrt
from pystencils.integer_functions import (
16
17
    bit_shift_left, bit_shift_right, bitwise_and, bitwise_or, bitwise_xor,
    int_div, int_power_of_2, modulo_ceil)
18
from pystencils.kernelparameters import FieldPointerSymbol
19

Martin Bauer's avatar
Martin Bauer committed
20
21
try:
    from sympy.printing.ccode import C99CodePrinter as CCodePrinter
Martin Bauer's avatar
Martin Bauer committed
22
23
except ImportError:
    from sympy.printing.ccode import CCodePrinter  # for sympy versions < 1.1
Martin Bauer's avatar
Martin Bauer committed
24

25
__all__ = ['generate_c', 'CustomCodeNode', 'PrintNode', 'get_headers', 'CustomSympyPrinter']
26

27
28
KERNCRAFT_NO_TERNARY_MODE = False

Martin Bauer's avatar
Fixes    
Martin Bauer committed
29

30
def generate_c(ast_node: Node, signature_only: bool = False, dialect='c', custom_backend=None) -> str:
Martin Bauer's avatar
Martin Bauer committed
31
32
33
34
35
36
37
38
39
    """Prints an abstract syntax tree node as C or CUDA code.

    This function does not need to distinguish between C, C++ or CUDA code, it just prints 'C-like' code as encoded
    in the abstract syntax tree (AST). The AST is built differently for C or CUDA by calling different create_kernel
    functions.

    Args:
        ast_node:
        signature_only:
40
        dialect: 'c' or 'cuda'
Martin Bauer's avatar
Martin Bauer committed
41
42
    Returns:
        C-like code for the ast node and its descendants
Martin Bauer's avatar
Martin Bauer committed
43
    """
44
45
46
47
48
49
    global_declarations = get_global_declarations(ast_node)
    for d in global_declarations:
        if hasattr(ast_node, "global_variables"):
            ast_node.global_variables.update(d.symbols_defined)
        else:
            ast_node.global_variables = d.symbols_defined
50
51
52
    if custom_backend:
        printer = custom_backend
    elif dialect == 'c':
53
54
55
56
        try:
            instruction_set = ast_node.instruction_set
        except Exception:
            instruction_set = None
57
        printer = CBackend(signature_only=signature_only,
58
                           vector_instruction_set=instruction_set)
59
60
61
    elif dialect == 'cuda':
        from pystencils.backends.cuda_backend import CudaBackend
        printer = CudaBackend(signature_only=signature_only)
Stephan Seitz's avatar
Stephan Seitz committed
62
    elif dialect == 'opencl':
63
64
        from pystencils.backends.opencl_backend import OpenClBackend
        printer = OpenClBackend(signature_only=signature_only)
65
    else:
Martin Bauer's avatar
Martin Bauer committed
66
        raise ValueError("Unknown dialect: " + str(dialect))
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
    code = printer(ast_node)
    if not signature_only and isinstance(ast_node, KernelFunction):
        code = "\n" + code
        for declaration in global_declarations:
            code = printer(declaration) + "\n" + code

    return code


def get_global_declarations(ast):
    global_declarations = []

    def visit_node(sub_ast):
        if hasattr(sub_ast, "required_global_declarations"):
            nonlocal global_declarations
            global_declarations += sub_ast.required_global_declarations

        if hasattr(sub_ast, "args"):
            for node in sub_ast.args:
                visit_node(node)

    visit_node(ast)

90
    return sorted(set(global_declarations), key=lambda x: str(x))
91
92


Martin Bauer's avatar
Martin Bauer committed
93
94
def get_headers(ast_node: Node) -> Set[str]:
    """Return a set of header files, necessary to compile the printed C-like code."""
95
96
    headers = set()

Martin Bauer's avatar
Martin Bauer committed
97
98
99
    if isinstance(ast_node, KernelFunction) and ast_node.instruction_set:
        headers.update(ast_node.instruction_set['headers'])

Martin Bauer's avatar
Martin Bauer committed
100
101
102
    if hasattr(ast_node, 'headers'):
        headers.update(ast_node.headers)
    for a in ast_node.args:
103
        if isinstance(a, Node):
Martin Bauer's avatar
Martin Bauer committed
104
            headers.update(get_headers(a))
105

106
    return sorted(headers)
107
108


109
110
111
# --------------------------------------- Backend Specific Nodes -------------------------------------------------------


112
class CustomCodeNode(Node):
Martin Bauer's avatar
Martin Bauer committed
113
    def __init__(self, code, symbols_read, symbols_defined, parent=None):
114
        super(CustomCodeNode, self).__init__(parent=parent)
115
        self._code = "\n" + code
116
117
        self._symbols_read = set(symbols_read)
        self._symbols_defined = set(symbols_defined)
118
        self.headers = []
119

120
    def get_code(self, dialect, vector_instruction_set):
121
122
123
124
125
126
127
        return self._code

    @property
    def args(self):
        return []

    @property
Martin Bauer's avatar
Martin Bauer committed
128
    def symbols_defined(self):
129
        return self._symbols_defined
130
131

    @property
Martin Bauer's avatar
Martin Bauer committed
132
    def undefined_symbols(self):
133
        return self._symbols_read - self._symbols_defined
134
135


136
class PrintNode(CustomCodeNode):
Martin Bauer's avatar
Martin Bauer committed
137
138
139
140
    # noinspection SpellCheckingInspection
    def __init__(self, symbol_to_print):
        code = '\nstd::cout << "%s  =  " << %s << std::endl; \n' % (symbol_to_print.name, symbol_to_print.name)
        super(PrintNode, self).__init__(code, symbols_read=[symbol_to_print], symbols_defined=set())
141
        self.headers.append("<iostream>")
142
143
144
145


# ------------------------------------------- Printer ------------------------------------------------------------------

146

Martin Bauer's avatar
Martin Bauer committed
147
148
# noinspection PyPep8Naming
class CBackend:
149

Martin Bauer's avatar
Martin Bauer committed
150
    def __init__(self, sympy_printer=None, signature_only=False, vector_instruction_set=None, dialect='c'):
Martin Bauer's avatar
Martin Bauer committed
151
152
        if sympy_printer is None:
            if vector_instruction_set is not None:
153
                self.sympy_printer = VectorizedCustomSympyPrinter(vector_instruction_set)
154
            else:
155
                self.sympy_printer = CustomSympyPrinter()
156
        else:
Martin Bauer's avatar
Martin Bauer committed
157
            self.sympy_printer = sympy_printer
158

159
        self._vector_instruction_set = vector_instruction_set
160
        self._indent = "   "
161
        self._dialect = dialect
Martin Bauer's avatar
Martin Bauer committed
162
        self._signatureOnly = signature_only
163
164

    def __call__(self, node):
Martin Bauer's avatar
Martin Bauer committed
165
        prev_is = VectorType.instruction_set
166
        VectorType.instruction_set = self._vector_instruction_set
167
        result = str(self._print(node))
Martin Bauer's avatar
Martin Bauer committed
168
        VectorType.instruction_set = prev_is
169
        return result
170
171

    def _print(self, node):
Stephan Seitz's avatar
Stephan Seitz committed
172
173
        if isinstance(node, str):
            return node
174
        for cls in type(node).__mro__:
Martin Bauer's avatar
Martin Bauer committed
175
176
177
            method_name = "_print_" + cls.__name__
            if hasattr(self, method_name):
                return getattr(self, method_name)(node)
178
        raise NotImplementedError(self.__class__.__name__ + " does not support node of type " + node.__class__.__name__)
179

180
181
182
    def _print_Type(self, node):
        return str(node)

183
    def _print_KernelFunction(self, node):
184
        function_arguments = ["%s %s" % (self._print(s.symbol.dtype), s.symbol.name) for s in node.get_parameters()]
185
        launch_bounds = ""
186
        if self._dialect == 'cuda':
187
188
189
190
191
            max_threads = node.indexing.max_threads_per_block()
            if max_threads:
                launch_bounds = "__launch_bounds__({}) ".format(max_threads)
        func_declaration = "FUNC_PREFIX %svoid %s(%s)" % (launch_bounds, node.function_name,
                                                          ", ".join(function_arguments))
192
        if self._signatureOnly:
Martin Bauer's avatar
Martin Bauer committed
193
            return func_declaration
194

195
        body = self._print(node.body)
Martin Bauer's avatar
Martin Bauer committed
196
        return func_declaration + "\n" + body
197
198

    def _print_Block(self, node):
Martin Bauer's avatar
Martin Bauer committed
199
200
        block_contents = "\n".join([self._print(child) for child in node.args])
        return "{\n%s\n}" % (self._indent + self._indent.join(block_contents.splitlines(True)))
201
202

    def _print_PragmaBlock(self, node):
Martin Bauer's avatar
Martin Bauer committed
203
        return "%s\n%s" % (node.pragma_line, self._print_Block(node))
204
205

    def _print_LoopOverCoordinate(self, node):
Martin Bauer's avatar
Martin Bauer committed
206
        counter_symbol = node.loop_counter_name
Martin Bauer's avatar
Martin Bauer committed
207
208
209
210
        start = "int %s = %s" % (counter_symbol, self.sympy_printer.doprint(node.start))
        condition = "%s < %s" % (counter_symbol, self.sympy_printer.doprint(node.stop))
        update = "%s += %s" % (counter_symbol, self.sympy_printer.doprint(node.step),)
        loop_str = "for (%s; %s; %s)" % (start, condition, update)
211

Martin Bauer's avatar
Martin Bauer committed
212
        prefix = "\n".join(node.prefix_lines)
213
214
        if prefix:
            prefix += "\n"
Martin Bauer's avatar
Martin Bauer committed
215
        return "%s%s\n%s" % (prefix, loop_str, self._print(node.body))
216
217

    def _print_SympyAssignment(self, node):
Martin Bauer's avatar
Martin Bauer committed
218
        if node.is_declaration:
Stephan Seitz's avatar
Lint    
Stephan Seitz committed
219
220
221
222
223
            if node.is_const:
                prefix = 'const '
            else:
                prefix = ''
            data_type = prefix + self._print(node.lhs.dtype) + " "
224
225
            return "%s%s = %s;" % (data_type, self.sympy_printer.doprint(node.lhs),
                                   self.sympy_printer.doprint(node.rhs))
226
        else:
Martin Bauer's avatar
Martin Bauer committed
227
            lhs_type = get_type_of_expression(node.lhs)
Martin Bauer's avatar
Martin Bauer committed
228
229
230
231
232
233
            if type(lhs_type) is VectorType and isinstance(node.lhs, cast_func):
                arg, data_type, aligned, nontemporal = node.lhs.args
                instr = 'storeU'
                if aligned:
                    instr = 'stream' if nontemporal else 'storeA'

234
235
236
237
238
239
                rhs_type = get_type_of_expression(node.rhs)
                if type(rhs_type) is not VectorType:
                    rhs = cast_func(node.rhs, VectorType(rhs_type))
                else:
                    rhs = node.rhs

240
241
                return self._vector_instruction_set[instr].format("&" + self.sympy_printer.doprint(node.lhs.args[0]),
                                                                  self.sympy_printer.doprint(rhs)) + ';'
242
            else:
Martin Bauer's avatar
Martin Bauer committed
243
                return "%s = %s;" % (self.sympy_printer.doprint(node.lhs), self.sympy_printer.doprint(node.rhs))
244
245

    def _print_TemporaryMemoryAllocation(self, node):
246
        align = 64
Martin Bauer's avatar
Martin Bauer committed
247
248
249
250
251
252
        np_dtype = node.symbol.dtype.base_type.numpy_dtype
        required_size = np_dtype.itemsize * node.size + align
        size = modulo_ceil(required_size, align)
        code = "{dtype} {name}=({dtype})aligned_alloc({align}, {size}) + {offset};"
        return code.format(dtype=node.symbol.dtype,
                           name=self.sympy_printer.doprint(node.symbol.name),
253
                           size=self.sympy_printer.doprint(size),
Martin Bauer's avatar
Martin Bauer committed
254
255
                           offset=int(node.offset(align)),
                           align=align)
256
257

    def _print_TemporaryMemoryFree(self, node):
258
        align = 64
Martin Bauer's avatar
Martin Bauer committed
259
        return "free(%s - %d);" % (self.sympy_printer.doprint(node.symbol.name), node.offset(align))
260

Martin Bauer's avatar
Martin Bauer committed
261
    def _print_SkipIteration(self, _):
262
        return "continue;"
Martin Bauer's avatar
Martin Bauer committed
263

264
265
    def _print_CustomCodeNode(self, node):
        return node.get_code(self._dialect, self._vector_instruction_set)
266

267
    def _print_Conditional(self, node):
268
269
270
        cond_type = get_type_of_expression(node.condition_expr)
        if isinstance(cond_type, VectorType):
            raise ValueError("Problem with Conditional inside vectorized loop - use vec_any or vec_all")
Martin Bauer's avatar
Martin Bauer committed
271
272
        condition_expr = self.sympy_printer.doprint(node.condition_expr)
        true_block = self._print_Block(node.true_block)
Martin Bauer's avatar
Martin Bauer committed
273
        result = "if (%s)\n%s " % (condition_expr, true_block)
Martin Bauer's avatar
Martin Bauer committed
274
275
        if node.false_block:
            false_block = self._print_Block(node.false_block)
Martin Bauer's avatar
Martin Bauer committed
276
            result += "else " + false_block
277
278
        return result

279
    def _print_DestructuringBindingsForFieldClass(self, node):
280
281
        # Define all undefined symbols
        undefined_field_symbols = node.symbols_defined
282
283
284
        destructuring_bindings = ["%s %s = %s.%s;" %
                                  (u.dtype,
                                   u.name,
285
                                   u.field_name if hasattr(u, 'field_name') else u.field_names[0],
286
287
                                   node.CLASS_TO_MEMBER_DICT[u.__class__] %
                                   (() if type(u) == FieldPointerSymbol else (u.coordinate,)))
288
289
                                  for u in undefined_field_symbols
                                  ]
290
        destructuring_bindings.sort()  # only for code aesthetics
291
        return "{\n" + self._indent + \
Stephan Seitz's avatar
Stephan Seitz committed
292
293
294
295
               ("\n" + self._indent).join(destructuring_bindings) + \
               "\n" + self._indent + \
               ("\n" + self._indent).join(self._print(node.body).splitlines()) + \
               "\n}"
296

297
298
299
300

# ------------------------------------------ Helper function & classes -------------------------------------------------


Martin Bauer's avatar
Martin Bauer committed
301
# noinspection PyPep8Naming
302
class CustomSympyPrinter(CCodePrinter):
Martin Bauer's avatar
Martin Bauer committed
303

304
    def __init__(self):
Martin Bauer's avatar
Martin Bauer committed
305
        super(CustomSympyPrinter, self).__init__()
306
        self._float_type = create_type("float32")
307
308
309
310
        if 'Min' in self.known_functions:
            del self.known_functions['Min']
        if 'Max' in self.known_functions:
            del self.known_functions['Max']
Martin Bauer's avatar
Martin Bauer committed
311

312
313
    def _print_Pow(self, expr):
        """Don't use std::pow function, for small integer exponents, write as multiplication"""
Martin Bauer's avatar
Martin Bauer committed
314
315
316
        if not expr.free_symbols:
            return self._typed_number(expr.evalf(), get_type_of_expression(expr))

317
        if expr.exp.is_integer and expr.exp.is_number and 0 < expr.exp < 8:
318
            return "(" + self._print(sp.Mul(*[expr.base] * expr.exp, evaluate=False)) + ")"
319
320
        elif expr.exp.is_integer and expr.exp.is_number and - 8 < expr.exp < 0:
            return "1 / ({})".format(self._print(sp.Mul(*[expr.base] * (-expr.exp), evaluate=False)))
321
322
323
324
325
        else:
            return super(CustomSympyPrinter, self)._print_Pow(expr)

    def _print_Rational(self, expr):
        """Evaluate all rationals i.e. print 0.25 instead of 1.0/4.0"""
Martin Bauer's avatar
Martin Bauer committed
326
327
        res = str(expr.evalf().num)
        return res
328
329
330
331
332
333
334
335

    def _print_Equality(self, expr):
        """Equality operator is not printable in default printer"""
        return '((' + self._print(expr.lhs) + ") == (" + self._print(expr.rhs) + '))'

    def _print_Piecewise(self, expr):
        """Print piecewise in one line (remove newlines)"""
        result = super(CustomSympyPrinter, self)._print_Piecewise(expr)
Martin Bauer's avatar
Martin Bauer committed
336
337
        return result.replace("\n", "")

338
    def _print_Function(self, expr):
339
        infix_functions = {
Martin Bauer's avatar
Martin Bauer committed
340
341
342
343
344
            bitwise_xor: '^',
            bit_shift_right: '>>',
            bit_shift_left: '<<',
            bitwise_or: '|',
            bitwise_and: '&',
Martin Bauer's avatar
Martin Bauer committed
345
        }
Martin Bauer's avatar
Martin Bauer committed
346
347
        if hasattr(expr, 'to_c'):
            return expr.to_c(self._print)
348
349
350
        if isinstance(expr, reinterpret_cast_func):
            arg, data_type = expr.args
            return "*((%s)(& %s))" % (PointerType(data_type, restrict=False), self._print(arg))
351
352
353
        elif isinstance(expr, address_of):
            assert len(expr.args) == 1, "address_of must only have one argument"
            return "&(%s)" % self._print(expr.args[0])
354
        elif isinstance(expr, cast_func):
Martin Bauer's avatar
Martin Bauer committed
355
            arg, data_type = expr.args
356
357
358
            if isinstance(arg, sp.Number):
                return self._typed_number(arg, data_type)
            else:
359
360
                return "((%s)(%s))" % (data_type, self._print(arg))
        elif isinstance(expr, fast_division):
361
            return "({})".format(self._print(expr.args[0] / expr.args[1]))
362
        elif isinstance(expr, fast_sqrt):
363
            return "({})".format(self._print(sp.sqrt(expr.args[0])))
364
365
        elif isinstance(expr, vec_any) or isinstance(expr, vec_all):
            return self._print(expr.args[0])
366
        elif isinstance(expr, fast_inv_sqrt):
367
            return "({})".format(self._print(1 / sp.sqrt(expr.args[0])))
368
369
        elif expr.func in infix_functions:
            return "(%s %s %s)" % (self._print(expr.args[0]), infix_functions[expr.func], self._print(expr.args[1]))
370
371
372
373
        elif expr.func == int_power_of_2:
            return "(1 << (%s))" % (self._print(expr.args[0]))
        elif expr.func == int_div:
            return "((%s) / (%s))" % (self._print(expr.args[0]), self._print(expr.args[1]))
374
        else:
375
            return super(CustomSympyPrinter, self)._print_Function(expr)
Martin Bauer's avatar
Martin Bauer committed
376

377
378
    def _typed_number(self, number, dtype):
        res = self._print(number)
379
380
381
382
        if dtype.numpy_dtype == np.float32:
            return res + '.0f' if '.' not in res else res + 'f'
        elif dtype.numpy_dtype == np.float64:
            return res + '.0' if '.' not in res else res
383
384
        else:
            return res
385

Stephan Seitz's avatar
Stephan Seitz committed
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    def _print_Sum(self, expr):
        template = """[&]() {{
    {dtype} sum = ({dtype}) 0;
    for ( {iterator_dtype} {var} = {start}; {condition}; {var} += {increment} ) {{
        sum += {expr};
    }}
    return sum;
}}()"""
        var = expr.limits[0][0]
        start = expr.limits[0][1]
        end = expr.limits[0][2]
        code = template.format(
            dtype=get_type_of_expression(expr.args[0]),
            iterator_dtype='int',
            var=self._print(var),
            start=self._print(start),
            end=self._print(end),
            expr=self._print(expr.function),
            increment=str(1),
            condition=self._print(var) + ' <= ' + self._print(end)  # if start < end else '>='
        )
        return code

    def _print_Product(self, expr):
        template = """[&]() {{
    {dtype} product = ({dtype}) 1;
    for ( {iterator_dtype} {var} = {start}; {condition}; {var} += {increment} ) {{
        product *= {expr};
    }}
    return product;
}}()"""
        var = expr.limits[0][0]
        start = expr.limits[0][1]
        end = expr.limits[0][2]
        code = template.format(
            dtype=get_type_of_expression(expr.args[0]),
            iterator_dtype='int',
            var=self._print(var),
            start=self._print(start),
            end=self._print(end),
            expr=self._print(expr.function),
            increment=str(1),
            condition=self._print(var) + ' <= ' + self._print(end)  # if start < end else '>='
        )
        return code
431
432
433
    _print_Max = C89CodePrinter._print_Max
    _print_Min = C89CodePrinter._print_Min

434

Martin Bauer's avatar
Martin Bauer committed
435
# noinspection PyPep8Naming
436
437
438
class VectorizedCustomSympyPrinter(CustomSympyPrinter):
    SummandInfo = namedtuple("SummandInfo", ['sign', 'term'])

439
440
    def __init__(self, instruction_set):
        super(VectorizedCustomSympyPrinter, self).__init__()
Martin Bauer's avatar
Martin Bauer committed
441
        self.instruction_set = instruction_set
442

Martin Bauer's avatar
Martin Bauer committed
443
444
445
446
    def _scalarFallback(self, func_name, expr, *args, **kwargs):
        expr_type = get_type_of_expression(expr)
        if type(expr_type) is not VectorType:
            return getattr(super(VectorizedCustomSympyPrinter, self), func_name)(expr, *args, **kwargs)
447
        else:
Martin Bauer's avatar
Martin Bauer committed
448
            assert self.instruction_set['width'] == expr_type.width
449
450
            return None

451
    def _print_Function(self, expr):
452
        if isinstance(expr, vector_memory_access):
Martin Bauer's avatar
Martin Bauer committed
453
454
455
            arg, data_type, aligned, _ = expr.args
            instruction = self.instruction_set['loadA'] if aligned else self.instruction_set['loadU']
            return instruction.format("& " + self._print(arg))
456
        elif isinstance(expr, cast_func):
Martin Bauer's avatar
Martin Bauer committed
457
458
            arg, data_type = expr.args
            if type(data_type) is VectorType:
Martin Bauer's avatar
Martin Bauer committed
459
                return self.instruction_set['makeVec'].format(self._print(arg))
460
        elif expr.func == fast_division:
461
462
            result = self._scalarFallback('_print_Function', expr)
            if not result:
463
464
                result = self.instruction_set['/'].format(self._print(expr.args[0]), self._print(expr.args[1]))
            return result
465
466
467
        elif expr.func == fast_sqrt:
            return "({})".format(self._print(sp.sqrt(expr.args[0])))
        elif expr.func == fast_inv_sqrt:
468
469
470
471
472
473
            result = self._scalarFallback('_print_Function', expr)
            if not result:
                if self.instruction_set['rsqrt']:
                    return self.instruction_set['rsqrt'].format(self._print(expr.args[0]))
                else:
                    return "({})".format(self._print(1 / sp.sqrt(expr.args[0])))
474
475
476
477
478
479
480
481
482
483
484
485
486
        elif isinstance(expr, vec_any):
            expr_type = get_type_of_expression(expr.args[0])
            if type(expr_type) is not VectorType:
                return self._print(expr.args[0])
            else:
                return self.instruction_set['any'].format(self._print(expr.args[0]))
        elif isinstance(expr, vec_all):
            expr_type = get_type_of_expression(expr.args[0])
            if type(expr_type) is not VectorType:
                return self._print(expr.args[0])
            else:
                return self.instruction_set['all'].format(self._print(expr.args[0]))

487
488
        return super(VectorizedCustomSympyPrinter, self)._print_Function(expr)

489
490
491
492
493
    def _print_And(self, expr):
        result = self._scalarFallback('_print_And', expr)
        if result:
            return result

Martin Bauer's avatar
Martin Bauer committed
494
495
496
497
        arg_strings = [self._print(a) for a in expr.args]
        assert len(arg_strings) > 0
        result = arg_strings[0]
        for item in arg_strings[1:]:
Martin Bauer's avatar
Martin Bauer committed
498
            result = self.instruction_set['&'].format(result, item)
499
500
501
502
503
504
505
        return result

    def _print_Or(self, expr):
        result = self._scalarFallback('_print_Or', expr)
        if result:
            return result

Martin Bauer's avatar
Martin Bauer committed
506
507
508
509
        arg_strings = [self._print(a) for a in expr.args]
        assert len(arg_strings) > 0
        result = arg_strings[0]
        for item in arg_strings[1:]:
Martin Bauer's avatar
Martin Bauer committed
510
            result = self.instruction_set['|'].format(result, item)
511
512
        return result

513
    def _print_Add(self, expr, order=None):
514
515
516
        result = self._scalarFallback('_print_Add', expr)
        if result:
            return result
517
518
519
520

        summands = []
        for term in expr.args:
            if term.func == sp.Mul:
Martin Bauer's avatar
Martin Bauer committed
521
                sign, t = self._print_Mul(term, inside_add=True)
522
523
524
525
526
527
528
529
530
531
532
533
534
            else:
                t = self._print(term)
                sign = 1
            summands.append(self.SummandInfo(sign, t))
        # Use positive terms first
        summands.sort(key=lambda e: e.sign, reverse=True)
        # if no positive term exists, prepend a zero
        if summands[0].sign == -1:
            summands.insert(0, self.SummandInfo(1, "0"))

        assert len(summands) >= 2
        processed = summands[0].term
        for summand in summands[1:]:
Martin Bauer's avatar
Martin Bauer committed
535
            func = self.instruction_set['-'] if summand.sign == -1 else self.instruction_set['+']
536
537
538
            processed = func.format(processed, summand.term)
        return processed

539
    def _print_Pow(self, expr):
540
541
542
        result = self._scalarFallback('_print_Pow', expr)
        if result:
            return result
543

544
545
        one = self.instruction_set['makeVec'].format(1.0)

546
547
        if expr.exp.is_integer and expr.exp.is_number and 0 < expr.exp < 8:
            return "(" + self._print(sp.Mul(*[expr.base] * expr.exp, evaluate=False)) + ")"
548
549
550
551
552
        elif expr.exp == -1:
            one = self.instruction_set['makeVec'].format(1.0)
            return self.instruction_set['/'].format(one, self._print(expr.base))
        elif expr.exp == 0.5:
            return self.instruction_set['sqrt'].format(self._print(expr.base))
553
554
555
        elif expr.exp == -0.5:
            root = self.instruction_set['sqrt'].format(self._print(expr.base))
            return self.instruction_set['/'].format(one, root)
556
557
558
        elif expr.exp.is_integer and expr.exp.is_number and - 8 < expr.exp < 0:
            return self.instruction_set['/'].format(one,
                                                    self._print(sp.Mul(*[expr.base] * (-expr.exp), evaluate=False)))
559
        else:
560
            raise ValueError("Generic exponential not supported: " + str(expr))
561

Martin Bauer's avatar
Martin Bauer committed
562
563
564
565
    def _print_Mul(self, expr, inside_add=False):
        # noinspection PyProtectedMember
        from sympy.core.mul import _keep_coeff

566
567
568
        result = self._scalarFallback('_print_Mul', expr)
        if result:
            return result
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596

        c, e = expr.as_coeff_Mul()
        if c < 0:
            expr = _keep_coeff(-c, e)
            sign = -1
        else:
            sign = 1

        a = []  # items in the numerator
        b = []  # items that are in the denominator (if any)

        # Gather args for numerator/denominator
        for item in expr.as_ordered_factors():
            if item.is_commutative and item.is_Pow and item.exp.is_Rational and item.exp.is_negative:
                if item.exp != -1:
                    b.append(sp.Pow(item.base, -item.exp, evaluate=False))
                else:
                    b.append(sp.Pow(item.base, -item.exp))
            else:
                a.append(item)

        a = a or [S.One]

        a_str = [self._print(x) for x in a]
        b_str = [self._print(x) for x in b]

        result = a_str[0]
        for item in a_str[1:]:
Martin Bauer's avatar
Martin Bauer committed
597
            result = self.instruction_set['*'].format(result, item)
598
599
600
601

        if len(b) > 0:
            denominator_str = b_str[0]
            for item in b_str[1:]:
Martin Bauer's avatar
Martin Bauer committed
602
603
                denominator_str = self.instruction_set['*'].format(denominator_str, item)
            result = self.instruction_set['/'].format(result, denominator_str)
604

Martin Bauer's avatar
Martin Bauer committed
605
        if inside_add:
606
607
608
            return sign, result
        else:
            if sign < 0:
Martin Bauer's avatar
Martin Bauer committed
609
                return self.instruction_set['*'].format(self._print(S.NegativeOne), result)
610
611
612
            else:
                return result

613
    def _print_Relational(self, expr):
614
615
616
        result = self._scalarFallback('_print_Relational', expr)
        if result:
            return result
Martin Bauer's avatar
Martin Bauer committed
617
        return self.instruction_set[expr.rel_op].format(self._print(expr.lhs), self._print(expr.rhs))
618
619

    def _print_Equality(self, expr):
620
621
622
        result = self._scalarFallback('_print_Equality', expr)
        if result:
            return result
Martin Bauer's avatar
Martin Bauer committed
623
        return self.instruction_set['=='].format(self._print(expr.lhs), self._print(expr.rhs))
624
625

    def _print_Piecewise(self, expr):
626
627
628
        result = self._scalarFallback('_print_Piecewise', expr)
        if result:
            return result
629

Martin Bauer's avatar
Martin Bauer committed
630
        if expr.args[-1].cond.args[0] is not sp.sympify(True):
631
632
633
634
635
636
637
638
639
            # We need the last conditional to be a True, otherwise the resulting
            # function may not return a result.
            raise ValueError("All Piecewise expressions must contain an "
                             "(expr, True) statement to be used as a default "
                             "condition. Without one, the generated "
                             "expression may not evaluate to anything under "
                             "some condition.")

        result = self._print(expr.args[-1][0])
Martin Bauer's avatar
Martin Bauer committed
640
        for true_expr, condition in reversed(expr.args[:-1]):
641
            if isinstance(condition, cast_func) and get_type_of_expression(condition.args[0]) == create_type("bool"):
642
643
644
645
646
                if not KERNCRAFT_NO_TERNARY_MODE:
                    result = "(({}) ? ({}) : ({}))".format(self._print(condition.args[0]), self._print(true_expr),
                                                           result)
                else:
                    print("Warning - skipping ternary op")
647
648
649
            else:
                # noinspection SpellCheckingInspection
                result = self.instruction_set['blendv'].format(result, self._print(true_expr), self._print(condition))
650
        return result