cbackend.py 25.5 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

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

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

26
27
KERNCRAFT_NO_TERNARY_MODE = False

Martin Bauer's avatar
Fixes    
Martin Bauer committed
28

29
def generate_c(ast_node: Node, signature_only: bool = False, dialect='c', custom_backend=None) -> str:
Martin Bauer's avatar
Martin Bauer committed
30
31
32
33
34
35
36
37
38
    """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:
39
        dialect: 'c' or 'cuda'
Martin Bauer's avatar
Martin Bauer committed
40
41
    Returns:
        C-like code for the ast node and its descendants
Martin Bauer's avatar
Martin Bauer committed
42
    """
43
44
45
46
47
48
    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
49
50
51
    if custom_backend:
        printer = custom_backend
    elif dialect == 'c':
52
53
54
55
        try:
            instruction_set = ast_node.instruction_set
        except Exception:
            instruction_set = None
56
        printer = CBackend(signature_only=signature_only,
57
                           vector_instruction_set=instruction_set)
58
59
60
    elif dialect == 'cuda':
        from pystencils.backends.cuda_backend import CudaBackend
        printer = CudaBackend(signature_only=signature_only)
Stephan Seitz's avatar
Stephan Seitz committed
61
    elif dialect == 'opencl':
62
63
        from pystencils.backends.opencl_backend import OpenClBackend
        printer = OpenClBackend(signature_only=signature_only)
64
    else:
Martin Bauer's avatar
Martin Bauer committed
65
        raise ValueError("Unknown dialect: " + str(dialect))
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
    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)

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


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

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

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

105
106
107
108
    for g in get_global_declarations(ast_node):
        if isinstance(g, Node):
            headers.update(get_headers(g))

109
    return sorted(headers)
110
111


112
113
114
# --------------------------------------- Backend Specific Nodes -------------------------------------------------------


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

123
    def get_code(self, dialect, vector_instruction_set):
124
125
126
127
128
129
130
        return self._code

    @property
    def args(self):
        return []

    @property
Martin Bauer's avatar
Martin Bauer committed
131
    def symbols_defined(self):
132
        return self._symbols_defined
133
134

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

138
139
140
141
142
143
    def __eq___(self, other):
        return self._code == other._code

    def __hash__(self):
        return hash(self._code)

144

145
class PrintNode(CustomCodeNode):
Martin Bauer's avatar
Martin Bauer committed
146
147
148
149
    # 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())
150
        self.headers.append("<iostream>")
151
152
153
154


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

155

Martin Bauer's avatar
Martin Bauer committed
156
157
# noinspection PyPep8Naming
class CBackend:
158

Martin Bauer's avatar
Martin Bauer committed
159
    def __init__(self, sympy_printer=None, signature_only=False, vector_instruction_set=None, dialect='c'):
Martin Bauer's avatar
Martin Bauer committed
160
161
        if sympy_printer is None:
            if vector_instruction_set is not None:
162
                self.sympy_printer = VectorizedCustomSympyPrinter(vector_instruction_set)
163
            else:
164
                self.sympy_printer = CustomSympyPrinter()
165
        else:
Martin Bauer's avatar
Martin Bauer committed
166
            self.sympy_printer = sympy_printer
167

168
        self._vector_instruction_set = vector_instruction_set
169
        self._indent = "   "
170
        self._dialect = dialect
Martin Bauer's avatar
Martin Bauer committed
171
        self._signatureOnly = signature_only
172
173

    def __call__(self, node):
Martin Bauer's avatar
Martin Bauer committed
174
        prev_is = VectorType.instruction_set
175
        VectorType.instruction_set = self._vector_instruction_set
176
        result = str(self._print(node))
Martin Bauer's avatar
Martin Bauer committed
177
        VectorType.instruction_set = prev_is
178
        return result
179
180

    def _print(self, node):
Stephan Seitz's avatar
Stephan Seitz committed
181
182
        if isinstance(node, str):
            return node
183
        for cls in type(node).__mro__:
Martin Bauer's avatar
Martin Bauer committed
184
185
186
            method_name = "_print_" + cls.__name__
            if hasattr(self, method_name):
                return getattr(self, method_name)(node)
187
        raise NotImplementedError(self.__class__.__name__ + " does not support node of type " + node.__class__.__name__)
188

189
190
191
    def _print_Type(self, node):
        return str(node)

192
    def _print_KernelFunction(self, node):
193
        function_arguments = ["%s %s" % (self._print(s.symbol.dtype), s.symbol.name) for s in node.get_parameters()]
194
        launch_bounds = ""
195
        if self._dialect == 'cuda':
196
197
198
199
200
            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))
201
        if self._signatureOnly:
Martin Bauer's avatar
Martin Bauer committed
202
            return func_declaration
203

204
        body = self._print(node.body)
Martin Bauer's avatar
Martin Bauer committed
205
        return func_declaration + "\n" + body
206
207

    def _print_Block(self, node):
Martin Bauer's avatar
Martin Bauer committed
208
209
        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)))
210
211

    def _print_PragmaBlock(self, node):
Martin Bauer's avatar
Martin Bauer committed
212
        return "%s\n%s" % (node.pragma_line, self._print_Block(node))
213
214

    def _print_LoopOverCoordinate(self, node):
Martin Bauer's avatar
Martin Bauer committed
215
        counter_symbol = node.loop_counter_name
Martin Bauer's avatar
Martin Bauer committed
216
217
218
219
        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)
220

Martin Bauer's avatar
Martin Bauer committed
221
        prefix = "\n".join(node.prefix_lines)
222
223
        if prefix:
            prefix += "\n"
Martin Bauer's avatar
Martin Bauer committed
224
        return "%s%s\n%s" % (prefix, loop_str, self._print(node.body))
225
226

    def _print_SympyAssignment(self, node):
Martin Bauer's avatar
Martin Bauer committed
227
        if node.is_declaration:
Stephan Seitz's avatar
Lint    
Stephan Seitz committed
228
229
230
231
            if node.is_const:
                prefix = 'const '
            else:
                prefix = ''
232
            data_type = prefix + self._print(node.lhs.dtype).replace(' const', '') + " "
233
234
            return "%s%s = %s;" % (data_type, self.sympy_printer.doprint(node.lhs),
                                   self.sympy_printer.doprint(node.rhs))
235
        else:
Martin Bauer's avatar
Martin Bauer committed
236
            lhs_type = get_type_of_expression(node.lhs)
Martin Bauer's avatar
Martin Bauer committed
237
238
239
240
241
242
            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'

243
244
245
246
247
248
                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

249
250
                return self._vector_instruction_set[instr].format("&" + self.sympy_printer.doprint(node.lhs.args[0]),
                                                                  self.sympy_printer.doprint(rhs)) + ';'
251
            else:
Martin Bauer's avatar
Martin Bauer committed
252
                return "%s = %s;" % (self.sympy_printer.doprint(node.lhs), self.sympy_printer.doprint(node.rhs))
253
254

    def _print_TemporaryMemoryAllocation(self, node):
255
        align = 64
Martin Bauer's avatar
Martin Bauer committed
256
257
258
259
260
261
        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),
262
                           size=self.sympy_printer.doprint(size),
Martin Bauer's avatar
Martin Bauer committed
263
264
                           offset=int(node.offset(align)),
                           align=align)
265
266

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

Martin Bauer's avatar
Martin Bauer committed
270
    def _print_SkipIteration(self, _):
271
        return "continue;"
Martin Bauer's avatar
Martin Bauer committed
272

273
274
    def _print_CustomCodeNode(self, node):
        return node.get_code(self._dialect, self._vector_instruction_set)
275

276
277
278
279
280
281
    def _print_SourceCodeComment(self, node):
        return "/* " + node.text + " */"

    def _print_EmptyLine(self, node):
        return ""

282
    def _print_Conditional(self, node):
283
284
285
        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
286
287
        condition_expr = self.sympy_printer.doprint(node.condition_expr)
        true_block = self._print_Block(node.true_block)
Martin Bauer's avatar
Martin Bauer committed
288
        result = "if (%s)\n%s " % (condition_expr, true_block)
Martin Bauer's avatar
Martin Bauer committed
289
290
        if node.false_block:
            false_block = self._print_Block(node.false_block)
Martin Bauer's avatar
Martin Bauer committed
291
            result += "else " + false_block
292
293
        return result

294
295
296
297

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


Martin Bauer's avatar
Martin Bauer committed
298
# noinspection PyPep8Naming
299
class CustomSympyPrinter(CCodePrinter):
Martin Bauer's avatar
Martin Bauer committed
300

301
    def __init__(self):
Martin Bauer's avatar
Martin Bauer committed
302
        super(CustomSympyPrinter, self).__init__()
303
        self._float_type = create_type("float32")
304
305
306
307
        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
308

309
310
    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
311
312
313
        if not expr.free_symbols:
            return self._typed_number(expr.evalf(), get_type_of_expression(expr))

314
        if expr.exp.is_integer and expr.exp.is_number and 0 < expr.exp < 8:
315
            return "(" + self._print(sp.Mul(*[expr.base] * expr.exp, evaluate=False)) + ")"
316
317
        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)))
318
319
320
321
322
        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
323
324
        res = str(expr.evalf().num)
        return res
325
326
327
328
329
330
331
332

    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
333
334
        return result.replace("\n", "")

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

374
375
    def _typed_number(self, number, dtype):
        res = self._print(number)
376
377
378
379
        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
380
381
        else:
            return res
382

Stephan Seitz's avatar
Stephan Seitz committed
383
384
385
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
    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
428

429
430
431
    _print_Max = C89CodePrinter._print_Max
    _print_Min = C89CodePrinter._print_Min

432

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

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

Martin Bauer's avatar
Martin Bauer committed
441
442
443
444
    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)
445
        else:
Martin Bauer's avatar
Martin Bauer committed
446
            assert self.instruction_set['width'] == expr_type.width
447
448
            return None

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

485
486
        return super(VectorizedCustomSympyPrinter, self)._print_Function(expr)

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

Martin Bauer's avatar
Martin Bauer committed
492
493
494
495
        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
496
            result = self.instruction_set['&'].format(result, item)
497
498
499
500
501
502
503
        return result

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

Martin Bauer's avatar
Martin Bauer committed
504
505
506
507
        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
508
            result = self.instruction_set['|'].format(result, item)
509
510
        return result

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

        summands = []
        for term in expr.args:
            if term.func == sp.Mul:
Martin Bauer's avatar
Martin Bauer committed
519
                sign, t = self._print_Mul(term, inside_add=True)
520
521
522
523
524
525
526
527
528
529
530
531
532
            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
533
            func = self.instruction_set['-'] if summand.sign == -1 else self.instruction_set['+']
534
535
536
            processed = func.format(processed, summand.term)
        return processed

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

542
543
        one = self.instruction_set['makeVec'].format(1.0)

544
545
        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)) + ")"
546
547
548
549
550
        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))
551
552
553
        elif expr.exp == -0.5:
            root = self.instruction_set['sqrt'].format(self._print(expr.base))
            return self.instruction_set['/'].format(one, root)
554
555
556
        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)))
557
        else:
558
            raise ValueError("Generic exponential not supported: " + str(expr))
559

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

564
565
566
        result = self._scalarFallback('_print_Mul', expr)
        if result:
            return result
567
568
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

        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
595
            result = self.instruction_set['*'].format(result, item)
596
597
598
599

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

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

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

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

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

Martin Bauer's avatar
Martin Bauer committed
628
        if expr.args[-1].cond.args[0] is not sp.sympify(True):
629
630
631
632
633
634
635
636
637
            # 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
638
        for true_expr, condition in reversed(expr.args[:-1]):
639
            if isinstance(condition, cast_func) and get_type_of_expression(condition.args[0]) == create_type("bool"):
640
641
642
643
644
                if not KERNCRAFT_NO_TERNARY_MODE:
                    result = "(({}) ? ({}) : ({}))".format(self._print(condition.args[0]), self._print(true_expr),
                                                           result)
                else:
                    print("Warning - skipping ternary op")
645
646
647
            else:
                # noinspection SpellCheckingInspection
                result = self.instruction_set['blendv'].format(result, self._print(true_expr), self._print(condition))
648
        return result