Reference: Basic Building Blocks#

Context#

class islpy.Context#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__ne__(other)#

Return self!=value.

abort(self)#
Parameters:

self – Context

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

aborted(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_always_print_block(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_allow_else(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_allow_or(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_atomic_upper_bound(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_detect_min_max(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_exploit_nested_bounds(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_group_coscheduled(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_prefer_pdiv(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_scale_strides(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_build_separation_bounds(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_iterator_type(self)#
Parameters:

self – Context

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_print_macro_once(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ast_print_outermost_block(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_bound(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_coalesce_bounded_wrapping(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_coalesce_preserve_locals(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_gbr_only_first(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_max_operations(self)#
Parameters:

self – Context

Returns:

unsigned long

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_on_error(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_pip_symmetry(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_algorithm(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_carry_self_first(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_max_coefficient(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_max_constant_term(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_maximize_band_depth(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_maximize_coincidence(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_outer_coincidence(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_separate_components(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_serialize_sccs(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_split_scaled(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_treat_coalescing(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_schedule_whole_component(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_tile_scale_tile_loops(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_tile_shift_point_loops(self)#
Parameters:

self – Context

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

reset_operations(self)#
Parameters:

self – Context

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

resume(self)#
Parameters:

self – Context

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_always_print_block(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_allow_else(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_allow_or(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_atomic_upper_bound(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_detect_min_max(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_exploit_nested_bounds(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_group_coscheduled(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_prefer_pdiv(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_scale_strides(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_build_separation_bounds(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_iterator_type(self, val)#
Parameters:
  • self – Context

  • val – string

Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_print_macro_once(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_ast_print_outermost_block(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_bound(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_coalesce_bounded_wrapping(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_coalesce_preserve_locals(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_gbr_only_first(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_max_operations(self, max_operations)#
Parameters:
Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_on_error(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_pip_symmetry(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_algorithm(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_carry_self_first(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_max_coefficient(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_max_constant_term(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_maximize_band_depth(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_maximize_coincidence(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_outer_coincidence(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_separate_components(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_serialize_sccs(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_split_scaled(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_treat_coalescing(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_schedule_whole_component(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_tile_scale_tile_loops(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_tile_shift_point_loops(self, val)#
Parameters:
Returns:

isl_stat

Warning

This function is not part of the officially public isl API. Use at your own risk.

Id#

class islpy.Id#
__eq__(self, other: islpy._isl.Id) bool#

__eq__(self, other)

Parameters:
  • self – Id

  • other – Id

Returns:

bool

__hash__(self) int#

get_hash(self)

Parameters:

self – Id

Returns:

uint32_t

Warning

This function is not part of the officially public isl API. Use at your own risk.

__ne__(self, other: islpy._isl.Id) bool#

__ne__(self, other)

Parameters:
  • self – Id

  • other – Id

Returns:

bool

dump(self)#
Parameters:

self – Id

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ctx(self)#
Parameters:

self – Id

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_name(self)#
Parameters:

self – Id

Returns:

string

get_user(self)#
Parameters:

self – Id

Returns:

a user-specified python object

Warning

This function is not part of the officially public isl API. Use at your own risk.

property name#

get_name(self) -> object

get_name(self)

Parameters:

self – Id

Returns:

string

read_from_str = <nanobind.nb_func object>#
to_list(self)#
Parameters:

self – Id

Returns:

IdList

to_str(self)#
Parameters:

self – Id

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

property user#

get_user(self) -> object

get_user(self)

Parameters:

self – Id

Returns:

a user-specified python object

Warning

This function is not part of the officially public isl API. Use at your own risk.

class islpy.MultiId#
__eq__(value, /)#

Return self==value.

__hash__()#

Return hash(self).

__len__(self) int#

size(self)

Parameters:

self – MultiId

Returns:

isl_size

__ne__(value, /)#

Return self!=value.

align_params(self, model)#
Parameters:
Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – MultiId

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

factor_range(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

flat_range_product(self, multi2)#
Parameters:
Returns:

MultiId

flatten_range(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_id_list = <nanobind.nb_func object>#
from_range(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_at(self, pos)#
Parameters:
Returns:

Id

get_ctx(self)#
Parameters:

self – MultiId

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_domain_space(self)#
Parameters:

self – MultiId

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_id(self, pos)#
Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_id_dict(dimtype=None)#

Return a dictionary mapping Id instances to tuples of (dim_type, index).

Parameters:

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

get_list(self)#
Parameters:

self – MultiId

Returns:

IdList

get_space(self)#
Parameters:

self – MultiId

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_ids(dimtype)#

Return a list of Id instances for dim_type dimtype.

get_var_names(dimtype)#

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

plain_is_equal(self, multi2)#
Parameters:
Returns:

bool

range_factor_domain(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_factor_range(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_is_wrapping(self)#
Parameters:

self – MultiId

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_product(self, multi2)#
Parameters:
Returns:

MultiId

range_splice(self, pos, multi2)#
Parameters:
Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

read_from_str = <nanobind.nb_func object>#
reset_user(self)#
Parameters:

self – MultiId

Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_at(self, pos, el)#
Parameters:
Returns:

MultiId

set_id(self, pos, el)#
Parameters:
Returns:

MultiId

Warning

This function is not part of the officially public isl API. Use at your own risk.

property space#

get_space(self) -> object

get_space(self)

Parameters:

self – MultiId

Returns:

Space

to_str(self)#
Parameters:

self – MultiId

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

Space#

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

class islpy.Space#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__ne__(other)#

Return self!=value.

add_dims#

Overloaded function.

  1. add_dims(self, type: islpy._isl.dim_type, n: int) -> object

add_dims(self, type, n)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. add_dims(self, arg0: islpy._isl.dim_type, arg1: int, /) -> object

Upcast from Space to LocalSpace

add_named_tuple_id_ui(self, tuple_id, dim)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_param_id(self, id)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_unnamed_tuple_ui(self, dim)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

align_params(self, space2)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

alloc = <nanobind.nb_func object>#
can_curry(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

can_range_curry(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

can_uncurry(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

can_zip(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy#

Overloaded function.

  1. copy(self) -> object

copy(self)

Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. copy(self) -> object

Upcast from Space to LocalSpace

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#

Overloaded function.

  1. dim(self, type: islpy._isl.dim_type) -> int

dim(self, type)

Parameters:
Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. dim(self, arg: islpy._isl.dim_type, /) -> int

Upcast from Space to LocalSpace

domain#

Overloaded function.

  1. domain(self) -> object

domain(self)

Parameters:

self – Space

Returns:

Space

  1. domain(self) -> object

Upcast from Space to LocalSpace

domain_factor_domain(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_factor_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_is_wrapping(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_map(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_map_multi_aff(self)#
Parameters:

self – Space

Returns:

MultiAff

domain_map_pw_multi_aff(self)#
Parameters:

self – Space

Returns:

PwMultiAff

domain_product(self, right)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_reverse(self)#
Parameters:

self – Space

Returns:

Space

domain_wrapped_domain(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain_wrapped_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_all_params(self)#
Parameters:

self – Space

Returns:

Space

drop_dims#

Overloaded function.

  1. drop_dims(self, type: islpy._isl.dim_type, first: int, num: int) -> object

drop_dims(self, type, first, num)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. drop_dims(self, arg0: islpy._isl.dim_type, arg1: int, arg2: int, /) -> object

Upcast from Space to LocalSpace

drop_inputs(self, first, n)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_outputs(self, first, n)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump#

Overloaded function.

  1. dump(self) -> None

dump(self)

Parameters:

self – Space

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. dump(self) -> None

Upcast from Space to LocalSpace

extend(self, nparam, n_in, n_out)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

factor_domain(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

factor_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

find_dim_by_name#

Overloaded function.

  1. find_dim_by_name(self, type: islpy._isl.dim_type, name: str) -> int

find_dim_by_name(self, type, name)

Parameters:
Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. find_dim_by_name(self, arg0: islpy._isl.dim_type, arg1: str, /) -> int

Upcast from Space to LocalSpace

flatten_domain#

Overloaded function.

  1. flatten_domain(self) -> object

flatten_domain(self)

Parameters:

self – Space

Returns:

Space

  1. flatten_domain(self) -> object

Upcast from Space to LocalSpace

flatten_range#

Overloaded function.

  1. flatten_range(self) -> object

flatten_range(self)

Parameters:

self – Space

Returns:

Space

  1. flatten_range(self) -> object

Upcast from Space to LocalSpace

from_domain#

Overloaded function.

  1. from_domain(self) -> object

from_domain(self)

Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. from_domain(self) -> object

Upcast from Space to LocalSpace

from_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ctx#

Overloaded function.

  1. get_ctx(self) -> object

get_ctx(self)

Parameters:

self – Space

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. get_ctx(self) -> object

Upcast from Space to LocalSpace

get_dim_id#

Overloaded function.

  1. get_dim_id(self, type: islpy._isl.dim_type, pos: int) -> object

get_dim_id(self, type, pos)

Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. get_dim_id(self, arg0: islpy._isl.dim_type, arg1: int, /) -> object

Upcast from Space to LocalSpace

get_dim_name#

Overloaded function.

  1. get_dim_name(self, type: islpy._isl.dim_type, pos: int) -> object

get_dim_name(self, type, pos)

Parameters:
Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. get_dim_name(self, arg0: islpy._isl.dim_type, arg1: int, /) -> object

Upcast from Space to LocalSpace

get_div#

Upcast from Space to LocalSpace

get_domain_tuple_id(self)#
Parameters:

self – Space

Returns:

Id

get_id_dict(dimtype=None)#

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

Parameters:

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

get_range_tuple_id(self)#
Parameters:

self – Space

Returns:

Id

get_space#

Upcast from Space to LocalSpace

get_tuple_id(self, type)#
Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_tuple_name(self, type)#
Parameters:
Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_var_dict(dimtype=None, ignore_out=False)#

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

Parameters:

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

has_dim_id#

Overloaded function.

  1. has_dim_id(self, type: islpy._isl.dim_type, pos: int) -> bool

has_dim_id(self, type, pos)

Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. has_dim_id(self, arg0: islpy._isl.dim_type, arg1: int, /) -> bool

Upcast from Space to LocalSpace

has_dim_name#

Overloaded function.

  1. has_dim_name(self, type: islpy._isl.dim_type, pos: int) -> bool

has_dim_name(self, type, pos)

Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. has_dim_name(self, arg0: islpy._isl.dim_type, arg1: int, /) -> bool

Upcast from Space to LocalSpace

has_domain_tuple_id(self)#
Parameters:

self – Space

Returns:

bool

has_equal_params(self, space2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

has_equal_tuples(self, space2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

has_range_tuple_id(self)#
Parameters:

self – Space

Returns:

bool

has_tuple_id(self, type)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

has_tuple_name(self, type)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

identity_multi_aff_on_domain(self)#
Parameters:

self – Space

Returns:

MultiAff

identity_multi_pw_aff_on_domain(self)#
Parameters:

self – Space

Returns:

MultiPwAff

identity_pw_multi_aff_on_domain(self)#
Parameters:

self – Space

Returns:

PwMultiAff

insert_dims#

Overloaded function.

  1. insert_dims(self, type: islpy._isl.dim_type, pos: int, n: int) -> object

insert_dims(self, type, pos, n)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. insert_dims(self, arg0: islpy._isl.dim_type, arg1: int, arg2: int, /) -> object

Upcast from Space to LocalSpace

intersect#

Upcast from Space to LocalSpace

is_domain(self, space2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equal#

Overloaded function.

  1. is_equal(self, space2: islpy._isl.Space) -> bool

is_equal(self, space2)

Parameters:
Returns:

bool

  1. is_equal(self, arg: islpy._isl.LocalSpace, /) -> bool

Upcast from Space to LocalSpace

is_map(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_params#

Overloaded function.

  1. is_params(self) -> bool

is_params(self)

Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. is_params(self) -> bool

Upcast from Space to LocalSpace

is_product(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_range(self, space2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_set#

Overloaded function.

  1. is_set(self) -> bool

is_set(self)

Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. is_set(self) -> bool

Upcast from Space to LocalSpace

is_wrapping(self)#
Parameters:

self – Space

Returns:

bool

join(self, right)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

lifting#

Upcast from Space to LocalSpace

map_from_domain_and_range(self, range)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

map_from_set(self)#
Parameters:

self – Space

Returns:

Space

match(self, type1, space2, type2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

move_dims(self, dst_type, dst_pos, src_type, src_pos, n)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

multi_aff(self, list)#
Parameters:
Returns:

MultiAff

multi_aff_on_domain_multi_val(self, mv)#
Parameters:
Returns:

MultiAff

Warning

This function is not part of the officially public isl API. Use at your own risk.

multi_id(self, list)#
Parameters:
Returns:

MultiId

multi_pw_aff(self, list)#
Parameters:
Returns:

MultiPwAff

multi_union_pw_aff(self, list)#
Parameters:
Returns:

MultiUnionPwAff

multi_val(self, list)#
Parameters:
Returns:

MultiVal

param_aff_on_domain_id(self, id)#
Parameters:
Returns:

Aff

Warning

This function is not part of the officially public isl API. Use at your own risk.

params(self)#
Parameters:

self – Space

Returns:

Space

params_alloc = <nanobind.nb_func object>#
product(self, right)#
Parameters:
Returns:

Space

range#

Overloaded function.

  1. range(self) -> object

range(self)

Parameters:

self – Space

Returns:

Space

  1. range(self) -> object

Upcast from Space to LocalSpace

range_curry(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_factor_domain(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_factor_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_is_wrapping(self)#
Parameters:

self – Space

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_map(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_map_multi_aff(self)#
Parameters:

self – Space

Returns:

MultiAff

range_map_pw_multi_aff(self)#
Parameters:

self – Space

Returns:

PwMultiAff

range_product(self, right)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_reverse(self)#
Parameters:

self – Space

Returns:

Space

range_wrapped_domain(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_wrapped_range(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

read_from_str = <nanobind.nb_func object>#
reset_tuple_id(self, type)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

reset_user(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

reverse(self)#
Parameters:

self – Space

Returns:

Space

set_alloc = <nanobind.nb_func object>#
set_dim_id#

Overloaded function.

  1. set_dim_id(self, type: islpy._isl.dim_type, pos: int, id: islpy._isl.Id) -> object

set_dim_id(self, type, pos, id)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. set_dim_id(self, arg0: islpy._isl.dim_type, arg1: int, arg2: islpy._isl.Id, /) -> object

Upcast from Space to LocalSpace

set_dim_name#

Overloaded function.

  1. set_dim_name(self, type: islpy._isl.dim_type, pos: int, name: str) -> object

set_dim_name(self, type, pos, name)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. set_dim_name(self, arg0: islpy._isl.dim_type, arg1: int, arg2: str, /) -> object

Upcast from Space to LocalSpace

set_domain_tuple_id(self, id)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_from_params#

Overloaded function.

  1. set_from_params(self) -> object

set_from_params(self)

Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. set_from_params(self) -> object

Upcast from Space to LocalSpace

set_range_tuple_id(self, id)#
Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_tuple_id#

Overloaded function.

  1. set_tuple_id(self, type: islpy._isl.dim_type, id: islpy._isl.Id) -> object

set_tuple_id(self, type, id)

Parameters:
Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

  1. set_tuple_id(self, arg0: islpy._isl.dim_type, arg1: islpy._isl.Id, /) -> object

Upcast from Space to LocalSpace

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

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

to_str(self)#
Parameters:

self – Space

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

tuple_is_equal(self, type1, space2, type2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

uncurry(self)#
Parameters:

self – Space

Returns:

Space

unit = <nanobind.nb_func object>#
universe_map(self)#
Parameters:

self – Space

Returns:

Map

universe_set(self)#
Parameters:

self – Space

Returns:

Set

unwrap(self)#
Parameters:

self – Space

Returns:

Space

wrap#

Overloaded function.

  1. wrap(self) -> object

wrap(self)

Parameters:

self – Space

Returns:

Space

  1. wrap(self) -> object

Upcast from Space to LocalSpace

wrapped_reverse(self)#
Parameters:

self – Space

Returns:

Space

zero_aff_on_domain(self)#
Parameters:

self – Space

Returns:

Aff

zero_multi_aff(self)#
Parameters:

self – Space

Returns:

MultiAff

zero_multi_pw_aff(self)#
Parameters:

self – Space

Returns:

MultiPwAff

zero_multi_union_pw_aff(self)#
Parameters:

self – Space

Returns:

MultiUnionPwAff

zero_multi_val(self)#
Parameters:

self – Space

Returns:

MultiVal

zip(self)#
Parameters:

self – Space

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

Local Space#

class islpy.LocalSpace#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__ne__(other)#

Return self!=value.

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

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

dim(self, type)#
Parameters:
Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

domain(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_dims(self, type, first, n)#
Parameters:
Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – LocalSpace

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

flatten_domain(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

flatten_range(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_domain(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_space = <nanobind.nb_func object>#
get_ctx(self)#
Parameters:

self – LocalSpace

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_dim_id(self, type, pos)#
Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_div(self, pos)#
Parameters:
Returns:

Aff

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_id_dict(dimtype=None)#

Return a dictionary mapping Id instances to tuples of (dim_type, index).

Parameters:

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

get_space(self)#
Parameters:

self – LocalSpace

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

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_ids(dimtype)#

Return a list of Id instances for dim_type dimtype.

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

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

intersect(self, ls2)#
Parameters:
Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equal(self, ls2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_params(self)#
Parameters:

self – LocalSpace

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_set(self)#
Parameters:

self – LocalSpace

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

lifting(self)#
Parameters:

self – LocalSpace

Returns:

BasicMap

Warning

This function is not part of the officially public isl API. Use at your own risk.

range(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_from_params(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

property space#

get_space(self) -> object

get_space(self)

Parameters:

self – LocalSpace

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

wrap(self)#
Parameters:

self – LocalSpace

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

Constraints#

class islpy.Constraint#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__ne__(other)#

Return self!=value.

alloc_equality = <nanobind.nb_func object>#
alloc_inequality = <nanobind.nb_func object>#
cmp_last_non_zero(self, c2)#
Parameters:
Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – Constraint

Returns:

Constraint

Warning

This function is not part of the officially public isl API. Use at your own risk.

dim(self, type)#
Parameters:
Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – Constraint

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

static eq_from_names(space, coefficients=None)#

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 = <nanobind.nb_func object>#
equality_from_aff = <nanobind.nb_func object>#
get_aff(self)#
Parameters:

self – Constraint

Returns:

Aff

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_bound(self, type, pos)#
Parameters:
Returns:

Aff

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_coefficient_val(self, type, pos)#
Parameters:
Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

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_val(self)#
Parameters:

self – Constraint

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ctx(self)#
Parameters:

self – Constraint

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_div(self, pos)#
Parameters:
Returns:

Aff

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_id_dict(dimtype=None)#

Return a dictionary mapping Id instances to tuples of (dim_type, index).

Parameters:

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

get_local_space(self)#
Parameters:

self – Constraint

Returns:

LocalSpace

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_space(self)#
Parameters:

self – Constraint

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

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_ids(dimtype)#

Return a list of Id instances for dim_type dimtype.

get_var_names(dimtype)#

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

static ineq_from_names(space, coefficients=None)#

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 = <nanobind.nb_func object>#
inequality_from_aff = <nanobind.nb_func object>#
involves_dims(self, type, first, n)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_div_constraint(self)#
Parameters:

self – Constraint

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equal(self, constraint2)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equality(self)#
Parameters:

self – Constraint

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_lower_bound(self, type, pos)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

negate(self)#
Parameters:

self – Constraint

Returns:

Constraint

Warning

This function is not part of the officially public isl API. Use at your own risk.

plain_cmp(self, c2)#
Parameters:
Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_coefficient_val(self, type, pos, v)#
Parameters:
Returns:

Constraint

Warning

This function is not part of the officially public isl API. Use at your own risk.

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_val(self, v)#
Parameters:
Returns:

Constraint

Warning

This function is not part of the officially public isl API. Use at your own risk.

property space#

get_space(self) -> object

get_space(self)

Parameters:

self – Constraint

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

to_list(self)#
Parameters:

self – Constraint

Returns:

ConstraintList

Warning

This function is not part of the officially public isl API. Use at your own risk.

Value#

class islpy.Val#
__eq__()#

eq(self, v2: object) -> bool

eq(self, v2)

Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

__hash__(self) int#

get_hash(self)

Parameters:

self – Val

Returns:

uint32_t

Warning

This function is not part of the officially public isl API. Use at your own risk.

__ne__()#

ne(self, v2: object) -> bool

ne(self, v2)

Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

to_python()#
abs(self)#
Parameters:

self – Val

Returns:

Val

abs_eq(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

add(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

ceil(self)#
Parameters:

self – Val

Returns:

Val

cmp_si(self, i)#
Parameters:
Returns:

int

copy(self)#
Parameters:

self – Val

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

div(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

dump(self)#
Parameters:

self – Val

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

eq(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

floor(self)#
Parameters:

self – Val

Returns:

Val

gcd(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

gcdext(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

tuple: (Val, x (Val), y (Val))

Warning

This function is not part of the officially public isl API. Use at your own risk.

ge(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

get_ctx(self)#
Parameters:

self – Val

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_d(self)#
Parameters:

self – Val

Returns:

double

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_den_val(self)#
Parameters:

self – Val

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_num_si(self)#
Parameters:

self – Val

Returns:

long

gt(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

infty = <nanobind.nb_func object>#
int_from_si = <nanobind.nb_func object>#
int_from_ui = <nanobind.nb_func object>#
inv(self)#
Parameters:

self – Val

Returns:

Val

is_divisible_by(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

is_infty(self)#
Parameters:

self – Val

Returns:

bool

is_int(self)#
Parameters:

self – Val

Returns:

bool

is_nan(self)#
Parameters:

self – Val

Returns:

bool

is_neg(self)#
Parameters:

self – Val

Returns:

bool

is_neginfty(self)#
Parameters:

self – Val

Returns:

bool

is_negone(self)#
Parameters:

self – Val

Returns:

bool

is_nonneg(self)#
Parameters:

self – Val

Returns:

bool

is_nonpos(self)#
Parameters:

self – Val

Returns:

bool

is_one(self)#
Parameters:

self – Val

Returns:

bool

is_pos(self)#
Parameters:

self – Val

Returns:

bool

is_rat(self)#
Parameters:

self – Val

Returns:

bool

is_zero(self)#
Parameters:

self – Val

Returns:

bool

le(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

lt(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

max(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

min(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

mod(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

mul(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

n_abs_num_chunks(self, size)#
Parameters:
Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

nan = <nanobind.nb_func object>#
ne(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

bool

neg(self)#
Parameters:

self – Val

Returns:

Val

neginfty = <nanobind.nb_func object>#
negone = <nanobind.nb_func object>#
one = <nanobind.nb_func object>#
pow2(self)#
Parameters:

self – Val

Returns:

Val

read_from_str = <nanobind.nb_func object>#
set_si(self, i)#
Parameters:
Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

sgn(self)#
Parameters:

self – Val

Returns:

int

sub(self, v2)#
Parameters:
  • self – Val

  • v2 – Val

Returns:

Val

to_list(self)#
Parameters:

self – Val

Returns:

ValList

to_str(self)#
Parameters:

self – Val

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

trunc(self)#
Parameters:

self – Val

Returns:

Val

two_exp(self)#
Parameters:

self – Val

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

zero = <nanobind.nb_func object>#

Multi-Value#

class islpy.MultiVal#
__eq__(value, /)#

Return self==value.

__hash__()#

Return hash(self).

__len__(self) int#

size(self)

Parameters:

self – MultiVal

Returns:

isl_size

__ne__(value, /)#

Return self!=value.

add(self, multi2)#
Parameters:
Returns:

MultiVal

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_val(self, v)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

align_params(self, model)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

dim(self, type)#
Parameters:
Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_dims(self, type, first, n)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – MultiVal

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

factor_range(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

flat_range_product(self, multi2)#
Parameters:
Returns:

MultiVal

flatten_range(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_range(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_val_list = <nanobind.nb_func object>#
get_at(self, pos)#
Parameters:
Returns:

Val

get_ctx(self)#
Parameters:

self – MultiVal

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_dim_id(self, type, pos)#
Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_domain_space(self)#
Parameters:

self – MultiVal

Returns:

Space

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_id_dict(dimtype=None)#

Return a dictionary mapping Id instances to tuples of (dim_type, index).

Parameters:

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

get_list(self)#
Parameters:

self – MultiVal

Returns:

ValList

get_range_tuple_id(self)#
Parameters:

self – MultiVal

Returns:

Id

get_space(self)#
Parameters:

self – MultiVal

Returns:

Space

get_tuple_id(self, type)#
Parameters:
Returns:

Id

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_tuple_name(self, type)#
Parameters:
Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_val(self, pos)#
Parameters:
Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

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_ids(dimtype)#

Return a list of Id instances for dim_type dimtype.

get_var_names(dimtype)#

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

has_range_tuple_id(self)#
Parameters:

self – MultiVal

Returns:

bool

has_tuple_id(self, type)#
Parameters:
Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

involves_nan(self)#
Parameters:

self – MultiVal

Returns:

bool

is_zero(self)#
Parameters:

self – MultiVal

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

max(self, multi2)#
Parameters:
Returns:

MultiVal

min(self, multi2)#
Parameters:
Returns:

MultiVal

mod_multi_val(self, mv)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

mod_val(self, v)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

neg(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

plain_is_equal(self, multi2)#
Parameters:
Returns:

bool

product(self, multi2)#
Parameters:
Returns:

MultiVal

project_domain_on_params(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_factor_domain(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_factor_range(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_is_wrapping(self)#
Parameters:

self – MultiVal

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

range_product(self, multi2)#
Parameters:
Returns:

MultiVal

range_splice(self, pos, multi2)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

read_from_str = <nanobind.nb_func object>#
reset_range_tuple_id(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

reset_tuple_id(self, type)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

reset_user(self)#
Parameters:

self – MultiVal

Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

scale_down_multi_val(self, mv)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

scale_down_val(self, v)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

scale_multi_val(self, mv)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

scale_val(self, v)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_at(self, pos, el)#
Parameters:
Returns:

MultiVal

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_range_tuple_id(self, id)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

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

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_val(self, pos, el)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

property space#

get_space(self) -> object

get_space(self)

Parameters:

self – MultiVal

Returns:

Space

splice(self, in_pos, out_pos, multi2)#
Parameters:
Returns:

MultiVal

Warning

This function is not part of the officially public isl API. Use at your own risk.

sub(self, multi2)#
Parameters:
Returns:

MultiVal

to_str(self)#
Parameters:

self – MultiVal

Returns:

string

Warning

This function is not part of the officially public isl API. Use at your own risk.

zero = <nanobind.nb_func object>#

Vector#

class islpy.Vec#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__len__(self) int#

size(self)

Parameters:

self – Vec

Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

__ne__(other)#

Return self!=value.

add(self, vec2)#
Parameters:
  • self – Vec

  • vec2 – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_els(self, n)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

alloc = <nanobind.nb_func object>#
ceil(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

clr(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

cmp_element(self, vec2, pos)#
Parameters:
  • self – Vec

  • vec2 – Vec

  • pos – int

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

concat(self, vec2)#
Parameters:
  • self – Vec

  • vec2 – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_els(self, pos, n)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – Vec

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

extend(self, size)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_ctx(self)#
Parameters:

self – Vec

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_element_val(self, pos)#
Parameters:
  • self – Vec

  • pos – int

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_els(self, pos, n)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_zero_els(self, pos, n)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equal(self, vec2)#
Parameters:
  • self – Vec

  • vec2 – Vec

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

mat_product(self, mat)#
Parameters:
  • self – Vec

  • mat – Mat

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

move_els(self, dst_col, src_col, n)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

neg(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

normalize(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_element_val(self, pos, v)#
Parameters:
  • self – Vec

  • pos – int

  • v – Val

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_val(self, v)#
Parameters:
  • self – Vec

  • v – Val

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

sort(self)#
Parameters:

self – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

zero = <nanobind.nb_func object>#
zero_extend(self, size)#
Parameters:
Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

Matrix#

class islpy.Mat#
__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__ne__(other)#

Return self!=value.

add_rows(self, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_zero_cols(self, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

add_zero_rows(self, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

aff_direct_sum(self, right)#
Parameters:
  • self – Mat

  • right – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

alloc = <nanobind.nb_func object>#
col_add(self, dst_col, src_col)#
Parameters:
  • self – Mat

  • dst_col – int

  • src_col – int

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

cols(self)#
Parameters:

self – Mat

Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

concat(self, bot)#
Parameters:
  • self – Mat

  • bot – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

copy(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

diagonal(self, mat2)#
Parameters:
  • self – Mat

  • mat2 – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_cols(self, col, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

drop_rows(self, row, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

dump(self)#
Parameters:

self – Mat

Returns:

None

Warning

This function is not part of the officially public isl API. Use at your own risk.

extend(self, n_row, n_col)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

from_row_vec = <nanobind.nb_func object>#
get_ctx(self)#
Parameters:

self – Mat

Returns:

Context

Warning

This function is not part of the officially public isl API. Use at your own risk.

get_element_val(self, row, col)#
Parameters:
  • self – Mat

  • row – int

  • col – int

Returns:

Val

Warning

This function is not part of the officially public isl API. Use at your own risk.

has_linearly_independent_rows(self, mat2)#
Parameters:
  • self – Mat

  • mat2 – Mat

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

identity = <nanobind.nb_func object>#
initial_non_zero_cols(self)#
Parameters:

self – Mat

Returns:

int

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_cols(self, col, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_rows(self, row, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_zero_cols(self, first, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

insert_zero_rows(self, row, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

inverse_product(self, right)#
Parameters:
  • self – Mat

  • right – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

is_equal(self, mat2)#
Parameters:
  • self – Mat

  • mat2 – Mat

Returns:

bool

Warning

This function is not part of the officially public isl API. Use at your own risk.

left_hermite(self, neg)#
Parameters:
  • self – Mat

  • neg – int

Returns:

tuple: (Mat, U (Mat), Q (Mat))

Warning

This function is not part of the officially public isl API. Use at your own risk.

lin_to_aff(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

move_cols(self, dst_col, src_col, n)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

normalize(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

normalize_row(self, row)#
Parameters:
  • self – Mat

  • row – int

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

product(self, right)#
Parameters:
  • self – Mat

  • right – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

rank(self)#
Parameters:

self – Mat

Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

right_inverse(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

right_kernel(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

row_basis(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

row_basis_extension(self, mat2)#
Parameters:
  • self – Mat

  • mat2 – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

rows(self)#
Parameters:

self – Mat

Returns:

isl_size

Warning

This function is not part of the officially public isl API. Use at your own risk.

set_element_val(self, row, col, v)#
Parameters:
  • self – Mat

  • row – int

  • col – int

  • v – Val

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

swap_cols(self, i, j)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

swap_rows(self, i, j)#
Parameters:
Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

transpose(self)#
Parameters:

self – Mat

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

unimodular_complete(self, row)#
Parameters:
  • self – Mat

  • row – int

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

vec_concat(self, bot)#
Parameters:
  • self – Mat

  • bot – Vec

Returns:

Mat

Warning

This function is not part of the officially public isl API. Use at your own risk.

vec_inverse_product(self, vec)#
Parameters:
  • self – Mat

  • vec – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

vec_product(self, vec)#
Parameters:
  • self – Mat

  • vec – Vec

Returns:

Vec

Warning

This function is not part of the officially public isl API. Use at your own risk.

Canonical Names for Internal Module#

class islpy._isl.Context#

See islpy.Context.

class islpy._isl.Id#

See islpy.Id.

class islpy._isl.MultiId#

See islpy.MultiId.

class islpy._isl.Space#

See islpy.Space.

class islpy._isl.LocalSpace#

See islpy.LocalSpace.

class islpy._isl.Constraint#

See islpy.Constraint.

class islpy._isl.Val#

See islpy.Val.

class islpy._isl.MultiVal#

See islpy.MultiVal.

class islpy._isl.Vec#

See islpy.Vec.

class islpy._isl.Mat#

See islpy.Mat.

class islpy._isl.BasicSet#

See islpy.BasicSet.

class islpy._isl.BasicMap#

See islpy.BasicMap.

class islpy._isl.Set#

See islpy.Set.

class islpy._isl.Map#

See islpy.Map.

class islpy._isl.UnionSet#

See islpy.UnionSet.

class islpy._isl.UnionMap#

See islpy.UnionMap.

class islpy._isl.Point#

See islpy.Point.

class islpy._isl.Vertex#

See islpy.Vertex.

class islpy._isl.Vertices#

See islpy.Vertices.

class islpy._isl.StrideInfo#

See islpy.StrideInfo.

class islpy._isl.Cell#

See islpy.Cell.

class islpy._isl.FixedBox#

See islpy.FixedBox.

class islpy._isl.Aff#

See islpy.Aff.

class islpy._isl.Div#

See islpy.Aff (not a typo!).

class islpy._isl.PwAff#

See islpy.PwAff.

class islpy._isl.UnionPwAff#

See islpy.UnionPwAff.

class islpy._isl.MultiUnionPwAff#

See islpy.MultiUnionPwAff.

class islpy._isl.MultiAff#

See islpy.MultiAff.

class islpy._isl.PwMultiAff#

See islpy.PwMultiAff.

class islpy._isl.MultiPwAff#

See islpy.MultiPwAff.

class islpy._isl.UnionPwMultiAff#

See islpy.UnionPwMultiAff.

class islpy._isl.Term#

See islpy.Term.

class islpy._isl.QPolynomial#

See islpy.QPolynomial.

class islpy._isl.PwQPolynomial#

See islpy.PwQPolynomial.

class islpy._isl.UnionPwQPolynomial#

See islpy.UnionPwQPolynomial.

class islpy._isl.QPolynomialFold#

See islpy.QPolynomialFold.

class islpy._isl.PwQPolynomialFold#

See islpy.PwQPolynomialFold.

class islpy._isl.UnionPwQPolynomialFold#

See islpy.UnionPwQPolynomialFold.