Gecode::Int::BoolView Class Reference
Functionality by programming task » Programming actors » Programming integer actors » Integer views

Boolean view for Boolean variables. More...

`#include <view.hpp>`

## 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 (long long int 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, long long int 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, long long int 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, long long int 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, long long int 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, 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

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.
unsigned int | width (const Delta &d) const
| Return width of values 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.

## View comparison

template<class Char, class Traits>
std::basic_ostream< Char, Traits > & | operator<< (std::basic_ostream< Char, Traits > &os, const BoolView &x)
| Print Boolean 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.

## Additional Inherited Members

Public Types inherited from Gecode::VarImpView< BoolVar >
typedef BoolVar | VarType
| The variable type corresponding to the view.
typedef BoolVar::VarImpType | VarImpType
| The variable implementation type corresponding to the view.
unsigned int | degree (void) const
| Return degree (number of subscribed propagators and advisors).
double | afc (void) const
| Return accumulated failure count.
bool | assigned (void) const
| Test whether view is assigned.
void | subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
| Subscribe propagator p with propagation condition pc to view.
void | cancel (Space &home, Propagator &p, PropCond pc)
| Cancel subscription of propagator p with propagation condition pc to view.
void | reschedule (Space &home, Propagator &p, PropCond pc)
| Re-schedule propagator p with propagation condition pc.
void | update (Space &home, VarImpView< BoolVar > &y)
| Update this view to be a clone of view y.
bool | operator< (const VarImpView &y) const
| Whether this view comes before view y (arbitray order).
static bool | varderived (void)
| Return whether this view is derived from a VarImpView.
static void | schedule (Space &home, Propagator &p, ModEvent me)
| Schedule propagator p with modification event me.
static ModEvent | me (const ModEventDelta &med)
| Return modification event for view type in med.
static ModEventDelta | med (ModEvent me)
| Translate modification event me to modification event delta for view.
static ModEvent | modevent (const Delta &d)
| Return modification event.
Protected Member Functions inherited from Gecode::VarImpView< BoolVar >
| VarImpView (void)
| Default constructor.
void | varimp (VarImpType *y)
| Set variable implementation to y.
Protected Attributes inherited from Gecode::VarImpView< BoolVar >
VarImpType * | x
| Pointer to variable implementation.

## Detailed Description

Boolean view for Boolean variables.

Provides convenient and efficient operations for Boolean views.

Definition at line 1380 of file view.hpp.

## Constructor & Destructor Documentation

## BoolView() [1/3]

Gecode::Int::BoolView::BoolView | ( | void |  | ) |

inline

Default constructor.

Definition at line 45 of file bool.hpp.

## BoolView() [2/3]

Gecode::Int::BoolView::BoolView | ( | const BoolVar & | y | ) |

inline

Initialize from Boolean variable y.

Definition at line 47 of file bool.hpp.

## BoolView() [3/3]

Gecode::Int::BoolView::BoolView | ( | BoolVarImp * | y | ) |

inline

Initialize from Boolean variable implementation y.

Definition at line 50 of file bool.hpp.

## Member Function Documentation

## status()

BoolStatus Gecode::Int::BoolView::status | ( | void |  | ) | const

inline

Return current domain status.

Definition at line 58 of file bool.hpp.

## min() [1/2]

int Gecode::Int::BoolView::min | ( | void |  | ) | const

inline

Return minimum of domain.

Definition at line 62 of file bool.hpp.

## max() [1/2]

int Gecode::Int::BoolView::max | ( | void |  | ) | const

inline

Return maximum of domain.

Definition at line 66 of file bool.hpp.

## med() [1/2]

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.

## val()

int Gecode::Int::BoolView::val | ( | void |  | ) | const

inline

Return assigned value (only if assigned).

Definition at line 74 of file bool.hpp.

## size()

unsigned int Gecode::Int::BoolView::size | ( | void |  | ) | const

inline

Return size (cardinality) of domain.

Definition at line 85 of file bool.hpp.

## width() [1/2]

unsigned int Gecode::Int::BoolView::width | ( | void |  | ) | const

inline

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

Definition at line 89 of file bool.hpp.

## regret_min()

unsigned int Gecode::Int::BoolView::regret_min | ( | void |  | ) | const

inline

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

Definition at line 93 of file bool.hpp.

## regret_max()

unsigned int Gecode::Int::BoolView::regret_max | ( | void |  | ) | const

inline

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

Definition at line 97 of file bool.hpp.

## range()

bool Gecode::Int::BoolView::range | ( | void |  | ) | const

inline

Test whether domain is a range.

Definition at line 107 of file bool.hpp.

## in() [1/2]

bool Gecode::Int::BoolView::in | ( | int | n | ) | const

inline

Test whether n is contained in domain.

Definition at line 111 of file bool.hpp.

## in() [2/2]

bool Gecode::Int::BoolView::in | ( | long long int | n | ) | const

inline

Test whether n is contained in domain.

Definition at line 115 of file bool.hpp.

## zero() [1/3]

bool Gecode::Int::BoolView::zero | ( | void |  | ) | const

inline

Test whether view is assigned to be zero.

Definition at line 220 of file bool.hpp.

## one() [1/3]

bool Gecode::Int::BoolView::one | ( | void |  | ) | const

inline

Test whether view is assigned to be one.

Definition at line 224 of file bool.hpp.

## none()

bool Gecode::Int::BoolView::none | ( | void |  | ) | const

inline

Test whether view is not yet assigned.

Definition at line 228 of file bool.hpp.

## one() [2/3]

ModEvent Gecode::Int::BoolView::one | ( | Space & | home | ) |

inline

Try to assign view to one.

Definition at line 251 of file bool.hpp.

## zero() [2/3]

ModEvent Gecode::Int::BoolView::zero | ( | Space & | home | ) |

inline

Try to assign view to zero.

Definition at line 247 of file bool.hpp.

## one_none()

ModEvent Gecode::Int::BoolView::one_none | ( | Space & | home | ) |

inline

Assign not yet assigned view to one.

Definition at line 242 of file bool.hpp.

## zero_none()

ModEvent Gecode::Int::BoolView::zero_none | ( | Space & | home | ) |

inline

Assign not yet assigned view to zero.

Definition at line 238 of file bool.hpp.

## lq() [1/2]

ModEvent Gecode::Int::BoolView::lq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be less or equal than n.

Definition at line 125 of file bool.hpp.

## lq() [2/2]

ModEvent Gecode::Int::BoolView::lq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be less or equal than n.

Definition at line 129 of file bool.hpp.

## le() [1/2]

ModEvent Gecode::Int::BoolView::le | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be less than n.

Definition at line 134 of file bool.hpp.

## le() [2/2]

ModEvent Gecode::Int::BoolView::le | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be less than n.

Definition at line 138 of file bool.hpp.

## gq() [1/2]

ModEvent Gecode::Int::BoolView::gq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be greater or equal than n.

Definition at line 143 of file bool.hpp.

## gq() [2/2]

ModEvent Gecode::Int::BoolView::gq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be greater or equal than n.

Definition at line 147 of file bool.hpp.

## gr() [1/2]

ModEvent Gecode::Int::BoolView::gr | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be greater than n.

Definition at line 152 of file bool.hpp.

## gr() [2/2]

ModEvent Gecode::Int::BoolView::gr | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be greater than n.

Definition at line 156 of file bool.hpp.

## nq() [1/2]

ModEvent Gecode::Int::BoolView::nq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be different from n.

Definition at line 161 of file bool.hpp.

## nq() [2/2]

ModEvent Gecode::Int::BoolView::nq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be different from n.

Definition at line 165 of file bool.hpp.

## eq() [1/2]

ModEvent Gecode::Int::BoolView::eq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be equal to n.

Definition at line 170 of file bool.hpp.

## eq() [2/2]

ModEvent Gecode::Int::BoolView::eq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be equal to n.

Definition at line 174 of file bool.hpp.

## narrow_r()

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

## inter_r()

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

## minus_r()

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

## narrow_v()

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

## inter_v()

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

## minus_v()

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

## min() [2/2]

int Gecode::Int::BoolView::min | ( | const Delta & | d | ) | const

inline

Return minimum value just pruned.

Definition at line 261 of file bool.hpp.

## max() [2/2]

int Gecode::Int::BoolView::max | ( | const Delta & | d | ) | const

inline

Return maximum value just pruned.

Definition at line 265 of file bool.hpp.

## width() [2/2]

unsigned int Gecode::Int::BoolView::width | ( | const Delta & | d | ) | const

inline

Return width of values just pruned.

Definition at line 269 of file bool.hpp.

## any()

bool Gecode::Int::BoolView::any | ( | const Delta & | d | ) | const

inline

Test whether arbitrary values got pruned.

Definition at line 273 of file bool.hpp.

## zero() [3/3]

bool Gecode::Int::BoolView::zero | ( | const Delta & | d | ) |

inline static

Test whether a view has been assigned to zero.

Definition at line 277 of file bool.hpp.

## one() [3/3]

bool Gecode::Int::BoolView::one | ( | const Delta & | d | ) |

inline static

Test whether a view has been assigned to one.

Definition at line 281 of file bool.hpp.

## med() [2/2]

ModEventDelta Gecode::Int::BoolView::med | ( | ModEvent | me | ) |

inline static

Translate modification event me to modification event delta for view.

Definition at line 288 of file bool.hpp.

## Friends And Related Symbol Documentation

## operator<<()

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 67 of file print.hpp.

## bool_test() [1/4]

BoolTest bool_test | ( | const BoolView & | b0,
|  | const BoolView & | b1 )

related

Test whether views b0 and b1 are the same.

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

## bool_test() [2/4]

BoolTest bool_test | ( | const BoolView & | b0,
|  | const NegBoolView & | b1 )

related

Test whether views b0 and b1 are complementary.

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

## bool_test() [3/4]

BoolTest bool_test | ( | const NegBoolView & | b0,
|  | const BoolView & | b1 )

related

Test whether views b0 and b1 are complementary.

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

## bool_test() [4/4]

BoolTest bool_test | ( | const NegBoolView & | b0,
|  | const NegBoolView & | b1 )

related

Test whether views b0 and b1 are the same.

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

## Member Data Documentation

## BITS

const int Gecode::Int::BoolView::BITS = BoolVarImp::BITS

static

How many bits does the status have.

Definition at line 1397 of file view.hpp.

## ZERO

const BoolStatus Gecode::Int::BoolView::ZERO = BoolVarImp::ZERO

static

Status of domain assigned to zero.

Definition at line 1399 of file view.hpp.

## ONE

const BoolStatus Gecode::Int::BoolView::ONE = BoolVarImp::ONE

static

Status of domain assigned to one.

Definition at line 1401 of file view.hpp.

## NONE

const BoolStatus Gecode::Int::BoolView::NONE = BoolVarImp::NONE

static

Status of domain not yet assigned.

Definition at line 1403 of file view.hpp.

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

- gecode/int/view.hpp
- gecode/int/view/bool.hpp