Reference guide: Overview¶

General Remarks¶

Creation via Static Methods¶

To map more directly to the isl’s C interface, object creation in islpy is done through static methods instead of through constructors. These are marked ‘(static)’ in each class’s overview section.

Documented vs. Non-documented Functionality¶

Since islpy is automatically generated from the isl C headers, some of the functionality it exposes might be undocumented. Undocumented functionality might change or vanish without notice. ‘Documented’ functionality is defined as whatever is mentioned in the isl manual. islpy will let you call undocumented functions, but you are doing so at your own risk.

Invalidation of Arguments¶

You may notice that a few methods below say ‘(becomes invalid)’. This has to do with an idiosyncrasy in isl’s interface that was retained at the Python level for efficiency. Such arguments will be deleted (by isl) upon entry to the called function. If you would like to retain access to that object, simply append a .copy() to that argument. (Note that you will notice if an object got deleted for you accidentally, as the next operation on it will simply fail with an exception.)

Integers¶

Whenever an integer argument is required, islpy supports regular Python integers and Python long integers. It will return Python long integers.

Automatic Casts¶

islpy will automatically perform the following upward casts in argument lists:

Called with	Argument Type
`BasicSet`	`Set`
`BasicMap`	`Map`
`Set`	`UnionSet`
`Map`	`UnionMap`
`Space`	`LocalSpace`
`Aff`	`PwAff`

as well as casts contained in the transitive closure of this ‘casting graph’.

Error Reporting¶

exception islpy.Error¶

Convenience¶

islpy.make_zero_and_vars(set_vars, params=[], ctx=None)¶

Parameters

set_vars – an iterable of variable names, or a comma-separated string
params – an iterable of variable names, or a comma-separated string

Returns

a dictionary from variable names (in set_vars and params) to PwAff instances that represent each of the variables. They key ‘0’ is also include and represents a PwAff zero constant.

New in version 2016.1.1.

This function is intended to make it relatively easy to construct sets programmatically without resorting to string manipulation.

Usage example:

v = isl.make_zero_and_vars("i,j,k", "n")

myset = (
        v[0].le_set(v["i"] + v["j"])
        &
        (v["i"] + v["j"]).lt_set(v["n"])
        &
        (v[0].le_set(v["i"]))
        &
        (v["i"].le_set(13 + v["n"]))
        )

islpy.affs_from_space(space)¶

Returns: a dictionary from variable names (in set_vars and params) to PwAff instances that represent each of the variables in*space. They key ‘0’ is also include and represents a PwAff zero constant.

New in version 2016.2.

This function is intended to make it relatively easy to construct sets programmatically without resorting to string manipulation.

Usage example:

s = isl.Set("[n] -> {[i,j,k]: 0<=i,j,k<n}")
v = isl.affs_from_space(s.space)

myset = (
        v[0].le_set(v["i"] + v["j"])
        &
        (v["i"] + v["j"]).lt_set(v["n"])
        &
        (v[0].le_set(v["i"]))
        &
        (v["i"].le_set(13 + v["n"]))
        )

Lifetime Helpers¶

class islpy.ffi_callback_handle¶: Some callbacks, notably those in AstBuild, need to outlive the function call to which they’re passed. These callback return a callback handle that must be kept alive until the callback is no longer needed.

Global Data¶

islpy.DEFAULT_CONTEXT¶: ISL objects being unpickled or initialized from strings will be instatiated within this Context.

New in version 2015.2.

Symbolic Constants¶

class islpy.error¶

abort = 1¶

alloc = 2¶

internal = 4¶

invalid = 5¶

none = 0¶

quota = 6¶

unknown = 3¶

unsupported = 7¶

class islpy.dim_type¶

all = 5¶

cst = 0¶

div = 4¶

in_ = 2¶

out = 3¶

param = 1¶

set = 3¶

class islpy.fold¶

list = 2¶

max = 1¶

min = 0¶

class islpy.ast_op_type¶

access = 23¶

add = 7¶

address_of = 25¶

and_ = 0¶

and_then = 1¶

call = 22¶

cond = 15¶

div = 10¶

eq = 17¶

error = -1¶

fdiv_q = 11¶

ge = 20¶

gt = 21¶

le = 18¶

lt = 19¶

max = 4¶

member = 24¶

min = 5¶

minus = 6¶

mul = 9¶

or_ = 2¶

or_else = 3¶

pdiv_q = 12¶

pdiv_r = 13¶

select = 16¶

sub = 8¶

zdiv_r = 14¶

class islpy.ast_expr_type¶

error = -1¶

id = 1¶

int(x, base=10) → integer = 2¶

op = 0¶

class islpy.ast_node_type¶

block = 3¶

error = -1¶

for_ = 1¶

if_ = 2¶

mark = 4¶

user = 5¶

class islpy.format¶

C = 4¶

EXT_POLYLIB = 6¶

ISL = 0¶

LATEX = 5¶

OMEGA = 3¶

POLYLIB = 1¶

POLYLIB_CONSTRAINTS = 2¶

class islpy.yaml_style¶

BLOCK = 0¶

FLOW = 1¶

Output¶

class islpy.Printer(_data)¶

end_line(self)¶

Parameters: self – Printer (becomes invalid)
Returns: Printer (self)

flush(self)¶

Parameters: self – Printer (becomes invalid)
Returns: Printer (self)

get_ctx(self)¶

Parameters: self – Printer
Returns: Context

get_note(self, id)¶

Parameters

self – Printer
id – Id

Returns

Id

get_output_format(self)¶

Parameters: self – Printer
Returns: int

get_str(self)¶

Parameters: self – Printer
Returns: string

get_yaml_style(self)¶

Parameters: self – Printer
Returns: int

has_note(self, id)¶

Parameters

self – Printer
id – Id

Returns

bool

indent(self, indent)¶

Parameters

self – Printer (becomes invalid)
indent – int

Returns

Reference guide: Overview¶

General Remarks¶

Creation via Static Methods¶

Documented vs. Non-documented Functionality¶

Invalidation of Arguments¶

Integers¶

Automatic Casts¶

Error Reporting¶

Convenience¶

Lifetime Helpers¶

Global Data¶

Symbolic Constants¶

Output¶

Helper functions¶