Reference: Set-Like Objects

Point

class namedisl.Point(_obj: Point, space: Space)

space: Space

is_void

static zero_on_domain(other: BasicSet | Set | BasicMap | Map) → Point

static zero(space: Space) → Point

classmethod from_dict(space: Space, value_dict: Mapping[str, int | Val])

get_coordinate(name: str)

with_coordinate(name: str, value: Val | int)

as_set() → Set

__str__()

Return str(self).

__repr__() → str

Return repr(self).

Quasiconvex set

class namedisl.BasicSet(_obj: IslObjectT_co, space: Space, _isl_names_ok: bool = False)

add_constraint(cns: Constraint, /) → BasicSet

var_affs

Returns a lazily-evaluated mapping from dimension names (or zero) to PwAffs.

Note

Lazy evaluation means you do not pay for the creation of unused dimensions.

as_set() → Set

constraints()

is_bounded() → bool

params()

sample_point()

is_empty() → bool

plain_is_empty() → bool

plain_is_universe() → bool

classmethod universe(space: Space) → Self

classmethod empty(space: Space) → Self

universe_like_me() → Self

empty_like_me() → Self

fix_dim(name: str, value: Val | int) → Self

eliminate(names: Collection[str], *, cache: Cache | None = None) → Self

Keeps the dimensions, but eliminates constraints.

project_out(names: Collection[str], *, cache: Cache | None = None) → Self

Eliminates the dimensions and constraints.

project_out_except(names_to_keep: Collection[str], *, dim_type: DimType | Literal['all'], cache: Cache | None = None) → Self

Eliminates the dimensions and constraints within dim_type except the ones named.

gist(context: Self) → Self

detect_equalities() → Self

remove_divs() → Self

compute_divs() → Self

__and__(other: Self) → Self

__or__(other: Self) → Self

Return self|value.

__sub__(other: Self) → Self

equals(other: Self) → bool

__lt__(other: Self) → bool

Return self<value.

__le__(other: Self) → bool

Return self<=value.

space: Space

active_dim_types: ClassVar[frozenset[DimType]] = frozenset({DimType.param, DimType.out})

add_dims(dt: DimType, names_to_add: Collection[str], /) → Self

move_dims(names: Collection[str], dest_dt: DimType) → Self

rename_dims(renaming: Iterable[tuple[str, str]]) → Self

as_isl() → IslObjectT_co

involves_dims(names: Collection[str]) → bool

True if self involves any of the given dimensions.

__hash__() → int

Return hash(self).

__eq__(other: object) → bool

This is intended to be cheap and strict, suitable mainly for hashing. Some subclasses (e.g. namedisl.Set) may provide a different, ‘mathematically exact’ notion of equality as a different method that is more expensive to check for.

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

namedisl.make_basic_set(src: str, ctx: Context | None = None) → BasicSet

namedisl.make_basic_set(src: BasicSet) → BasicSet

General set

class namedisl.Set(_obj: IslObjectT_co, space: Space, _isl_names_ok: bool = False)

complement() → Set

simple_hull()

convex_hull() → BasicSet

basic_sets() → list[BasicSet]

dim_max(name: str, *, cache: Cache | None = None) → PwAff

dim_min(name: str, *, cache: Cache | None = None) → PwAff

stride_info(name: str, *, cache: Cache | None = None)

is_box() → bool

card(*, cache: Cache | None = None) → PwQPolynomial

Available if the underlying islpy was built with barvinok. (But do note the license implications.)

var_affs

Returns a lazily-evaluated mapping from dimension names (or zero) to Affs.

Note

Lazy evaluation means you do not pay for the creation of unused dimensions.

var_pw_affs

Returns a lazily-evaluated mapping from dimension names (or zero) to PwAffs.

Note

Lazy evaluation means you do not pay for the creation of unused dimensions.

as_map(in_names: Collection[str]) → Map

as_basic() → BasicSet

Will only succeed if self consists of a single piece. Try coalesce() if not.

is_bounded() → bool

params()

sample_point()

equate_dims(names: Sequence[tuple[str, str]]) → Self

as_pw_multi_aff() → PwMultiAff

remove_redundancies()

coalesce() → Self

make_disjoint() → Self

is_empty() → bool

plain_is_empty() → bool

plain_is_universe() → bool

classmethod universe(space: Space) → Self

classmethod empty(space: Space) → Self

universe_like_me() → Self

empty_like_me() → Self

fix_dim(name: str, value: Val | int) → Self

eliminate(names: Collection[str], *, cache: Cache | None = None) → Self

Keeps the dimensions, but eliminates constraints.

project_out(names: Collection[str], *, cache: Cache | None = None) → Self

Eliminates the dimensions and constraints.

project_out_except(names_to_keep: Collection[str], *, dim_type: DimType | Literal['all'], cache: Cache | None = None) → Self

Eliminates the dimensions and constraints within dim_type except the ones named.

gist(context: Self) → Self

detect_equalities() → Self

remove_divs() → Self

compute_divs() → Self

__and__(other: Self) → Self

__or__(other: Self) → Self

Return self|value.

__sub__(other: Self) → Self

equals(other: Self) → bool

__lt__(other: Self) → bool

Return self<value.

__le__(other: Self) → bool

Return self<=value.

space: Space

active_dim_types: ClassVar[frozenset[DimType]] = frozenset({DimType.param, DimType.out})

add_dims(dt: DimType, names_to_add: Collection[str], /) → Self

move_dims(names: Collection[str], dest_dt: DimType) → Self

rename_dims(renaming: Iterable[tuple[str, str]]) → Self

as_isl() → IslObjectT_co

involves_dims(names: Collection[str]) → bool

True if self involves any of the given dimensions.

__hash__() → int

Return hash(self).

__eq__(other: object) → bool

This is intended to be cheap and strict, suitable mainly for hashing. Some subclasses (e.g. namedisl.Set) may provide a different, ‘mathematically exact’ notion of equality as a different method that is more expensive to check for.

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

namedisl.make_set(src: str, ctx: Context | None = None) → Set

namedisl.make_set(src: Set) → Set

class namedisl.StrideInfo(_obj: StrideInfo)

stride

offset

Quasiconvex map

class namedisl.BasicMap(_obj: IslObjectT_co, space: Space, _isl_names_ok: bool = False)

domain() → BasicSet

range() → BasicSet

intersect_domain(domain: BasicSet) → Self

intersect_range(range: BasicSet) → Self

constraints()

as_map() → Map

reverse() → Self

is_empty() → bool

plain_is_empty() → bool

plain_is_universe() → bool

classmethod universe(space: Space) → Self

classmethod empty(space: Space) → Self

universe_like_me() → Self

empty_like_me() → Self

fix_dim(name: str, value: Val | int) → Self

eliminate(names: Collection[str], *, cache: Cache | None = None) → Self

Keeps the dimensions, but eliminates constraints.

project_out(names: Collection[str], *, cache: Cache | None = None) → Self

Eliminates the dimensions and constraints.

project_out_except(names_to_keep: Collection[str], *, dim_type: DimType | Literal['all'], cache: Cache | None = None) → Self

Eliminates the dimensions and constraints within dim_type except the ones named.

gist(context: Self) → Self

detect_equalities() → Self

remove_divs() → Self

compute_divs() → Self

__and__(other: Self) → Self

__or__(other: Self) → Self

Return self|value.

__sub__(other: Self) → Self

equals(other: Self) → bool

__lt__(other: Self) → bool

Return self<value.

__le__(other: Self) → bool

Return self<=value.

space: Space

active_dim_types: ClassVar[frozenset[DimType]] = frozenset({DimType.param, DimType.in_, DimType.out})

add_dims(dt: DimType, names_to_add: Collection[str], /) → Self

move_dims(names: Collection[str], dest_dt: DimType) → Self

rename_dims(renaming: Iterable[tuple[str, str]]) → Self

as_isl() → IslObjectT_co

involves_dims(names: Collection[str]) → bool

True if self involves any of the given dimensions.

__hash__() → int

Return hash(self).

__eq__(other: object) → bool

This is intended to be cheap and strict, suitable mainly for hashing. Some subclasses (e.g. namedisl.Set) may provide a different, ‘mathematically exact’ notion of equality as a different method that is more expensive to check for.

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

namedisl.make_basic_map(src: str, ctx: Context | None = None) → BasicMap

namedisl.make_basic_map(src: BasicMap) → BasicMap

General map

class namedisl.Map(_obj: IslObjectT_co, space: Space, _isl_names_ok: bool = False)

is_bijective() → bool

is_injective() → bool

is_single_valued() → bool

lexmin() → Map

complement() → Map

simple_hull()

convex_hull() → BasicMap

basic_maps() → list[BasicMap]

domain() → Set

range() → Set

intersect_domain(domain: Set) → Self

intersect_range(range: Set) → Self

apply_range(other: Self) → Self

apply_domain(other: Self) → Self

as_basic() → BasicMap

Will only succeed if self consists of a single piece. Try coalesce() if not.

as_set() → Set

domain_var_pw_affs

Returns a lazily-evaluated mapping from dimension names (or zero) to PwAffs for the domain variables of self

Note

Lazy evaluation means you do not pay for the creation of unused dimensions.

range_var_pw_affs

Returns a lazily-evaluated mapping from dimension names (or zero) to PwAffs for the domain variables of self

Note

Lazy evaluation means you do not pay for the creation of unused dimensions.

reverse() → Self

equate_dims(names: Sequence[tuple[str, str]]) → Self

as_pw_multi_aff() → PwMultiAff

remove_redundancies()

coalesce() → Self

make_disjoint() → Self

is_empty() → bool

plain_is_empty() → bool

plain_is_universe() → bool

classmethod universe(space: Space) → Self

classmethod empty(space: Space) → Self

universe_like_me() → Self

empty_like_me() → Self

fix_dim(name: str, value: Val | int) → Self

eliminate(names: Collection[str], *, cache: Cache | None = None) → Self

Keeps the dimensions, but eliminates constraints.

project_out(names: Collection[str], *, cache: Cache | None = None) → Self

Eliminates the dimensions and constraints.

project_out_except(names_to_keep: Collection[str], *, dim_type: DimType | Literal['all'], cache: Cache | None = None) → Self

Eliminates the dimensions and constraints within dim_type except the ones named.

gist(context: Self) → Self

detect_equalities() → Self

remove_divs() → Self

compute_divs() → Self

__and__(other: Self) → Self

__or__(other: Self) → Self

Return self|value.

__sub__(other: Self) → Self

equals(other: Self) → bool

__lt__(other: Self) → bool

Return self<value.

__le__(other: Self) → bool

Return self<=value.

space: Space

active_dim_types: ClassVar[frozenset[DimType]] = frozenset({DimType.param, DimType.in_, DimType.out})

add_dims(dt: DimType, names_to_add: Collection[str], /) → Self

move_dims(names: Collection[str], dest_dt: DimType) → Self

rename_dims(renaming: Iterable[tuple[str, str]]) → Self

as_isl() → IslObjectT_co

involves_dims(names: Collection[str]) → bool

True if self involves any of the given dimensions.

__hash__() → int

Return hash(self).

__eq__(other: object) → bool

This is intended to be cheap and strict, suitable mainly for hashing. Some subclasses (e.g. namedisl.Set) may provide a different, ‘mathematically exact’ notion of equality as a different method that is more expensive to check for.

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

namedisl.make_map(src: str, ctx: Context | None = None) → Map

namedisl.make_map(src: Map) → Map