infrared.libinfrared.FiniteDomain Class Reference

A finite domain of a variable. More...

Public Member Functions
	__init__ (self, *args)
	Construct finite domain.
	lb (self)
	Lower bound.
	ub (self)
	Upper bound.
	size (self)
	Domain size.
	empty (self)
	Test for empty domain.
	contains (self, val)
	Test for membership.
	undet (self, val)
	Value to flag 'undetermined'.

Detailed Description

A finite domain of a variable.

Defines lower and upper bound of a contiguous domain for a finite domain variable.

Interfaces the C++ class ired::FiniteDomain. Supports (deep) copying.

Constructor & Destructor Documentation

__init__()

infrared.libinfrared.FiniteDomain.__init__	(		self,
		*	args
	)

Construct finite domain.

Parameters

args	size or (lb,ub) construct as 0..size-1 or lb..ub, resp.

Member Function Documentation

contains()

infrared.libinfrared.FiniteDomain.contains	(		self,
			val
	)

Test for membership.

Note

‘in’ works as alias

Returns true, if val is in the domain

empty()

infrared.libinfrared.FiniteDomain.empty

(

self

)

Test for empty domain.

Returns true, if empty

lb()

infrared.libinfrared.FiniteDomain.lb

(

self

)

Lower bound.

Returns lower bound

size()

infrared.libinfrared.FiniteDomain.size

(

self

)

Domain size.

Returns size ub-lb+1 or zero if empty

ub()

infrared.libinfrared.FiniteDomain.ub

(

self

)

Upper bound.

Returns upper bound

undet()

infrared.libinfrared.FiniteDomain.undet	(		self,
			val
	)

Value to flag 'undetermined'.

   for internal use

Returns undet value specific for this domain

---

The documentation for this class was generated from the following file:

• src/infrared/libinfrared.py