Reference guide

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, Python long integers, and gmpy integers. It will return gmpy 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

Symbolic Constants

class islpy.format
C = 4
EXT_POLYLIB = 6
ISL = 0
LATEX = 5
OMEGA = 3
POLYLIB = 1
POLYLIB_CONSTRAINTS = 2
class islpy.error
abort = islpy._isl.error.abort
internal = islpy._isl.error.internal
invalid = islpy._isl.error.invalid
none = islpy._isl.error.none
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.out
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.constants
BOUND_BERNSTEIN = 0
BOUND_RANGE = 1
ON_ERROR_ABORT = 2
ON_ERROR_CONTINUE = 1
ON_ERROR_WARN = 0
SCHEDULE_ALGORITHM_FEAUTRIER = 1
SCHEDULE_ALGORITHM_ISL = 0

Basic Building Blocks

Context

class islpy.Context

Space

(formerly called Dim. A compatibility alias is in place.)

class islpy.Space
add_dims(self, type, n)
Parameters:
Returns:

Space
align_params(self, dim2)
Parameters:
Returns:

Space
alloc(ctx, nparam, n_in, n_out)
Parameters:
  • ctx – Context
  • nparam – unsigned
  • n_in – unsigned
  • n_out – unsigned
Returns:

Space
can_curry(self)
Parameters:self – Space
Returns:int
can_uncurry(self)
Parameters:self – Space
Returns:int
can_zip(self)
Parameters:self – Space
Returns:int
compatible(self, dim2)
Parameters:
Returns:

int
copy(self)
Parameters:self – Space
Returns:Space
static create_from_names(ctx, set=None, in_=None, out=None, params=[])

Create a Space from lists of variable names.

Parameters:
  • set – names of set-type variables.
  • in – names of in-type variables.
  • out – names of out-type variables.
  • params` – names of parameter-type variables.
curry(self)
Parameters:self – Space
Returns:Space
dim(self, type)
Parameters:
Returns:

unsigned
domain(self)
Parameters:self – Space
Returns:Space
domain_product(self, right)
Parameters:
Returns:

Space
drop_dims(self, type, first, num)
Parameters:
  • self – Space
  • type – dim_type
  • first – unsigned
  • num – unsigned
Returns:

Space
drop_inputs(self, first, n)
Parameters:
  • self – Space
  • first – unsigned
  • n – unsigned
Returns:

Space
drop_outputs(self, first, n)
Parameters:
  • self – Space
  • first – unsigned
  • n – unsigned
Returns:

Space
extend(self, nparam, n_in, n_out)
Parameters:
  • self – Space
  • nparam – unsigned
  • n_in – unsigned
  • n_out – unsigned
Returns:

Space
find_dim_by_id(self, type, id)
Parameters:
Returns:

int
find_dim_by_name(self, type, name)
Parameters:
Returns:

int
from_domain(self)
Parameters:self – Space
Returns:Space
from_range(self)
Parameters:self – Space
Returns:Space
get_ctx(self)
Parameters:self – Space
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_div(self, pos)
Parameters:
Returns:

Aff
get_space(self)
Parameters:self – LocalSpace
Returns:Space
get_tuple_id(self, type)
Parameters:
Returns:

Id
get_tuple_name(self, type)
Parameters:
Returns:

string
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(basic_instance, *args, **kwargs)

Return a list of dim names (in order) for dim_type dimtype.

has_dim_id(self, type, pos)
Parameters:
Returns:

bool
has_dim_name(self, type, pos)
Parameters:
Returns:

bool
has_tuple_id(self, type)
Parameters:
Returns:

bool
has_tuple_name(self, type)
Parameters:
Returns:

bool
insert_dims(self, type, pos, n)
Parameters:
  • self – Space
  • type – dim_type
  • pos – unsigned
  • n – unsigned
Returns:

Space
intersect(self, ls2)
Parameters:
Returns:

LocalSpace
is_domain(self, space2)
Parameters:
Returns:

bool
is_equal(self, space2)
Parameters:
Returns:

bool
is_map(self)
Parameters:self – Space
Returns:bool
is_params(self)
Parameters:self – Space
Returns:bool
is_range(self, space2)
Parameters:
Returns:

bool
is_set(self)
Parameters:self – Space
Returns:bool
is_valid()

Return whether current object is still valid.

is_wrapping(self)
Parameters:self – Space
Returns:bool
join(self, right)
Parameters:
Returns:

Space
lifting(self)
Parameters:self – LocalSpace
Returns:BasicMap
map_from_domain_and_range(self, range)
Parameters:
Returns:

Space
map_from_set(self)
Parameters:self – Space
Returns:Space
match(self, dim1_type, dim2, dim2_type)
Parameters:
Returns:

int
move_dims(self, dst_type, dst_pos, src_type, src_pos, n)
Parameters:
  • self – Space
  • dst_type – dim_type
  • dst_pos – unsigned
  • src_type – dim_type
  • src_pos – unsigned
  • n – unsigned
Returns:

Space
params(self)
Parameters:self – Space
Returns:Space
params_alloc(ctx, nparam)
Parameters:
  • ctx – Context
  • nparam – unsigned
Returns:

Space
product(self, right)
Parameters:
Returns:

Space
range(self)
Parameters:self – Space
Returns:Space
range_product(self, right)
Parameters:
Returns:

Space
reset_tuple_id(self, type)
Parameters:
Returns:

Space
reverse(self)
Parameters:self – Space
Returns:Space
set_alloc(ctx, nparam, dim)
Parameters:
  • ctx – Context
  • nparam – unsigned
  • dim – unsigned
Returns:

Space
set_dim_id(self, type, pos, id)
Parameters:
Returns:

Space
set_dim_name(self, type, pos, name)
Parameters:
  • self – Space
  • type – dim_type
  • pos – unsigned
  • name – string
Returns:

Space
set_from_params(self)
Parameters:self – Space
Returns:Space
set_tuple_id(self, type, id)
Parameters:
Returns:

Space
set_tuple_name(self, type, s)
Parameters:
Returns:

Space
tuple_match(self, dim1_type, dim2, dim2_type)
Parameters:
Returns:

int
uncurry(self)
Parameters:self – Space
Returns:Space
unwrap(self)
Parameters:self – Space
Returns:Space
wrap(self)
Parameters:self – Space
Returns:Space
zip(self)
Parameters:self – Space
Returns:Space

Local Space

class islpy.LocalSpace
add_dims(self, type, n)
Parameters:
Returns:

LocalSpace
copy(self)
Parameters:self – LocalSpace
Returns:LocalSpace
dim(self, type)
Parameters:
Returns:

int
domain(self)
Parameters:self – LocalSpace
Returns:LocalSpace
drop_dims(self, type, first, n)
Parameters:
Returns:

LocalSpace
from_domain(self)
Parameters:self – LocalSpace
Returns:LocalSpace
from_space(dim)
Parameters:dim – Space
Returns:LocalSpace
get_ctx(self)
Parameters:self – LocalSpace
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_div(self, pos)
Parameters:
Returns:

Aff
get_space(self)
Parameters:self – LocalSpace
Returns:Space
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

has_dim_id(self, type, pos)
Parameters:
Returns:

bool
has_dim_name(self, type, pos)
Parameters:
Returns:

bool
insert_dims(self, type, first, n)
Parameters:
Returns:

LocalSpace
intersect(self, ls2)
Parameters:
Returns:

LocalSpace
is_equal(self, ls2)
Parameters:
Returns:

bool
is_set(self)
Parameters:self – LocalSpace
Returns:bool
is_valid()

Return whether current object is still valid.

lifting(self)
Parameters:self – LocalSpace
Returns:BasicMap
range(self)
Parameters:self – LocalSpace
Returns:LocalSpace
set_dim_id(self, type, pos, id)
Parameters:
Returns:

LocalSpace
set_dim_name(self, type, pos, s)
Parameters:
Returns:

LocalSpace
space

get_space(self)

Parameters:self – LocalSpace
Returns:Space

Constraints

class islpy.Constraint
static eq_from_names(space, coefficients={})

Create a constraint const + coeff_1*var_1 +... == 0.

Parameters:
  • space – Space
  • coefficients – a dict or iterable of tuple instances mapping variable names to their coefficients The constant is set to the value of the key ‘1’.

Changed in version 2011.3: Eliminated the separate const parameter.

equality_alloc(ls)
Parameters:ls – LocalSpace
Returns:Constraint
equality_from_aff(aff)
Parameters:aff – Aff
Returns:Constraint
get_aff(self)
Parameters:self – Constraint
Returns:Aff
get_bound(self, type, pos)
Parameters:
Returns:

Aff
get_coefficient(self, type, pos)
Parameters:
Returns:

v (integer)
get_coefficients_by_name(dimtype=None, dim_to_name=None)

Return a dictionary mapping variable names to coefficients.

Parameters:dimtype – None to get all variables, otherwise one of dim_type.

Changed in version 2011.3: New for Aff

get_constant(self)
Parameters:self – Constraint
Returns:v (integer)
get_ctx(self)
Parameters:self – Constraint
Returns:Context
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_div(self, pos)
Parameters:
Returns:

Aff
get_local_space(self)
Parameters:self – Constraint
Returns:LocalSpace
get_space(self)
Parameters:self – Constraint
Returns:Space
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

static ineq_from_names(space, coefficients={})

Create a constraint const + coeff_1*var_1 +... >= 0.

Parameters:
  • space – Space
  • coefficients – a dict or iterable of tuple instances mapping variable names to their coefficients The constant is set to the value of the key ‘1’.

Changed in version 2011.3: Eliminated the separate const parameter.

inequality_alloc(ls)
Parameters:ls – LocalSpace
Returns:Constraint
inequality_from_aff(aff)
Parameters:aff – Aff
Returns:Constraint
involves_dims(self, type, first, n)
Parameters:
Returns:

int
is_div_constraint(self)
Parameters:self – Constraint
Returns:bool
is_equality(self)
Parameters:self – Constraint
Returns:bool
is_lower_bound(self, type, pos)
Parameters:
Returns:

bool
is_upper_bound(self, type, pos)
Parameters:
Returns:

bool
is_valid()

Return whether current object is still valid.

set_coefficient(self, type, pos, v)
Parameters:
Returns:

Constraint
set_coefficients(dim_tp, args)
Parameters:
  • dim_tp – dim_type
  • args – list of coefficients, for indices 0..len(args)-1.

Changed in version 2011.3: New for Aff

set_coefficients_by_name(iterable, name_to_dim=None)

Set the coefficients and the constant.

Parameters:iterable – a dict or iterable of tuple instances mapping variable names to their coefficients. The constant is set to the value of the key ‘1’.

Changed in version 2011.3: New for Aff

set_constant(self, v)
Parameters:
Returns:

Constraint
space

get_space(self)

Parameters:self – Constraint
Returns:Space

Vector

class islpy.Vec
add(self, vec2)
Parameters:
Returns:

Vec
alloc(ctx, size)
Parameters:
  • ctx – Context
  • size – unsigned
Returns:

Vec
clr(self)
Parameters:self – Vec
Returns:Vec
concat(self, vec2)
Parameters:
Returns:

Vec
copy(self)
Parameters:self – Vec
Returns:Vec
drop_els(self, pos, n)
Parameters:
  • self – Vec
  • pos – unsigned
  • n – unsigned
Returns:

Vec
extend(self, size)
Parameters:
  • self – Vec
  • size – unsigned
Returns:

Vec
fdiv_r(self, m)
Parameters:
  • self – Vec
  • m – integer
Returns:

Vec
get_ctx(self)
Parameters:self – Vec
Returns:Context
get_element(self, pos)
Parameters:
  • self – Vec
  • pos – int
Returns:

v (integer)
insert_els(self, pos, n)
Parameters:
  • self – Vec
  • pos – unsigned
  • n – unsigned
Returns:

Vec
insert_zero_els(self, pos, n)
Parameters:
  • self – Vec
  • pos – unsigned
  • n – unsigned
Returns:

Vec
is_equal(self, vec2)
Parameters:
Returns:

bool
is_valid()

Return whether current object is still valid.

neg(self)
Parameters:self – Vec
Returns:Vec
read_from_file(ctx, input)
Parameters:
  • ctx – Context
  • input – file-like
Returns:

Vec
scale(self, m)
Parameters:
  • self – Vec
  • m – integer
Returns:

Vec
set(self, v)
Parameters:
  • self – Vec
  • v – integer
Returns:

Vec
set_element(self, pos, v)
Parameters:
  • self – Vec
  • pos – int
  • v – integer
Returns:

Vec
sort(self)
Parameters:self – Vec
Returns:Vec
zero_extend(self, size)
Parameters:
  • self – Vec
  • size – unsigned
Returns:

Vec

Matrix

class islpy.Mat
add_rows(self, n)
Parameters:
  • self – Mat
  • n – unsigned
Returns:

Mat
add_zero_cols(self, n)
Parameters:
  • self – Mat
  • n – unsigned
Returns:

Mat
add_zero_rows(self, n)
Parameters:
  • self – Mat
  • n – unsigned
Returns:

Mat
alloc(ctx, n_row, n_col)
Parameters:
  • ctx – Context
  • n_row – unsigned
  • n_col – unsigned
Returns:

Mat
col_add(self, dst_col, src_col)
Parameters:
  • self – Mat
  • dst_col – int
  • src_col – int
Returns:

None
cols(self)
Parameters:self – Mat
Returns:int
concat(self, bot)
Parameters:
Returns:

Mat
copy(self)
Parameters:self – Mat
Returns:Mat
diagonal(self, mat2)
Parameters:
Returns:

Mat
from_row_vec(vec)
Parameters:vec – Vec
Returns:Mat
get_ctx(self)
Parameters:self – Mat
Returns:Context
get_element(self, row, col)
Parameters:
  • self – Mat
  • row – int
  • col – int
Returns:

v (integer)
initial_non_zero_cols(self)
Parameters:self – Mat
Returns:int
insert_cols(self, col, n)
Parameters:
  • self – Mat
  • col – unsigned
  • n – unsigned
Returns:

Mat
insert_rows(self, row, n)
Parameters:
  • self – Mat
  • row – unsigned
  • n – unsigned
Returns:

Mat
insert_zero_cols(self, first, n)
Parameters:
  • self – Mat
  • first – unsigned
  • n – unsigned
Returns:

Mat
insert_zero_rows(self, row, n)
Parameters:
  • self – Mat
  • row – unsigned
  • n – unsigned
Returns:

Mat
is_equal(self, mat2)
Parameters:
Returns:

bool
is_valid()

Return whether current object is still valid.

move_cols(self, dst_col, src_col, n)
Parameters:
  • self – Mat
  • dst_col – unsigned
  • src_col – unsigned
  • n – unsigned
Returns:

Mat
normalize(self)
Parameters:self – Mat
Returns:Mat
normalize_row(self, row)
Parameters:
  • self – Mat
  • row – int
Returns:

Mat
print_internal(self, out, indent)
Parameters:
  • self – Mat
  • out – file-like
  • indent – int
Returns:

None
right_inverse(self)
Parameters:self – Mat
Returns:Mat
right_kernel(self)
Parameters:self – Mat
Returns:Mat
rows(self)
Parameters:self – Mat
Returns:int
scale_down_row(self, row, m)
Parameters:
  • self – Mat
  • row – int
  • m – integer
Returns:

Mat
set_element(self, row, col, v)
Parameters:
  • self – Mat
  • row – int
  • col – int
  • v – integer
Returns:

Mat
vec_concat(self, bot)
Parameters:
Returns:

Mat
vec_inverse_product(self, vec)
Parameters:
Returns:

Vec

Sets and Maps

Basic Set

class islpy.BasicSet(s, context=None)
add(self, type, n)
Parameters:
Returns:

BasicSet
add_basic_set(self, bset)
Parameters:
Returns:

Set
add_constraint(self, constraint)
Parameters:
Returns:

BasicSet
add_constraints(obj, constraints)

New in version 2011.3.

add_dims(self, type, n)
Parameters:
Returns:

BasicSet
add_set(self, set)
Parameters:
Returns:

UnionSet
affine_hull(self)
Parameters:self – BasicSet
Returns:BasicSet
align_divs(self)
Parameters:self – Set
Returns:Set
align_params(self, model)
Parameters:
Returns:

BasicSet
apply(self, bmap)
Parameters:
Returns:

BasicSet
apply_pw_qpolynomial_fold(self, pwf)
Parameters:
Returns:

tuple: (PwQPolynomialFold, tight (integer))
apply_union_pw_qpolynomial_fold(self, upwf)
Parameters:
Returns:

tuple: (UnionPwQPolynomialFold, tight (integer))
box_from_points(pnt1, pnt2)
Parameters:
Returns:

BasicSet
coalesce(self)
Parameters:self – Set
Returns:Set
coefficients(self)
Parameters:self – BasicSet
Returns:BasicSet
complement(self)
Parameters:self – Set
Returns:Set
compute_divs(self)
Parameters:self – Set
Returns:Set
compute_schedule(self, validity, proximity)
Parameters:
Returns:

Schedule
compute_vertices(self)
Parameters:self – BasicSet
Returns:Vertices
contains(self, dim)
Parameters:
Returns:

int
convex_hull(self)
Parameters:self – Set
Returns:BasicSet
copy(self)
Parameters:self – BasicSet
Returns:BasicSet
count(self)
Parameters:self – Set
Returns:count (integer)
count_upto(self, max)
Parameters:
Returns:

count (integer)
detect_equalities(self)
Parameters:self – BasicSet
Returns:BasicSet
dim(self, type)
Parameters:
Returns:

unsigned
dim_has_any_lower_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_any_upper_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_lower_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_upper_bound(self, type, pos)
Parameters:
Returns:

int
dim_is_bounded(self, type, pos)
Parameters:
Returns:

int
dim_max(self, pos)
Parameters:
  • self – Set
  • pos – int
Returns:

PwAff
dim_min(self, pos)
Parameters:
  • self – Set
  • pos – int
Returns:

PwAff
drop_constraint(self, constraint)
Parameters:
Returns:

BasicSet
drop_constraints_involving_dims(self, type, first, n)
Parameters:
Returns:

BasicSet
drop_constraints_not_involving_dims(self, type, first, n)
Parameters:
Returns:

BasicSet
eliminate(self, type, first, n)
Parameters:
Returns:

BasicSet
eliminate_except(obj, names, types)
Parameters:
  • types – list of dim_type determining the types of axes to eliminate
  • names – names of axes matching the above which should be left alone by the eliminate

New in version 2011.3.

empty(dim)
Parameters:dim – Space
Returns:BasicSet
equalities_matrix(self, c1, c2, c3, c4)
Parameters:
Returns:

Mat
equate(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Set
extract_set(self, dim)
Parameters:
Returns:

Set
fast_dim_is_fixed(self, dim)
Parameters:
  • self – Set
  • dim – unsigned
Returns:

val (integer)
fast_is_disjoint(self, set2)
Parameters:
Returns:

int
fast_is_empty(self)
Parameters:self – BasicSet
Returns:int
fast_is_equal(self, set2)
Parameters:
Returns:

int
fast_is_universe(self)
Parameters:self – Set
Returns:int
find_dim_by_id(self, type, id)
Parameters:
Returns:

int
find_dim_by_name(self, type, name)
Parameters:
Returns:

int
fix(self, type, pos, value)
Parameters:
Returns:

BasicSet
flat_product(self, bset2)
Parameters:
Returns:

BasicSet
flatten(self)
Parameters:self – BasicSet
Returns:BasicSet
flatten_map(self)
Parameters:self – Set
Returns:Map
follows_at(self, set2, pos)
Parameters:
  • self – Set
  • set2 – Set
  • pos – int
Returns:

int
foreach_basic_set(self)
Parameters:
  • self – Set
  • fn – callback(bset)
Returns:

int
foreach_bound_pair(self, type, pos)
Parameters:
  • self – BasicSet
  • type – dim_type
  • pos – unsigned
  • fn – callback(lower, upper, bset)
Returns:

int
foreach_constraint(self)
Parameters:
Returns:

int
foreach_point(self)
Parameters:
  • self – Set
  • fn – callback(pnt)
Returns:

int
foreach_set(self)
Parameters:
  • self – UnionSet
  • fn – callback(set)
Returns:

int
from_constraint_matrices(dim, eq, ineq, c1, c2, c3, c4)
Parameters:
Returns:

BasicSet
from_params(self)
Parameters:self – BasicSet
Returns:BasicSet
from_point(pnt)
Parameters:pnt – Point
Returns:BasicSet
get_basic_sets(basic_instance, *args, **kwargs)

Get the list of BasicSet instances in this Set.

get_constraints()

Get a list of constraints.

get_ctx(self)
Parameters:self – BasicSet
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_div(self, pos)
Parameters:
Returns:

Aff
get_local_space(self)
Parameters:self – BasicSet
Returns:LocalSpace
get_space(self)
Parameters:self – BasicSet
Returns:Space
get_tuple_id(self)
Parameters:self – Set
Returns:Id
get_tuple_name(self)
Parameters:self – BasicSet
Returns:string
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

gist(self, context)
Parameters:
Returns:

BasicSet
gist_basic_set(self, context)
Parameters:
Returns:

Set
gist_params(self, context)
Parameters:
  • self – Set
  • context – Set
Returns:

Set
has_dim_id(self, type, pos)
Parameters:
Returns:

bool
has_dim_name(self, type, pos)
Parameters:
Returns:

bool
has_equal_space(self, set2)
Parameters:
Returns:

bool
has_tuple_id(self)
Parameters:self – Set
Returns:bool
has_tuple_name(self)
Parameters:self – Set
Returns:bool
identity(self)
Parameters:self – Set
Returns:Map
indicator_function(self)
Parameters:self – Set
Returns:PwAff
inequalities_matrix(self, c1, c2, c3, c4)
Parameters:
Returns:

Mat
insert_dims(self, type, pos, n)
Parameters:
Returns:

BasicSet
intersect(self, bset2)
Parameters:
Returns:

BasicSet
intersect_params(self, bset2)
Parameters:
Returns:

BasicSet
involves_dims(self, type, first, n)
Parameters:
Returns:

int
is_bounded(self)
Parameters:self – BasicSet
Returns:bool
is_box(self)
Parameters:self – Set
Returns:bool
is_disjoint(self, set2)
Parameters:
Returns:

bool
is_empty(self)
Parameters:self – BasicSet
Returns:bool
is_equal(self, set2)
Parameters:
Returns:

bool
is_params(self)
Parameters:self – Set
Returns:bool
is_rational(self)
Parameters:self – BasicSet
Returns:bool
is_singleton(self)
Parameters:self – Set
Returns:bool
is_strict_subset(self, set2)
Parameters:
Returns:

bool
is_subset(self, bset2)
Parameters:
Returns:

bool
is_universe(self)
Parameters:self – BasicSet
Returns:bool
is_valid()

Return whether current object is still valid.

is_wrapping(self)
Parameters:self – BasicSet
Returns:bool
lex_ge_set(self, set2)
Parameters:
Returns:

Map
lex_ge_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_gt_set(self, set2)
Parameters:
Returns:

Map
lex_gt_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_le_set(self, set2)
Parameters:
Returns:

Map
lex_le_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_lt_set(self, set2)
Parameters:
Returns:

Map
lex_lt_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lexmax(self)
Parameters:self – BasicSet
Returns:Set
lexmin(self)
Parameters:self – BasicSet
Returns:Set
lift(self)
Parameters:self – BasicSet
Returns:BasicSet
lifting(self)
Parameters:self – Set
Returns:Map
lower_bound(self, type, pos, value)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Set
make_disjoint(self)
Parameters:self – Set
Returns:Set
move_dims(self, dst_type, dst_pos, src_type, src_pos, n)
Parameters:
  • self – BasicSet
  • dst_type – dim_type
  • dst_pos – unsigned
  • src_type – dim_type
  • src_pos – unsigned
  • n – unsigned
Returns:

BasicSet
n_basic_set(self)
Parameters:self – Set
Returns:int
n_constraint(self)
Parameters:self – BasicSet
Returns:int
n_dim(self)
Parameters:self – BasicSet
Returns:unsigned
n_param(self)
Parameters:self – BasicSet
Returns:unsigned
n_set(self)
Parameters:self – UnionSet
Returns:int
nat_universe(dim)
Parameters:dim – Space
Returns:BasicSet
neg(self)
Parameters:self – BasicSet
Returns:BasicSet
params(self)
Parameters:self – BasicSet
Returns:BasicSet
partial_lexmax(self, dom)
Parameters:
Returns:

tuple: (Set, empty (Set))
partial_lexmax_pw_multi_aff(self, dom)
Parameters:
Returns:

tuple: (PwMultiAff, empty (Set))
partial_lexmin(self, dom)
Parameters:
Returns:

tuple: (Set, empty (Set))
partial_lexmin_pw_multi_aff(self, dom)
Parameters:
Returns:

tuple: (PwMultiAff, empty (Set))
plain_cmp(self, set2)
Parameters:
Returns:

int
plain_dim_has_fixed_lower_bound(self, dim)
Parameters:
  • self – Set
  • dim – unsigned
Returns:

val (integer)
plain_dim_is_fixed(self, dim)
Parameters:
Returns:

val (integer)
plain_is_disjoint(self, set2)
Parameters:
Returns:

int
plain_is_empty(self)
Parameters:self – BasicSet
Returns:int
plain_is_equal(self, set2)
Parameters:
Returns:

int
plain_is_fixed(self, type, pos)
Parameters:
Returns:

val (integer)
plain_is_universe(self)
Parameters:self – Set
Returns:int
polyhedral_hull(self)
Parameters:self – Set
Returns:BasicSet
positive_orthant(space)
Parameters:space – Space
Returns:BasicSet
preimage_multi_aff(self, ma)
Parameters:
Returns:

BasicSet
preimage_pw_multi_aff(self, pma)
Parameters:
Returns:

Set
print_(self, out, indent, prefix, suffix, output_format)
Parameters:
  • self – BasicSet
  • out – file-like
  • indent – int
  • prefix – string
  • suffix – string
  • output_format – unsigned
Returns:

None
print_internal(self, out, indent)
Parameters:
  • self – BasicSet
  • out – file-like
  • indent – int
Returns:

None
product(self, set2)
Parameters:
Returns:

Set
project_out(self, type, first, n)
Parameters:
Returns:

BasicSet
project_out_except(obj, names, types)
Parameters:
  • types – list of dim_type determining the types of axes to project out
  • names – names of axes matching the above which should be left alone by the projection

New in version 2011.3.

read_from_file(ctx, input)
Parameters:
  • ctx – Context
  • input – file-like
Returns:

BasicSet
read_from_str(ctx, str)
Parameters:
Returns:

BasicSet
recession_cone(self)
Parameters:self – Set
Returns:Set
reduced_basis(self)
Parameters:self – BasicSet
Returns:Mat
remove_dims(self, type, first, n)
Parameters:
Returns:

BasicSet
remove_divs(self)
Parameters:self – BasicSet
Returns:BasicSet
remove_divs_involving_dims(self, type, first, n)
Parameters:
Returns:

BasicSet
remove_redundancies(self)
Parameters:self – BasicSet
Returns:BasicSet
remove_unknown_divs(self)
Parameters:self – BasicSet
Returns:BasicSet
reset_space(self, dim)
Parameters:
Returns:

Set
reset_tuple_id(self)
Parameters:self – Set
Returns:Set
sample(self)
Parameters:self – BasicSet
Returns:BasicSet
sample_point(self)
Parameters:self – BasicSet
Returns:Point
set_dim_id(self, type, pos, id)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • id – Id
Returns:

Set
set_dim_name(self, type, pos, s)
Parameters:
Returns:

BasicSet
set_tuple_id(self, id)
Parameters:
  • self – Set
  • id – Id
Returns:

Set
set_tuple_name(self, s)
Parameters:
Returns:

BasicSet
simple_hull(self)
Parameters:self – Set
Returns:BasicSet
solutions(self)
Parameters:self – BasicSet
Returns:BasicSet
space

get_space(self)

Parameters:self – BasicSet
Returns:Space
split_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
subtract(self, set2)
Parameters:
Returns:

Set
sum(self, set2)
Parameters:
Returns:

Set
to_str(self)
Parameters:self – Set
Returns:string
union(self, bset2)
Parameters:
Returns:

Set
universe(dim)
Parameters:dim – Space
Returns:BasicSet
universe_like(self)
Parameters:self – Set
Returns:Set
universe_like_set(model)
Parameters:model – Set
Returns:BasicSet
unshifted_simple_hull(self)
Parameters:self – Set
Returns:BasicSet
unwrap(self)
Parameters:self – BasicSet
Returns:BasicMap
upper_bound(self, type, pos, value)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Set

Basic Map

class islpy.BasicMap(s, context=None)
add(self, type, n)
Parameters:
Returns:

BasicMap
add_basic_map(self, bmap)
Parameters:
Returns:

Map
add_constraint(self, constraint)
Parameters:
Returns:

BasicMap
add_constraints(obj, constraints)

New in version 2011.3.

add_dims(self, type, n)
Parameters:
Returns:

Map
add_map(self, map)
Parameters:
Returns:

UnionMap
affine_hull(self)
Parameters:self – BasicMap
Returns:BasicMap
align_divs(self)
Parameters:self – Map
Returns:Map
align_params(self, model)
Parameters:
Returns:

BasicMap
apply_domain(self, bmap2)
Parameters:
Returns:

BasicMap
apply_pw_qpolynomial_fold(self, pwf)
Parameters:
Returns:

tuple: (PwQPolynomialFold, tight (integer))
apply_range(self, bmap2)
Parameters:
Returns:

BasicMap
apply_union_pw_qpolynomial_fold(self, upwf)
Parameters:
Returns:

tuple: (UnionPwQPolynomialFold, tight (integer))
can_curry(self)
Parameters:self – BasicMap
Returns:int
can_uncurry(self)
Parameters:self – BasicMap
Returns:int
can_zip(self)
Parameters:self – BasicMap
Returns:int
coalesce(self)
Parameters:self – Map
Returns:Map
complement(self)
Parameters:self – Map
Returns:Map
compute_divs(self)
Parameters:self – BasicMap
Returns:Map
compute_flow(self, must_source, may_source, schedule)
Parameters:
Returns:

tuple: (must_dep (UnionMap), may_dep (UnionMap), must_no_source (UnionMap), may_no_source (UnionMap))
contains(self, dim)
Parameters:
Returns:

int
convex_hull(self)
Parameters:self – Map
Returns:BasicMap
copy(self)
Parameters:self – BasicMap
Returns:BasicMap
curry(self)
Parameters:self – BasicMap
Returns:BasicMap
deltas(self)
Parameters:self – BasicMap
Returns:BasicSet
deltas_map(self)
Parameters:self – BasicMap
Returns:BasicMap
detect_equalities(self)
Parameters:self – BasicMap
Returns:BasicMap
dim(self, type)
Parameters:
Returns:

unsigned
dim_max(self, pos)
Parameters:
  • self – Map
  • pos – int
Returns:

PwAff
domain(self)
Parameters:self – BasicMap
Returns:BasicSet
domain_map(self)
Parameters:self – BasicMap
Returns:BasicMap
domain_product(self, bmap2)
Parameters:
Returns:

BasicMap
drop_basic_map(self, bmap)
Parameters:
Returns:

Map
drop_constraints_involving_dims(self, type, first, n)
Parameters:
  • self – Map
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Map
eliminate(self, type, first, n)
Parameters:
Returns:

BasicMap
empty(dim)
Parameters:dim – Space
Returns:BasicMap
equal(dim, n_equal)
Parameters:
  • dim – Space
  • n_equal – unsigned
Returns:

BasicMap
equalities_matrix(self, c1, c2, c3, c4, c5)
Parameters:
Returns:

Mat
equate(self, type1, pos1, type2, pos2)
Parameters:
Returns:

BasicMap
extract_map(self, dim)
Parameters:
Returns:

Map
fast_is_empty(self)
Parameters:self – BasicMap
Returns:int
fast_is_equal(self, map2)
Parameters:
Returns:

int
fast_is_fixed(self, type, pos)
Parameters:
Returns:

val (integer)
find_dim_by_id(self, type, id)
Parameters:
Returns:

int
find_dim_by_name(self, type, name)
Parameters:
Returns:

int
fix(self, type, pos, value)
Parameters:
  • self – Map
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Map
fixed_power(self, exp)
Parameters:
  • self – Map
  • exp – integer
Returns:

Map
flat_domain_product(self, map2)
Parameters:
Returns:

Map
flat_product(self, bmap2)
Parameters:
Returns:

BasicMap
flat_range_product(self, bmap2)
Parameters:
Returns:

BasicMap
flatten(self)
Parameters:self – BasicMap
Returns:BasicMap
flatten_domain(self)
Parameters:self – BasicMap
Returns:BasicMap
flatten_range(self)
Parameters:self – BasicMap
Returns:BasicMap
foreach_basic_map(self)
Parameters:
  • self – Map
  • fn – callback(bmap)
Returns:

int
foreach_constraint(self)
Parameters:
Returns:

int
foreach_map(self)
Parameters:
  • self – UnionMap
  • fn – callback(map)
Returns:

int
from_aff(aff)
Parameters:aff – Aff
Returns:BasicMap
from_aff_list(domain_dim, list)
Parameters:
Returns:

BasicMap
from_basic_set(bset, dim)
Parameters:
Returns:

BasicMap
from_constraint(constraint)
Parameters:constraint – Constraint
Returns:BasicMap
from_constraint_matrices(dim, eq, ineq, c1, c2, c3, c4, c5)
Parameters:
Returns:

BasicMap
from_domain(bset)
Parameters:bset – BasicSet
Returns:BasicMap
from_domain_and_range(domain, range)
Parameters:
Returns:

BasicMap
from_multi_aff(maff)
Parameters:maff – MultiAff
Returns:BasicMap
from_qpolynomial(qp)
Parameters:qp – QPolynomial
Returns:BasicMap
from_range(bset)
Parameters:bset – BasicSet
Returns:BasicMap
get_basic_maps(basic_instance, *args, **kwargs)

Get the list of BasicMap instances in this Map.

get_constraints()

Get a list of constraints.

get_ctx(self)
Parameters:self – BasicMap
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_div(self, pos)
Parameters:
Returns:

Aff
get_local_space(self)
Parameters:self – BasicMap
Returns:LocalSpace
get_space(self)
Parameters:self – BasicMap
Returns:Space
get_tuple_id(self, type)
Parameters:
Returns:

Id
get_tuple_name(self, type)
Parameters:
Returns:

string
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

gist(self, context)
Parameters:
Returns:

BasicMap
gist_basic_map(self, context)
Parameters:
Returns:

Map
gist_domain(self, context)
Parameters:
  • self – Map
  • context – Set
Returns:

Map
gist_params(self, context)
Parameters:
  • self – Map
  • context – Set
Returns:

Map
gist_range(self, context)
Parameters:
  • self – Map
  • context – Set
Returns:

Map
has_defining_equality(self, type, pos)
Parameters:
Returns:

c (Constraint)
has_dim_id(self, type, pos)
Parameters:
Returns:

bool
has_dim_name(self, type, pos)
Parameters:
Returns:

bool
has_equal_space(self, map2)
Parameters:
Returns:

bool
has_tuple_id(self, type)
Parameters:
Returns:

bool
has_tuple_name(self, type)
Parameters:
Returns:

bool
identity(dim)
Parameters:dim – Space
Returns:BasicMap
image_is_bounded(self)
Parameters:self – BasicMap
Returns:int
inequalities_matrix(self, c1, c2, c3, c4, c5)
Parameters:
Returns:

Mat
insert_dims(self, type, pos, n)
Parameters:
Returns:

BasicMap
intersect(self, bmap2)
Parameters:
Returns:

BasicMap
intersect_domain(self, bset)
Parameters:
Returns:

BasicMap
intersect_params(self, params)
Parameters:
Returns:

Map
intersect_range(self, bset)
Parameters:
Returns:

BasicMap
involves_dims(self, type, first, n)
Parameters:
Returns:

int
is_bijective(self)
Parameters:self – Map
Returns:bool
is_disjoint(self, map2)
Parameters:
Returns:

bool
is_empty(self)
Parameters:self – BasicMap
Returns:bool
is_equal(self, bmap2)
Parameters:
Returns:

bool
is_injective(self)
Parameters:self – Map
Returns:bool
is_rational(self)
Parameters:self – BasicMap
Returns:bool
is_single_valued(self)
Parameters:self – BasicMap
Returns:bool
is_strict_subset(self, bmap2)
Parameters:
Returns:

bool
is_subset(self, bmap2)
Parameters:
Returns:

bool
is_translation(self)
Parameters:self – Map
Returns:bool
is_universe(self)
Parameters:self – BasicMap
Returns:bool
is_valid()

Return whether current object is still valid.

less_at(dim, pos)
Parameters:
  • dim – Space
  • pos – unsigned
Returns:

BasicMap
lex_ge_map(self, map2)
Parameters:
Returns:

Map
lex_ge_union_map(self, umap2)
Parameters:
Returns:

UnionMap
lex_gt_map(self, map2)
Parameters:
Returns:

Map
lex_gt_union_map(self, umap2)
Parameters:
Returns:

UnionMap
lex_le_map(self, map2)
Parameters:
Returns:

Map
lex_le_union_map(self, umap2)
Parameters:
Returns:

UnionMap
lex_lt_map(self, map2)
Parameters:
Returns:

Map
lex_lt_union_map(self, umap2)
Parameters:
Returns:

UnionMap
lexmax(self)
Parameters:self – BasicMap
Returns:Map
lexmax_pw_multi_aff(self)
Parameters:self – Map
Returns:PwMultiAff
lexmin(self)
Parameters:self – BasicMap
Returns:Map
lexmin_pw_multi_aff(self)
Parameters:self – BasicMap
Returns:PwMultiAff
make_disjoint(self)
Parameters:self – Map
Returns:Map
more_at(dim, pos)
Parameters:
  • dim – Space
  • pos – unsigned
Returns:

BasicMap
move_dims(self, dst_type, dst_pos, src_type, src_pos, n)
Parameters:
  • self – BasicMap
  • dst_type – dim_type
  • dst_pos – unsigned
  • src_type – dim_type
  • src_pos – unsigned
  • n – unsigned
Returns:

BasicMap
n_map(self)
Parameters:self – UnionMap
Returns:int
nat_universe(dim)
Parameters:dim – Space
Returns:BasicMap
oppose(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Map
order_ge(self, type1, pos1, type2, pos2)
Parameters:
Returns:

BasicMap
order_gt(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Map
order_lt(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Map
params(self)
Parameters:self – Map
Returns:Set
partial_lexmax(self, dom)
Parameters:
Returns:

tuple: (Map, empty (Set))
partial_lexmax_pw_multi_aff(self, dom)
Parameters:
Returns:

tuple: (PwMultiAff, empty (Set))
partial_lexmin(self, dom)
Parameters:
Returns:

tuple: (Map, empty (Set))
partial_lexmin_pw_multi_aff(self, dom)
Parameters:
Returns:

tuple: (PwMultiAff, empty (Set))
plain_input_is_fixed(self, in)
Parameters:
  • self – Map
  • in – unsigned
Returns:

val (integer)
plain_is_empty(self)
Parameters:self – BasicMap
Returns:int
plain_is_equal(self, map2)
Parameters:
Returns:

int
plain_is_fixed(self, type, pos)
Parameters:
Returns:

val (integer)
plain_is_injective(self)
Parameters:self – Map
Returns:int
plain_is_single_valued(self)
Parameters:self – Map
Returns:int
plain_is_universe(self)
Parameters:self – Map
Returns:int
polyhedral_hull(self)
Parameters:self – Map
Returns:BasicMap
power(self)
Parameters:self – Map
Returns:tuple: (Map, exact (integer))
print_(self, out, indent, prefix, suffix, output_format)
Parameters:
  • self – BasicMap
  • out – file-like
  • indent – int
  • prefix – string
  • suffix – string
  • output_format – unsigned
Returns:

None
print_internal(self, out, indent)
Parameters:
  • self – BasicMap
  • out – file-like
  • indent – int
Returns:

None
product(self, bmap2)
Parameters:
Returns:

BasicMap
project_out(self, type, first, n)
Parameters:
Returns:

BasicMap
project_out_except(obj, names, types)
Parameters:
  • types – list of dim_type determining the types of axes to project out
  • names – names of axes matching the above which should be left alone by the projection

New in version 2011.3.

range(self)
Parameters:self – BasicMap
Returns:BasicSet
range_map(self)
Parameters:self – BasicMap
Returns:BasicMap
range_product(self, bmap2)
Parameters:
Returns:

BasicMap
reaching_path_lengths(self)
Parameters:self – Map
Returns:tuple: (Map, exact (integer))
read_from_file(ctx, input)
Parameters:
  • ctx – Context
  • input – file-like
Returns:

BasicMap
read_from_str(ctx, str)
Parameters:
Returns:

BasicMap
remove_dims(self, type, first, n)
Parameters:
Returns:

BasicMap
remove_divs(self)
Parameters:self – BasicMap
Returns:BasicMap
remove_divs_involving_dims(self, type, first, n)
Parameters:
Returns:

BasicMap
remove_redundancies(self)
Parameters:self – BasicMap
Returns:BasicMap
remove_unknown_divs(self)
Parameters:self – Map
Returns:Map
reset_tuple_id(self, type)
Parameters:
Returns:

Map
reverse(self)
Parameters:self – BasicMap
Returns:BasicMap
sample(self)
Parameters:self – BasicMap
Returns:BasicMap
set_dim_id(self, type, pos, id)
Parameters:
  • self – Map
  • type – dim_type
  • pos – unsigned
  • id – Id
Returns:

Map
set_dim_name(self, type, pos, s)
Parameters:
Returns:

BasicMap
set_tuple_id(self, type, id)
Parameters:
Returns:

Map
set_tuple_name(self, type, s)
Parameters:
Returns:

BasicMap
simple_hull(self)
Parameters:self – Map
Returns:BasicMap
space

get_space(self)

Parameters:self – BasicMap
Returns:Space
subtract(self, map2)
Parameters:
Returns:

Map
subtract_domain(self, dom)
Parameters:
Returns:

Map
subtract_range(self, dom)
Parameters:
Returns:

Map
transitive_closure(self)
Parameters:self – Map
Returns:tuple: (Map, exact (integer))
uncurry(self)
Parameters:self – BasicMap
Returns:BasicMap
union(self, bmap2)
Parameters:
Returns:

Map
universe(dim)
Parameters:dim – Space
Returns:BasicMap
universe_like(self)
Parameters:self – BasicMap
Returns:BasicMap
unshifted_simple_hull(self)
Parameters:self – Map
Returns:BasicMap
wrap(self)
Parameters:self – BasicMap
Returns:BasicSet
zip(self)
Parameters:self – BasicMap
Returns:BasicMap

Set

class islpy.Set(s, context=None)
add_basic_set(self, bset)
Parameters:
Returns:

Set
add_constraint(self, constraint)
Parameters:
Returns:

Set
add_constraints(obj, constraints)

New in version 2011.3.

add_dims(self, type, n)
Parameters:
Returns:

Set
add_set(self, set)
Parameters:
Returns:

UnionSet
affine_hull(self)
Parameters:self – Set
Returns:BasicSet
align_divs(self)
Parameters:self – Set
Returns:Set
align_params(self, model)
Parameters:
Returns:

Set
apply(self, map)
Parameters:
Returns:

Set
apply_pw_qpolynomial_fold(self, pwf)
Parameters:
Returns:

tuple: (PwQPolynomialFold, tight (integer))
apply_union_pw_qpolynomial_fold(self, upwf)
Parameters:
Returns:

tuple: (UnionPwQPolynomialFold, tight (integer))
box_from_points(pnt1, pnt2)
Parameters:
Returns:

Set
coalesce(self)
Parameters:self – Set
Returns:Set
coefficients(self)
Parameters:self – Set
Returns:BasicSet
complement(self)
Parameters:self – Set
Returns:Set
compute_divs(self)
Parameters:self – Set
Returns:Set
compute_schedule(self, validity, proximity)
Parameters:
Returns:

Schedule
contains(self, dim)
Parameters:
Returns:

int
convex_hull(self)
Parameters:self – Set
Returns:BasicSet
copy(self)
Parameters:self – Set
Returns:Set
count(self)
Parameters:self – Set
Returns:count (integer)
count_upto(self, max)
Parameters:
  • self – Set
  • max – integer
Returns:

count (integer)
detect_equalities(self)
Parameters:self – Set
Returns:Set
dim(self, type)
Parameters:
Returns:

unsigned
dim_has_any_lower_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_any_upper_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_lower_bound(self, type, pos)
Parameters:
Returns:

int
dim_has_upper_bound(self, type, pos)
Parameters:
Returns:

int
dim_is_bounded(self, type, pos)
Parameters:
Returns:

int
dim_max(self, pos)
Parameters:
  • self – Set
  • pos – int
Returns:

PwAff
dim_min(self, pos)
Parameters:
  • self – Set
  • pos – int
Returns:

PwAff
drop_constraints_involving_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
eliminate(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
eliminate_except(obj, names, types)
Parameters:
  • types – list of dim_type determining the types of axes to eliminate
  • names – names of axes matching the above which should be left alone by the eliminate

New in version 2011.3.

empty(dim)
Parameters:dim – Space
Returns:Set
equate(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Set
extract_set(self, dim)
Parameters:
Returns:

Set
fast_dim_is_fixed(self, dim)
Parameters:
  • self – Set
  • dim – unsigned
Returns:

val (integer)
fast_is_disjoint(self, set2)
Parameters:
Returns:

int
fast_is_empty(self)
Parameters:self – Set
Returns:int
fast_is_equal(self, set2)
Parameters:
Returns:

int
fast_is_universe(self)
Parameters:self – Set
Returns:int
find_dim_by_id(self, type, id)
Parameters:
Returns:

int
find_dim_by_name(self, type, name)
Parameters:
Returns:

int
fix(self, type, pos, value)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Set
flat_product(self, set2)
Parameters:
Returns:

Set
flatten(self)
Parameters:self – Set
Returns:Set
flatten_map(self)
Parameters:self – Set
Returns:Map
follows_at(self, set2, pos)
Parameters:
  • self – Set
  • set2 – Set
  • pos – int
Returns:

int
foreach_basic_set(self)
Parameters:
  • self – Set
  • fn – callback(bset)
Returns:

int
foreach_point(self)
Parameters:
  • self – Set
  • fn – callback(pnt)
Returns:

int
foreach_set(self)
Parameters:
  • self – UnionSet
  • fn – callback(set)
Returns:

int
from_basic_set(bset)
Parameters:bset – BasicSet
Returns:Set
from_params(self)
Parameters:self – Set
Returns:Set
from_point(pnt)
Parameters:pnt – Point
Returns:Set
from_pw_aff(pwaff)
Parameters:pwaff – PwAff
Returns:Set
from_pw_multi_aff(pma)
Parameters:pma – PwMultiAff
Returns:Set
from_union_set(uset)
Parameters:uset – UnionSet
Returns:Set
get_basic_sets()

Get the list of BasicSet instances in this Set.

get_ctx(self)
Parameters:self – Set
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_space(self)
Parameters:self – Set
Returns:Space
get_tuple_id(self)
Parameters:self – Set
Returns:Id
get_tuple_name(self)
Parameters:self – Set
Returns:string
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

gist(self, context)
Parameters:
  • self – Set
  • context – Set
Returns:

Set
gist_basic_set(self, context)
Parameters:
Returns:

Set
gist_params(self, context)
Parameters:
  • self – Set
  • context – Set
Returns:

Set
has_dim_id(self, type, pos)
Parameters:
Returns:

bool
has_dim_name(self, type, pos)
Parameters:
Returns:

bool
has_equal_space(self, set2)
Parameters:
Returns:

bool
has_tuple_id(self)
Parameters:self – Set
Returns:bool
has_tuple_name(self)
Parameters:self – Set
Returns:bool
identity(self)
Parameters:self – Set
Returns:Map
indicator_function(self)
Parameters:self – Set
Returns:PwAff
insert_dims(self, type, pos, n)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • n – unsigned
Returns:

Set
intersect(self, set2)
Parameters:
Returns:

Set
intersect_params(self, params)
Parameters:
Returns:

Set
involves_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

int
is_bounded(self)
Parameters:self – Set
Returns:bool
is_box(self)
Parameters:self – Set
Returns:bool
is_disjoint(self, set2)
Parameters:
Returns:

bool
is_empty(self)
Parameters:self – Set
Returns:bool
is_equal(self, set2)
Parameters:
Returns:

bool
is_params(self)
Parameters:self – Set
Returns:bool
is_singleton(self)
Parameters:self – Set
Returns:bool
is_strict_subset(self, set2)
Parameters:
Returns:

bool
is_subset(self, set2)
Parameters:
Returns:

bool
is_valid()

Return whether current object is still valid.

is_wrapping(self)
Parameters:self – Set
Returns:bool
lex_ge_set(self, set2)
Parameters:
Returns:

Map
lex_ge_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_gt_set(self, set2)
Parameters:
Returns:

Map
lex_gt_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_le_set(self, set2)
Parameters:
Returns:

Map
lex_le_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lex_lt_set(self, set2)
Parameters:
Returns:

Map
lex_lt_union_set(self, uset2)
Parameters:
Returns:

UnionMap
lexmax(self)
Parameters:self – Set
Returns:Set
lexmin(self)
Parameters:self – Set
Returns:Set
lift(self)
Parameters:self – Set
Returns:Set
lifting(self)
Parameters:self – Set
Returns:Map
lower_bound(self, type, pos, value)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Set
make_disjoint(self)
Parameters:self – Set
Returns:Set
move_dims(self, dst_type, dst_pos, src_type, src_pos, n)
Parameters:
  • self – Set
  • dst_type – dim_type
  • dst_pos – unsigned
  • src_type – dim_type
  • src_pos – unsigned
  • n – unsigned
Returns:

Set
n_basic_set(self)
Parameters:self – Set
Returns:int
n_dim(self)
Parameters:self – Set
Returns:unsigned
n_param(self)
Parameters:self – Set
Returns:unsigned
n_set(self)
Parameters:self – UnionSet
Returns:int
nat_universe(dim)
Parameters:dim – Space
Returns:Set
neg(self)
Parameters:self – Set
Returns:Set
params(self)
Parameters:self – Set
Returns:Set
partial_lexmax(self, dom)
Parameters:
Returns:

tuple: (Set, empty (Set))
partial_lexmin(self, dom)
Parameters:
Returns:

tuple: (Set, empty (Set))
plain_cmp(self, set2)
Parameters:
Returns:

int
plain_dim_has_fixed_lower_bound(self, dim)
Parameters:
  • self – Set
  • dim – unsigned
Returns:

val (integer)
plain_dim_is_fixed(self, dim)
Parameters:
  • self – Set
  • dim – unsigned
Returns:

val (integer)
plain_is_disjoint(self, set2)
Parameters:
Returns:

int
plain_is_empty(self)
Parameters:self – Set
Returns:int
plain_is_equal(self, set2)
Parameters:
Returns:

int
plain_is_fixed(self, type, pos)
Parameters:
Returns:

val (integer)
plain_is_universe(self)
Parameters:self – Set
Returns:int
polyhedral_hull(self)
Parameters:self – Set
Returns:BasicSet
preimage_multi_aff(self, ma)
Parameters:
Returns:

Set
preimage_pw_multi_aff(self, pma)
Parameters:
Returns:

Set
print_(self, out, indent, output_format)
Parameters:
  • self – Set
  • out – file-like
  • indent – int
  • output_format – unsigned
Returns:

None
print_internal(self, out, indent)
Parameters:
  • self – Set
  • out – file-like
  • indent – int
Returns:

None
product(self, set2)
Parameters:
Returns:

Set
project_out(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
project_out_except(obj, names, types)
Parameters:
  • types – list of dim_type determining the types of axes to project out
  • names – names of axes matching the above which should be left alone by the projection

New in version 2011.3.

read_from_file(ctx, input)
Parameters:
  • ctx – Context
  • input – file-like
Returns:

Set
read_from_str(ctx, str)
Parameters:
Returns:

Set
recession_cone(self)
Parameters:self – Set
Returns:Set
remove_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
remove_divs(self)
Parameters:self – Set
Returns:Set
remove_divs_involving_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
remove_redundancies(self)
Parameters:self – Set
Returns:Set
remove_unknown_divs(self)
Parameters:self – Set
Returns:Set
reset_space(self, dim)
Parameters:
Returns:

Set
reset_tuple_id(self)
Parameters:self – Set
Returns:Set
sample(self)
Parameters:self – Set
Returns:BasicSet
sample_point(self)
Parameters:self – Set
Returns:Point
set_dim_id(self, type, pos, id)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • id – Id
Returns:

Set
set_dim_name(self, type, pos, s)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • s – string
Returns:

Set
set_tuple_id(self, id)
Parameters:
  • self – Set
  • id – Id
Returns:

Set
set_tuple_name(self, s)
Parameters:
  • self – Set
  • s – string
Returns:

Set
simple_hull(self)
Parameters:self – Set
Returns:BasicSet
solutions(self)
Parameters:self – Set
Returns:BasicSet
space

get_space(self)

Parameters:self – Set
Returns:Space
split_dims(self, type, first, n)
Parameters:
  • self – Set
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Set
subtract(self, set2)
Parameters:
Returns:

Set
sum(self, set2)
Parameters:
Returns:

Set
to_str(self)
Parameters:self – Set
Returns:string
union(self, set2)
Parameters:
Returns:

Set
universe(dim)
Parameters:dim – Space
Returns:Set
universe_like(self)
Parameters:self – Set
Returns:Set
unshifted_simple_hull(self)
Parameters:self – Set
Returns:BasicSet
unwrap(self)
Parameters:self – Set
Returns:Map
upper_bound(self, type, pos, value)
Parameters:
  • self – Set
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Set

Map

class islpy.Map(s, context=None)
add_basic_map(self, bmap)
Parameters:
Returns:

Map
add_constraint(self, constraint)
Parameters:
Returns:

Map
add_constraints(obj, constraints)

New in version 2011.3.

add_dims(self, type, n)
Parameters:
Returns:

Map
add_map(self, map)
Parameters:
Returns:

UnionMap
affine_hull(self)
Parameters:self – Map
Returns:BasicMap
align_divs(self)
Parameters:self – Map
Returns:Map
align_params(self, model)
Parameters:
Returns:

Map
apply_domain(self, map2)
Parameters:
Returns:

Map
apply_pw_qpolynomial_fold(self, pwf)
Parameters:
Returns:

tuple: (PwQPolynomialFold, tight (integer))
apply_range(self, map2)
Parameters:
Returns:

Map
apply_union_pw_qpolynomial_fold(self, upwf)
Parameters:
Returns:

tuple: (UnionPwQPolynomialFold, tight (integer))
can_curry(self)
Parameters:self – Map
Returns:int
can_uncurry(self)
Parameters:self – Map
Returns:int
can_zip(self)
Parameters:self – Map
Returns:int
coalesce(self)
Parameters:self – Map
Returns:Map
complement(self)
Parameters:self – Map
Returns:Map
compute_divs(self)
Parameters:self – Map
Returns:Map
compute_flow(self, must_source, may_source, schedule)
Parameters:
Returns:

tuple: (must_dep (UnionMap), may_dep (UnionMap), must_no_source (UnionMap), may_no_source (UnionMap))
contains(self, dim)
Parameters:
Returns:

int
convex_hull(self)
Parameters:self – Map
Returns:BasicMap
copy(self)
Parameters:self – Map
Returns:Map
curry(self)
Parameters:self – Map
Returns:Map
deltas(self)
Parameters:self – Map
Returns:Set
deltas_map(self)
Parameters:self – Map
Returns:Map
detect_equalities(self)
Parameters:self – Map
Returns:Map
dim(self, type)
Parameters:
Returns:

unsigned
dim_max(self, pos)
Parameters:
  • self – Map
  • pos – int
Returns:

PwAff
domain(self)
Parameters:self – Map
Returns:Set
domain_map(self)
Parameters:self – Map
Returns:Map
domain_product(self, map2)
Parameters:
Returns:

Map
drop_basic_map(self, bmap)
Parameters:
Returns:

Map
drop_constraints_involving_dims(self, type, first, n)
Parameters:
  • self – Map
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Map
eliminate(self, type, first, n)
Parameters:
  • self – Map
  • type – dim_type
  • first – unsigned
  • n – unsigned
Returns:

Map
empty(dim)
Parameters:dim – Space
Returns:Map
equate(self, type1, pos1, type2, pos2)
Parameters:
Returns:

Map
extract_map(self, dim)
Parameters:
Returns:

Map
fast_is_empty(self)
Parameters:self – Map
Returns:int
fast_is_equal(self, map2)
Parameters:
Returns:

int
fast_is_fixed(self, type, pos)
Parameters:
Returns:

val (integer)
find_dim_by_id(self, type, id)
Parameters:
Returns:

int
find_dim_by_name(self, type, name)
Parameters:
Returns:

int
fix(self, type, pos, value)
Parameters:
  • self – Map
  • type – dim_type
  • pos – unsigned
  • value – integer
Returns:

Map
fixed_power(self, exp)
Parameters:
  • self – Map
  • exp – integer
Returns:

Map
flat_domain_product(self, map2)
Parameters:
Returns:

Map
flat_product(self, map2)
Parameters:
Returns:

Map
flat_range_product(self, map2)
Parameters:
Returns:

Map
flatten(self)
Parameters:self – Map
Returns:Map
flatten_domain(self)
Parameters:self – Map
Returns:Map
flatten_range(self)
Parameters:self – Map
Returns:Map
foreach_basic_map(self)
Parameters:
  • self – Map
  • fn – callback(bmap)
Returns:

int
foreach_map(self)
Parameters:
  • self – UnionMap
  • fn – callback(map)
Returns:

int
from_aff(aff)
Parameters:aff – Aff
Returns:Map
from_basic_map(bmap)
Parameters:bmap – BasicMap
Returns:Map
from_domain(set)
Parameters:set – Set
Returns:Map
from_domain_and_range(domain, range)
Parameters:
  • domain – Set
  • range – Set
Returns:

Map
from_multi_aff(maff)
Parameters:maff – MultiAff
Returns:Map
from_pw_aff(pwaff)
Parameters:pwaff – PwAff
Returns:Map
from_pw_multi_aff(pma)
Parameters:pma – PwMultiAff
Returns:Map
from_set(set, dim)
Parameters:
Returns:

Map
from_union_map(umap)
Parameters:umap – UnionMap
Returns:Map
get_basic_maps()

Get the list of BasicMap instances in this Map.

get_ctx(self)
Parameters:self – Map
Returns:Context
get_dim_id(self, type, pos)
Parameters:
Returns:

Id
get_dim_name(self, type, pos)
Parameters:
Returns:

string
get_space(self)
Parameters:self – Map
Returns:Space
get_tuple_id(self, type)
Parameters:
Returns:

Id
get_tuple_name(self, type)
Parameters:
Returns:

string
get_var_dict(dimtype=None)

Return a dictionary mapping variable names to tuples of (dim_type, index).

Parameters:dimtype – None to get all variables, otherwise one of dim_type.
get_var_names(dimtype)

Return a list of dim names (in order) for dim_type dimtype.

gist(self, context)