Generated on Thu Apr 11 13:59:56 2019 for Gecode by doxygen 1.6.3
Gecode::Int::BoolVarImp

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

Boolean variable implementation. More...

#include <var-imp.hpp>

List of all members.

Public Member Functions

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

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 (greatest element not greater than the median).
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 (long long int 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, long long int 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, long long int 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, long long int 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, long long int 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 schedule=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, bool fail)
 Subscribe advisor a to variable.
void cancel (Space &home, Advisor &a, bool fail)
 Cancel subscription of advisor a.

Variable implementation-dependent propagator support



void reschedule (Space &home, Propagator &p, PropCond pc)
 Re-schedule propagator p.
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.

Cloning



BoolVarImp * copy (Space &home)
 Return copy of this variable.

Support for delta information for advisors



static ModEvent modevent (const Delta &d)
 Return modification event.
static int min (const Delta &d)
 Return minimum value just pruned.
static int max (const Delta &d)
 Return maximum value just pruned.
static unsigned int width (const Delta &d)
 Return width of values just pruned.
static bool any (const Delta &d)
 Test whether arbitrary values got pruned.
static bool zero (const Delta &d)
 Test whether a variable has been assigned to zero.
static bool one (const Delta &d)
 Test whether a variable has been assigned to one.

Detailed Description

Boolean variable implementation.

Definition at line 491 of file var-imp.hpp.

Constructor & Destructor Documentation

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

Initialize with range domain.

Definition at line 46 of file bool.hpp.

Member Function Documentation

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

Return current domain status.

Definition at line 58 of file bool.hpp.

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

Return minimum of domain.

Definition at line 62 of file bool.hpp.

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

Return maximum of domain.

Definition at line 66 of file bool.hpp.

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

Return assigned value (only if assigned).

Definition at line 75 of file bool.hpp.

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

Return median of domain (greatest element not greater than the median).

Definition at line 70 of file bool.hpp.

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

Return size (cardinality) of domain.

Definition at line 96 of file bool.hpp.

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

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

Definition at line 91 of file bool.hpp.

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

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

Definition at line 101 of file bool.hpp.

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

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

Definition at line 105 of file bool.hpp.

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

Test whether variable is assigned to zero.

Definition at line 131 of file bool.hpp.

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

Test whether variable is assigned to one.

Definition at line 135 of file bool.hpp.

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

Test whether variable is not yet assigned.

Definition at line 139 of file bool.hpp.

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

Test whether domain is a range.

Definition at line 81 of file bool.hpp.

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

Test whether variable is assigned.

Definition at line 85 of file bool.hpp.

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

Test whether n is contained in domain.

Definition at line 117 of file bool.hpp.

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

Test whether n is contained in domain.

Definition at line 121 of file bool.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 214 of file bool.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 220 of file bool.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 201 of file bool.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 207 of file bool.hpp.

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

Restrict domain values to be different from n.

Definition at line 238 of file bool.hpp.

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

Restrict domain values to be different from n.

Definition at line 243 of file bool.hpp.

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

Restrict domain values to be equal to n.

Definition at line 227 of file bool.hpp.

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

Restrict domain values to be equal to n.

Definition at line 232 of file bool.hpp.

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 276 of file bool.hpp.

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 297 of file bool.hpp.

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 314 of file bool.hpp.

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 332 of file bool.hpp.

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 351 of file bool.hpp.

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 370 of file bool.hpp.

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

Assign variable to zero.

Definition at line 183 of file bool.hpp.

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

Assign variable to one.

Definition at line 189 of file bool.hpp.

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

Assign unassigned variable to zero.

Definition at line 51 of file bool.cpp.

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

Assign unassigned variable to one.

Definition at line 42 of file bool.cpp.

void Gecode::Int::BoolVarImp::subscribe ( Space &  home,
Propagator &  p,
PropCond  pc,
bool  schedule = true 
)

Subscribe propagator p to variable with propagation condition pc.

In case schedule is false, the propagator is just subscribed but not scheduled 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 60 of file bool.cpp.

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.

Reimplemented from Gecode::VarImp< Gecode::Int::BoolVarImpConf >.

Definition at line 395 of file bool.hpp.

void Gecode::Int::BoolVarImp::subscribe ( Space &  home,
Advisor &  a,
bool  fail 
)

Subscribe advisor a to variable.

The advisor a is only subscribed if assigned is false.

If fail is true, the advisor a is also run when a variable operation triggers failure. This feature is undocumented.

Definition at line 73 of file bool.cpp.

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

Cancel subscription of advisor a.

Reimplemented from Gecode::VarImp< Gecode::Int::BoolVarImpConf >.

Definition at line 400 of file bool.hpp.

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).

Reimplemented from Gecode::Int::BoolVarImpBase.

Definition at line 405 of file bool.hpp.

void Gecode::Int::BoolVarImp::reschedule ( Space &  home,
Propagator &  p,
PropCond  pc 
)

Re-schedule propagator p.

Definition at line 68 of file bool.cpp.

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

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::VarImp< Gecode::Int::BoolVarImpConf >.

Definition at line 410 of file bool.hpp.

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

Return modification event.

Reimplemented from Gecode::VarImp< Gecode::Int::BoolVarImpConf >.

Definition at line 149 of file bool.hpp.

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

Return minimum value just pruned.

Definition at line 153 of file bool.hpp.

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

Return maximum value just pruned.

Definition at line 157 of file bool.hpp.

unsigned int Gecode::Int::BoolVarImp::width ( const Delta &  d  )  [inline, static]

Return width of values just pruned.

Definition at line 161 of file bool.hpp.

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

Test whether arbitrary values got pruned.

Definition at line 165 of file bool.hpp.

bool Gecode::Int::BoolVarImp::zero ( const Delta &  d  )  [inline, static]

Test whether a variable has been assigned to zero.

Definition at line 169 of file bool.hpp.

bool Gecode::Int::BoolVarImp::one ( const Delta &  d  )  [inline, static]

Test whether a variable has been assigned to one.

Definition at line 173 of file bool.hpp.

BoolVarImp * Gecode::Int::BoolVarImp::copy ( Space &  home  )  [inline]

Return copy of this variable.

Definition at line 258 of file bool.hpp.

Member Data Documentation

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

How many bits does the status have.

Definition at line 519 of file var-imp.hpp.

const BoolStatus Gecode::Int::BoolVarImp::ZERO = 0 [static]

Status of domain assigned to zero.

Definition at line 521 of file var-imp.hpp.

const BoolStatus Gecode::Int::BoolVarImp::ONE = 3 [static]

Status of domain assigned to one.

Definition at line 523 of file var-imp.hpp.

const BoolStatus Gecode::Int::BoolVarImp::NONE = 2 [static]

Status of domain not yet assigned.

Definition at line 525 of file var-imp.hpp.

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