Generated on Mon Aug 25 11:35:49 2008 for Gecode by doxygen 1.5.6

Gecode::Int::BoolVarImp Class Reference
[Other available functionality]

List of all members.


Detailed Description

Boolean variable implementation.

Definition at line 503 of file var-imp.icc.


Domain status access

static const int BITS = 2
 How many bits does the status have.
static const BoolStatus ZERO = 0
 Status of domain assigned to zero.
static const BoolStatus ONE = 3
 Status of domain assigned to one.
static const BoolStatus NONE = 2
 Status of domain not yet assigned.
BoolStatus status (void) const
 Return current domain status.

Value access

int min (void) const
 Return minimum of domain.
int max (void) const
 Return maximum of domain.
int val (void) const
 Return assigned value (only if assigned).
int med (void) const
 Return median of domain.
unsigned int size (void) const
 Return size (cardinality) of domain.
unsigned int width (void) const
 Return width of domain (distance between maximum and minimum).
unsigned int regret_min (void) const
 Return regret of domain minimum (distance to next larger value).
unsigned int regret_max (void) const
 Return regret of domain maximum (distance to next smaller value).

Boolean domain tests

bool zero (void) const
 Test whether variable is assigned to zero.
bool one (void) const
 Test whether variable is assigned to one.
bool none (void) const
 Test whether variable is not yet assigned.

Domain tests

bool range (void) const
 Test whether domain is a range.
bool assigned (void) const
 Test whether variable is assigned.
bool in (int n) const
 Test whether n is contained in domain.
bool in (double n) const
 Test whether n is contained in domain.

Domain update by value

ModEvent lq (Space *home, int n)
 Restrict domain values to be less or equal than n.
ModEvent lq (Space *home, double n)
 Restrict domain values to be less or equal than n.
ModEvent gq (Space *home, int n)
 Restrict domain values to be greater or equal than n.
ModEvent gq (Space *home, double n)
 Restrict domain values to be greater or equal than n.
ModEvent nq (Space *home, int n)
 Restrict domain values to be different from n.
ModEvent nq (Space *home, double n)
 Restrict domain values to be different from n.
ModEvent eq (Space *home, int n)
 Restrict domain values to be equal to n.
ModEvent eq (Space *home, double n)
 Restrict domain values to be equal to n.

Domain update by iterator

Variable domains can be both updated by range and value iterators. Value iterators do not need to be strict in that the same value is allowed to occur more than once in the iterated sequence.

The argument depends must be true, if the iterator passed as argument depends on the variable implementation on which the operation is invoked. In this case, the variable implementation is only updated after the iterator has been consumed. Otherwise, the domain might be updated concurrently while following the iterator.

template<class I>
ModEvent narrow_r (Space *home, I &i, bool depends=true)
 Replace domain by ranges described by i.
template<class I>
ModEvent inter_r (Space *home, I &i, bool depends=true)
 Intersect domain with ranges described by i.
template<class I>
ModEvent minus_r (Space *home, I &i, bool depends=true)
 Remove from domain the ranges described by i.
template<class I>
ModEvent narrow_v (Space *home, I &i, bool depends=true)
 Replace domain by values described by i.
template<class I>
ModEvent inter_v (Space *home, I &i, bool depends=true)
 Intersect domain with values described by i.
template<class I>
ModEvent minus_v (Space *home, I &i, bool depends=true)
 Remove from domain the values described by i.

Boolean update operations

ModEvent zero (Space *home)
 Assign variable to zero.
ModEvent one (Space *home)
 Assign variable to one.
ModEvent zero_none (Space *home)
 Assign unassigned variable to zero.
ModEvent one_none (Space *home)
 Assign unassigned variable to one.

Dependencies

void subscribe (Space *home, Propagator *p, PropCond pc, bool process=true)
 Subscribe propagator p to variable with propagation condition pc.
void cancel (Space *home, Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc.
void subscribe (Space *home, Advisor *a)
 Subscribe advisor a to variable.
void cancel (Space *home, Advisor *a)
 Cancel subscription of advisor a.

Support for delta information for advisors

int min (const Delta *d) const
 Return minimum value just pruned.
int max (const Delta *d) const
 Return maximum value just pruned.
bool any (const Delta *d) const
 Test whether arbitrary values got pruned.
static ModEvent modevent (const Delta *d)
 Return modification event.

Cloning

BoolVarImpcopy (Space *home, bool share)
 Return copy of this variable.

Reflection

Reflection::Argspec (const Space *home, Reflection::VarMap &m) const
 Return specification.
static VarImpBasecreate (Space *home, Reflection::VarSpec &spec)
 Create variable implementation from specification.
static void constrain (Space *home, VarImpBase *v, Reflection::VarSpec &spec)
 Constrain variable implementation using specification.

Variable implementation-dependent propagator support

static void schedule (Space *home, Propagator *p, ModEvent me)
 Schedule propagator p with modification event me.
static ModEventDelta med (ModEvent me)
 Translate modification event me to modification event delta for view.

Public Member Functions

 BoolVarImp (Space *home, int min, int max)
 Initialize with range domain.

Constructor & Destructor Documentation

Gecode::Int::BoolVarImp::BoolVarImp ( Space home,
int  min,
int  max 
) [inline]

Initialize with range domain.

Definition at line 50 of file bool.icc.


Member Function Documentation

BoolStatus Gecode::Int::BoolVarImp::status ( void   )  const [inline]

Return current domain status.

Definition at line 62 of file bool.icc.

int Gecode::Int::BoolVarImp::min ( void   )  const [inline]

Return minimum of domain.

Definition at line 66 of file bool.icc.

int Gecode::Int::BoolVarImp::max ( void   )  const [inline]

Return maximum of domain.

Definition at line 70 of file bool.icc.

int Gecode::Int::BoolVarImp::val ( void   )  const [inline]

Return assigned value (only if assigned).

Definition at line 79 of file bool.icc.

int Gecode::Int::BoolVarImp::med ( void   )  const [inline]

Return median of domain.

Definition at line 74 of file bool.icc.

unsigned int Gecode::Int::BoolVarImp::size ( void   )  const [inline]

Return size (cardinality) of domain.

Definition at line 100 of file bool.icc.

unsigned int Gecode::Int::BoolVarImp::width ( void   )  const [inline]

Return width of domain (distance between maximum and minimum).

Definition at line 95 of file bool.icc.

unsigned int Gecode::Int::BoolVarImp::regret_min ( void   )  const [inline]

Return regret of domain minimum (distance to next larger value).

Definition at line 105 of file bool.icc.

unsigned int Gecode::Int::BoolVarImp::regret_max ( void   )  const [inline]

Return regret of domain maximum (distance to next smaller value).

Definition at line 109 of file bool.icc.

bool Gecode::Int::BoolVarImp::zero ( void   )  const [inline]

Test whether variable is assigned to zero.

Definition at line 135 of file bool.icc.

bool Gecode::Int::BoolVarImp::one ( void   )  const [inline]

Test whether variable is assigned to one.

Definition at line 139 of file bool.icc.

bool Gecode::Int::BoolVarImp::none ( void   )  const [inline]

Test whether variable is not yet assigned.

Definition at line 143 of file bool.icc.

bool Gecode::Int::BoolVarImp::range ( void   )  const [inline]

Test whether domain is a range.

Definition at line 85 of file bool.icc.

bool Gecode::Int::BoolVarImp::assigned ( void   )  const [inline]

Test whether variable is assigned.

Definition at line 89 of file bool.icc.

bool Gecode::Int::BoolVarImp::in ( int  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 121 of file bool.icc.

bool Gecode::Int::BoolVarImp::in ( double  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 125 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::lq ( Space home,
int  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 207 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::lq ( Space home,
double  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 213 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::gq ( Space home,
int  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 193 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::gq ( Space home,
double  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 199 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::nq ( Space home,
int  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 233 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::nq ( Space home,
double  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 238 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::eq ( Space home,
int  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 221 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::eq ( Space home,
double  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 226 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::narrow_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Replace domain by ranges described by i.

Definition at line 271 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::inter_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Intersect domain with ranges described by i.

Definition at line 292 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::minus_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Remove from domain the ranges described by i.

Definition at line 309 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::narrow_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Replace domain by values described by i.

Definition at line 327 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::inter_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Intersect domain with values described by i.

Definition at line 346 of file bool.icc.

template<class I>
ModEvent Gecode::Int::BoolVarImp::minus_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Remove from domain the values described by i.

Definition at line 365 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::zero ( Space home  )  [inline]

Assign variable to zero.

Definition at line 175 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::one ( Space home  )  [inline]

Assign variable to one.

Definition at line 181 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::zero_none ( Space home  ) 

Assign unassigned variable to zero.

Definition at line 55 of file bool.cc.

ModEvent Gecode::Int::BoolVarImp::one_none ( Space home  ) 

Assign unassigned variable to one.

Definition at line 46 of file bool.cc.

void Gecode::Int::BoolVarImp::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  process = true 
) [inline]

Subscribe propagator p to variable with propagation condition pc.

In case process is false, the propagator is just subscribed but not processed for execution (this must be used when creating subscriptions during propagation).

The propagation condition pc can be a propagation condition for integer variables, which will be mapped to PC_BOOL_VAL.

Definition at line 390 of file bool.icc.

void Gecode::Int::BoolVarImp::cancel ( Space home,
Propagator p,
PropCond  pc 
) [inline]

Cancel subscription of propagator p with propagation condition pc.

The propagation condition pc can be a propagation condition for integer variables, which will be mapped to PC_BOOL_VAL.

Definition at line 397 of file bool.icc.

void Gecode::Int::BoolVarImp::subscribe ( Space home,
Advisor a 
) [inline]

Subscribe advisor a to variable.

Definition at line 402 of file bool.icc.

void Gecode::Int::BoolVarImp::cancel ( Space home,
Advisor a 
) [inline]

Cancel subscription of advisor a.

Definition at line 406 of file bool.icc.

void Gecode::Int::BoolVarImp::schedule ( Space home,
Propagator p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

The modfication event me can be a modification event for integer variables, however me will be ignored if it is not ME_INT_VAL (or ME_BOOL_VAL).

Definition at line 411 of file bool.icc.

ModEventDelta Gecode::Int::BoolVarImp::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 417 of file bool.icc.

ModEvent Gecode::Int::BoolVarImp::modevent ( const Delta d  )  [inline, static]

Return modification event.

Definition at line 153 of file bool.icc.

int Gecode::Int::BoolVarImp::min ( const Delta d  )  const [inline]

Return minimum value just pruned.

Definition at line 157 of file bool.icc.

int Gecode::Int::BoolVarImp::max ( const Delta d  )  const [inline]

Return maximum value just pruned.

Definition at line 161 of file bool.icc.

bool Gecode::Int::BoolVarImp::any ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned.

Definition at line 165 of file bool.icc.

BoolVarImp * Gecode::Int::BoolVarImp::copy ( Space home,
bool  share 
) [inline]

Return copy of this variable.

Definition at line 253 of file bool.icc.

Reflection::Arg * Gecode::Int::BoolVarImp::spec ( const Space home,
Reflection::VarMap m 
) const

Return specification.

Definition at line 65 of file bool.cc.

VarImpBase * Gecode::Int::BoolVarImp::create ( Space home,
Reflection::VarSpec spec 
) [static]

Create variable implementation from specification.

Definition at line 77 of file bool.cc.

void Gecode::Int::BoolVarImp::constrain ( Space home,
VarImpBase v,
Reflection::VarSpec spec 
) [static]

Constrain variable implementation using specification.

Definition at line 89 of file bool.cc.


Member Data Documentation

const int Gecode::Int::BoolVarImp::BITS = 2 [static]

How many bits does the status have.

Definition at line 531 of file var-imp.icc.

Status of domain assigned to zero.

Definition at line 533 of file var-imp.icc.

Status of domain assigned to one.

Definition at line 535 of file var-imp.icc.

Status of domain not yet assigned.

Definition at line 537 of file var-imp.icc.


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