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`
`Set`	`UnionSet`
`BasicMap`	`Map`
`Map`	`UnionMap`
`Aff`	`PwAff`
`PwAff`	`UnionPwAff`
`MultiAff`	`PwMultiAff`
`PwMultiAff`	`UnionPwMultiAff`
`Space`	`LocalSpace`

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

Version Info#

islpy.version#

islpy.isl_version()#

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 instantiated within this Context.

New in version 2015.2.

Symbolic Constants#

class islpy.error#

abort = islpy._isl.error.abort#

alloc = islpy._isl.error.alloc#

internal = islpy._isl.error.internal#

invalid = islpy._isl.error.invalid#

none = islpy._isl.error.none#

quota = islpy._isl.error.quota#

unknown = islpy._isl.error.unknown#

unsupported = islpy._isl.error.unsupported#

class islpy.dim_type#

all = islpy._isl.dim_type.all#

cst = islpy._isl.dim_type.cst#

div = islpy._isl.dim_type.div#

in_ = islpy._isl.dim_type.in_#

out = islpy._isl.dim_type.set#

param = islpy._isl.dim_type.param#

set = islpy._isl.dim_type.set#

class islpy.fold#

list = islpy._isl.fold.list#

max = islpy._isl.fold.max#

min = islpy._isl.fold.min#

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#

print_pw_qpolynomial_fold()
print_pw_qpolynomial_fold_list()
print_pw_qpolynomial_list()
print_qpolynomial()
print_qpolynomial_fold()
print_qpolynomial_list()
print_schedule()
print_schedule_constraints()
print_schedule_node()
print_set()
print_set_list()
print_space()
print_str()
print_union_access_info()
print_union_flow()
print_union_map()
print_union_map_list()
print_union_pw_aff()
print_union_pw_aff_list()
print_union_pw_multi_aff()
print_union_pw_multi_aff_list()
print_union_pw_qpolynomial()
print_union_pw_qpolynomial_fold()
print_union_set()
print_union_set_list()
print_val()
print_val_list()
print_vec()
set_indent()
set_indent_prefix()
set_isl_int_width()
set_note()
set_output_format()
set_prefix()
set_suffix()
set_yaml_style()
start_line()
yaml_end_mapping()
yaml_end_sequence()
yaml_next()
yaml_start_mapping()
yaml_start_sequence()

__eq__(value, /)#: Return self==value.

__hash__()#: Return hash(self).

__ne__(value, /)#: Return self!=value.

ast_op_type_set_print_name(self, type, name)#

Parameters:

self – Printer (mutated in-place) (mutated in-place)
type – ast_expr_op_type
name – string

Returns:

Reference guide: Overview#

General Remarks#

Creation via Static Methods#

Documented vs. Non-documented Functionality#

Invalidation of Arguments#

Integers#

Automatic Casts#

Version Info#

Error Reporting#

Convenience#

Lifetime Helpers#

Global Data#

Symbolic Constants#

Output#

Helper functions#

Canonical Names for Internal Module#