ffc.uflacs.language package¶

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

statements¶

class ffc.uflacs.language.cnodes.Sub(lhs, rhs)[source]¶

Bases: ffc.uflacs.language.cnodes.BinOp

op = '-'¶

precedence = 5¶

class ffc.uflacs.language.cnodes.Sum(args)[source]¶

Bases: ffc.uflacs.language.cnodes.NaryOp

Sum of any number of operands.

op = '+'¶

precedence = 5¶

class ffc.uflacs.language.cnodes.Switch(arg, cases, default=None, autobreak=True, autoscope=True)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

arg¶

autobreak¶

autoscope¶

cases¶

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

default¶

is_scoped = True¶

class ffc.uflacs.language.cnodes.Symbol(name)[source]¶

Bases: ffc.uflacs.language.cnodes.CExprTerminal

A named symbol.

ce_format(precision=None)[source]¶

name¶

precedence = 0¶

class ffc.uflacs.language.cnodes.Throw(exception, message)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

exception¶

is_scoped = True¶

message¶

class ffc.uflacs.language.cnodes.UnaryOp(arg)[source]¶

Bases: ffc.uflacs.language.cnodes.CExprOperator

Base class for unary operators.

arg¶

class ffc.uflacs.language.cnodes.Using(name)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

is_scoped = True¶

name¶

class ffc.uflacs.language.cnodes.VariableDecl(typename, symbol, value=None)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

Declare a variable, optionally define initial value.

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

is_scoped = False¶

symbol¶

typename¶

value¶

class ffc.uflacs.language.cnodes.VerbatimExpr(codestring)[source]¶

Bases: ffc.uflacs.language.cnodes.CExprTerminal

A verbatim copy of an expression source string.

Handled as having the lowest precedence which will introduce parentheses around it most of the time.

ce_format(precision=None)[source]¶

codestring¶

precedence = 15¶

class ffc.uflacs.language.cnodes.VerbatimStatement(codestring)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

Wraps a source code string to be pasted verbatim into the source code.

codestring¶

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

is_scoped = False¶

class ffc.uflacs.language.cnodes.While(condition, body)[source]¶

Bases: ffc.uflacs.language.cnodes.CStatement

body¶

condition¶

cs_format(precision=None)[source]¶: Return S: string | list(S) | Indented(S).

is_scoped = True¶

ffc.uflacs.language.cnodes.accumulate_loop(dst, src, ranges)[source]¶

Generate a nested loop over a list of ranges, adding src to dst in the innermost loop.

Ranges is a list on the format [(index, begin, end),…].

ffc.uflacs.language.cnodes.as_cexpr(node)[source]¶

Typechecks and wraps an object as a valid CExpr.

Accepts CExpr nodes, treats int and float as literals, and treats a string as a symbol.

ffc.uflacs.language.cnodes.as_cexpr_or_literal(node)[source]¶

ffc.uflacs.language.cnodes.as_cexpr_or_string_symbol(node)[source]¶

ffc.uflacs.language.cnodes.as_cexpr_or_verbatim(node)[source]¶

ffc.uflacs.language.cnodes.as_cstatement(node)[source]¶: Perform type checking on node and wrap in a suitable statement type if necessary.

ffc.uflacs.language.cnodes.as_pragma(pragma)[source]¶

ffc.uflacs.language.cnodes.as_symbol(symbol)[source]¶

ffc.uflacs.language.cnodes.assign_loop(dst, src, ranges)[source]¶

Generate a nested loop over a list of ranges, assigning src to dst in the innermost loop.

Ranges is a list on the format [(index, begin, end),…].

ffc.uflacs.language.cnodes.build_1d_initializer_list(values, formatter, padlen=0, precision=None)[source]¶: Return a list containing a single line formatted like “{ 0.0, 1.0, 2.0 }”

ffc.uflacs.language.cnodes.build_initializer_lists(values, sizes, level, formatter, padlen=0, precision=None)[source]¶

Return a list of lines with initializer lists for a multidimensional array.

Example output:

{ { 0.0, 0.1 },
  { 1.0, 1.1 } }

ffc.uflacs.language.cnodes.commented_code_list(code, comments)[source]¶: Convenience wrapper for adding comment to code list if the list is not empty.

ffc.uflacs.language.cnodes.flattened_indices(indices, shape)[source]¶

Given a tuple of indices and a shape tuple, return CNode expression for flattened indexing into multidimensional array.

Indices and shape entries can be int values, str symbol names, or CNode expressions.

ffc.uflacs.language.cnodes.float_product(factors)[source]¶: Build product of float factors, simplifying ones and zeros and returning 1.0 if empty sequence.

ffc.uflacs.language.cnodes.is_negative_one_cexpr(cexpr)[source]¶

ffc.uflacs.language.cnodes.is_one_cexpr(cexpr)[source]¶

ffc.uflacs.language.cnodes.is_simple_inner_loop(code)[source]¶

ffc.uflacs.language.cnodes.is_zero_cexpr(cexpr)[source]¶

ffc.uflacs.language.cnodes.leftover(size, padlen)[source]¶: Return minimum integer to add to size to make it divisible by padlen.

ffc.uflacs.language.cnodes.pad_dim(dim, padlen)[source]¶: Make dim divisible by padlen.

ffc.uflacs.language.cnodes.pad_innermost_dim(shape, padlen)[source]¶: Make the last dimension in shape divisible by padlen.

ffc.uflacs.language.cnodes.scale_loop(dst, factor, ranges)[source]¶

Generate a nested loop over a list of ranges, multiplying dst with factor in the innermost loop.

Ranges is a list on the format [(index, begin, end),…].

ffc.uflacs.language.format_lines module¶

Tools for indentation-aware code string stitching.

When formatting an AST into a string, it’s better to collect lists of snippets and then join them than adding the pieces continually, which gives O(n^2) behaviour w.r.t. AST size n.

class ffc.uflacs.language.format_lines.Indented(body)[source]¶

Bases: object

Class to mark a collection of snippets for indentation.

This way nested indentations can be handled by adding the prefix spaces only once to each line instead of splitting and indenting substrings repeatedly.

body¶

ffc.uflacs.language.format_lines.format_indented_lines(snippets, level=0)[source]¶: Format recursive sequences of indented lines as one string.

ffc.uflacs.language.format_lines.iter_indented_lines(snippets, level=0)[source]¶

Iterate over indented string lines from a snippets data structure.

The snippets object can be built recursively using the following types:

str: Split and yield as one line at a time indented to the appropriate level.
Indented: Yield the lines within this object indented by one level.
tuple,list: Yield lines from recursive application of this function to list items.

ffc.uflacs.language.format_value module¶

ffc.uflacs.language.format_value.format_float(x, precision=None)[source]¶: Format a float value according to given precision.

ffc.uflacs.language.format_value.format_int(x, precision=None)[source]¶

ffc.uflacs.language.format_value.format_value(value, precision=None)[source]¶

Format a literal value as s tring.

float: Formatted according to current precision configuration.
int: Formatted as regular base 10 int literal.
str: Wrapped in “quotes”.

ffc.uflacs.language.precedence module¶

class ffc.uflacs.language.precedence.PRECEDENCE[source]¶

Bases: object

An enum-like class for C operator precedence levels.

ADD = 5¶

ADDRESSOF = 3¶

AND = 11¶

ASSIGN = 13¶

BIT_AND = 8¶

BIT_NOT = 3¶

BIT_OR = 10¶

BIT_XOR = 9¶

CALL = 2¶

CONDITIONAL = 13¶

DEREFERENCE = 3¶

DIV = 4¶

EQ = 7¶

GE = 6¶

GT = 6¶

HIGHEST = 0¶

LE = 6¶

LITERAL = 0¶

LOWEST = 15¶

LT = 6¶

MOD = 4¶

MUL = 4¶

NE = 7¶

NEG = 3¶

NOT = 3¶

OR = 12¶

POS = 3¶

POST_DEC = 2¶

POST_INC = 2¶

PRE_DEC = 3¶

PRE_INC = 3¶

SIZEOF = 3¶

SUB = 5¶

SUBSCRIPT = 2¶

SYMBOL = 0¶

ffc.uflacs.language.ufl_to_cnodes module¶

Tools for C/C++ expression formatting.

class ffc.uflacs.language.ufl_to_cnodes.RulesForC[source]¶

Bases: object

abs(o, op)[source]¶

max_value(o, a, b)[source]¶

min_value(o, a, b)[source]¶

power(o, a, b)[source]¶

class ffc.uflacs.language.ufl_to_cnodes.RulesForCpp[source]¶

Bases: object

abs(o, op)[source]¶

bessel_i(o, n, v)[source]¶

bessel_j(o, n, v)[source]¶

bessel_k(o, n, v)[source]¶

bessel_y(o, n, v)[source]¶

max_value(o, a, b)[source]¶

min_value(o, a, b)[source]¶

power(o, a, b)[source]¶

class ffc.uflacs.language.ufl_to_cnodes.UFL2CNodesMixin(language)[source]¶

Bases: object

Rules collection mixin for a UFL to CNodes translator class.

acos(o, op)[source]¶

and_condition(o, a, b)[source]¶

asin(o, op)[source]¶

atan(o, op)[source]¶

atan_2(o, y, x)[source]¶

conditional(o, c, t, f)[source]¶

cos(o, op)[source]¶

cosh(o, op)[source]¶

division(o, a, b)[source]¶

eq(o, a, b)[source]¶

erf(o, op)[source]¶

exp(o, op)[source]¶

expr(o)[source]¶: Generic fallback with error message for missing rules.

float_value(o)[source]¶

ge(o, a, b)[source]¶

gt(o, a, b)[source]¶

int_value(o)[source]¶

le(o, a, b)[source]¶

ln(o, op)[source]¶

lt(o, a, b)[source]¶

math_function(o, op)[source]¶

ne(o, a, b)[source]¶

not_condition(o, a)[source]¶

or_condition(o, a, b)[source]¶

product(o, a, b)[source]¶

sin(o, op)[source]¶

sinh(o, op)[source]¶

sqrt(o, op)[source]¶

sum(o, a, b)[source]¶

tan(o, op)[source]¶

tanh(o, op)[source]¶

zero(o)[source]¶

class ffc.uflacs.language.ufl_to_cnodes.UFL2CNodesTranslatorC(language)[source]¶

Bases: ufl.corealg.multifunction.MultiFunction, ffc.uflacs.language.ufl_to_cnodes.UFL2CNodesMixin, ffc.uflacs.language.ufl_to_cnodes.RulesForC

UFL to CNodes translator class.

class ffc.uflacs.language.ufl_to_cnodes.UFL2CNodesTranslatorCpp(language)[source]¶

Bases: ufl.corealg.multifunction.MultiFunction, ffc.uflacs.language.ufl_to_cnodes.UFL2CNodesMixin, ffc.uflacs.language.ufl_to_cnodes.RulesForCpp

UFL to CNodes translator class.

ffc.uflacs.language package¶

Submodules¶

ffc.uflacs.language.cnodes module¶

ffc.uflacs.language.format_lines module¶

ffc.uflacs.language.format_value module¶

ffc.uflacs.language.precedence module¶

ffc.uflacs.language.ufl_to_cnodes module¶

Module contents¶