Generated on Thu Mar 22 10:39:55 2012 for Gecode by doxygen 1.6.3

Gecode::Int::BoolView Class Reference
[Integer views]

Boolean view for Boolean variables. More...

#include <view.hpp>

List of all members.

Related Functions

(Note that these are not member functions.)



template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const BoolView &x)
 Print Boolean view.

Domain status access



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

Constructors and initialization



 BoolView (void)
 Default constructor.
 BoolView (const BoolVar &y)
 Initialize from Boolean variable y.
 BoolView (BoolVarImp *y)
 Initialize from Boolean variable implementation y.

Value access



int min (void) const
 Return minimum of domain.
int max (void) const
 Return maximum of domain.
int med (void) const
 Return median of domain (greatest element not greater than the median).
int val (void) const
 Return assigned value (only if assigned).
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).

Domain tests



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

Boolean domain tests



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

Boolean assignment operations



ModEvent one (Space &home)
 Try to assign view to one.
ModEvent zero (Space &home)
 Try to assign view to zero.
ModEvent one_none (Space &home)
 Assign not yet assigned view to one.
ModEvent zero_none (Space &home)
 Assign not yet assigned view to zero.

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 le (Space &home, int n)
 Restrict domain values to be less than n.
ModEvent le (Space &home, double n)
 Restrict domain values to be less 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 gr (Space &home, int n)
 Restrict domain values to be greater than n.
ModEvent gr (Space &home, double n)
 Restrict domain values to be greater 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

Views 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 view on which the operation is invoked. In this case, the view 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.

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 bool zero (const Delta &d)
 Test whether a view has been assigned to zero.
static bool one (const Delta &d)
 Test whether a view has been assigned to one.

View-dependent propagator support



static ModEventDelta med (ModEvent me)
 Translate modification event me to modification event delta for view.

Test sharing between Boolean and negated Boolean views

NegBoolView



BoolTest bool_test (const BoolView &b0, const BoolView &b1)
 Test whether views b0 and b1 are the same.
BoolTest bool_test (const BoolView &b0, const NegBoolView &b1)
 Test whether views b0 and b1 are complementary.
BoolTest bool_test (const NegBoolView &b0, const BoolView &b1)
 Test whether views b0 and b1 are complementary.
BoolTest bool_test (const NegBoolView &b0, const NegBoolView &b1)
 Test whether views b0 and b1 are the same.

Detailed Description

Boolean view for Boolean variables.

Provides convenient and efficient operations for Boolean views.

Definition at line 1315 of file view.hpp.


Constructor & Destructor Documentation

Gecode::Int::BoolView::BoolView ( void   )  [inline]

Default constructor.

Definition at line 45 of file bool.hpp.

Gecode::Int::BoolView::BoolView ( const BoolVar y  )  [inline]

Initialize from Boolean variable y.

Definition at line 47 of file bool.hpp.

Gecode::Int::BoolView::BoolView ( BoolVarImp y  )  [inline]

Initialize from Boolean variable implementation y.

Definition at line 50 of file bool.hpp.


Member Function Documentation

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

Return current domain status.

Definition at line 58 of file bool.hpp.

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

Return minimum of domain.

Definition at line 62 of file bool.hpp.

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

Return maximum of domain.

Definition at line 66 of file bool.hpp.

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

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

Definition at line 70 of file bool.hpp.

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

Return assigned value (only if assigned).

Definition at line 74 of file bool.hpp.

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

Return size (cardinality) of domain.

Definition at line 79 of file bool.hpp.

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

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

Definition at line 83 of file bool.hpp.

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

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

Definition at line 87 of file bool.hpp.

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

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

Definition at line 91 of file bool.hpp.

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

Test whether domain is a range.

Definition at line 101 of file bool.hpp.

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

Test whether n is contained in domain.

Definition at line 105 of file bool.hpp.

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

Test whether n is contained in domain.

Definition at line 109 of file bool.hpp.

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

Test whether view is assigned to be zero.

Definition at line 214 of file bool.hpp.

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

Test whether view is assigned to be one.

Definition at line 218 of file bool.hpp.

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

Test whether view is not yet assigned.

Definition at line 222 of file bool.hpp.

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

Try to assign view to one.

Definition at line 245 of file bool.hpp.

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

Try to assign view to zero.

Definition at line 241 of file bool.hpp.

ModEvent Gecode::Int::BoolView::one_none ( Space home  )  [inline]

Assign not yet assigned view to one.

Definition at line 236 of file bool.hpp.

ModEvent Gecode::Int::BoolView::zero_none ( Space home  )  [inline]

Assign not yet assigned view to zero.

Definition at line 232 of file bool.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 119 of file bool.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 123 of file bool.hpp.

ModEvent Gecode::Int::BoolView::le ( Space home,
int  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 128 of file bool.hpp.

ModEvent Gecode::Int::BoolView::le ( Space home,
double  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 132 of file bool.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 137 of file bool.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 141 of file bool.hpp.

ModEvent Gecode::Int::BoolView::gr ( Space home,
int  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 146 of file bool.hpp.

ModEvent Gecode::Int::BoolView::gr ( Space home,
double  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 150 of file bool.hpp.

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

Restrict domain values to be different from n.

Definition at line 155 of file bool.hpp.

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

Restrict domain values to be different from n.

Definition at line 159 of file bool.hpp.

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

Restrict domain values to be equal to n.

Definition at line 164 of file bool.hpp.

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

Restrict domain values to be equal to n.

Definition at line 168 of file bool.hpp.

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

Replace domain by ranges described by i.

Definition at line 179 of file bool.hpp.

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

Intersect domain with ranges described by i.

Definition at line 184 of file bool.hpp.

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

Remove from domain the ranges described by i.

Definition at line 189 of file bool.hpp.

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

Replace domain by values described by i.

Definition at line 194 of file bool.hpp.

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

Intersect domain with values described by i.

Definition at line 199 of file bool.hpp.

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

Remove from domain the values described by i.

Definition at line 204 of file bool.hpp.

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

Return minimum value just pruned.

Definition at line 255 of file bool.hpp.

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

Return maximum value just pruned.

Definition at line 259 of file bool.hpp.

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

Test whether arbitrary values got pruned.

Definition at line 263 of file bool.hpp.

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

Test whether a view has been assigned to zero.

Definition at line 267 of file bool.hpp.

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

Test whether a view has been assigned to one.

Definition at line 271 of file bool.hpp.

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

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::VarImpView< BoolVar >.

Definition at line 278 of file bool.hpp.


Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const BoolView x 
) [related]

Print Boolean view.

Definition at line 142 of file print.hpp.

BoolTest bool_test ( const BoolView b0,
const BoolView b1 
) [related]

Test whether views b0 and b1 are the same.

Definition at line 45 of file bool-test.hpp.

BoolTest bool_test ( const BoolView b0,
const NegBoolView b1 
) [related]

Test whether views b0 and b1 are complementary.

Definition at line 49 of file bool-test.hpp.

BoolTest bool_test ( const NegBoolView b0,
const BoolView b1 
) [related]

Test whether views b0 and b1 are complementary.

Definition at line 53 of file bool-test.hpp.

BoolTest bool_test ( const NegBoolView b0,
const NegBoolView b1 
) [related]

Test whether views b0 and b1 are the same.

Definition at line 57 of file bool-test.hpp.


Member Data Documentation

How many bits does the status have.

Definition at line 1332 of file view.hpp.

Status of domain assigned to zero.

Definition at line 1334 of file view.hpp.

Status of domain assigned to one.

Definition at line 1336 of file view.hpp.

Status of domain not yet assigned.

Definition at line 1338 of file view.hpp.


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