Generated on Sat Feb 7 2015 02:01:44 for Gecode by doxygen 1.8.9.1

Offset integer view. More...

#include <view.hpp>

Protected Attributes

int c
 Offset. More...
 
- Protected Attributes inherited from Gecode::DerivedView< IntView >
IntView x
 View from which this view is derived. More...
 

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 OffsetView &x)
 Print integer offset view. More...
 

View comparison

bool same (const OffsetView &x, const OffsetView &y)
 Test whether views x and y are the same. More...
 
bool before (const OffsetView &x, const OffsetView &y)
 Test whether view x comes before y (arbitrary order) More...
 

Constructors and initialization

 OffsetView (void)
 Default constructor. More...
 
 OffsetView (const IntView &y, int c)
 Initialize with integer view y and offset c. More...
 

Value access

int offset (void) const
 Return offset. More...
 
void offset (int n)
 Change offset to n. More...
 
int min (void) const
 Return minimum of domain. More...
 
int max (void) const
 Return maximum of domain. More...
 
int med (void) const
 Return median of domain (greatest element not greater than the median) More...
 
int val (void) const
 Return assigned value (only if assigned) More...
 
unsigned int size (void) const
 Return size (cardinality) of domain. More...
 
unsigned int width (void) const
 Return width of domain (distance between maximum and minimum) More...
 
unsigned int regret_min (void) const
 Return regret of domain minimum (distance to next larger value) More...
 
unsigned int regret_max (void) const
 Return regret of domain maximum (distance to next smaller value) More...
 

Domain tests

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

Domain update by value

ModEvent lq (Space &home, int n)
 Restrict domain values to be less or equal than n. More...
 
ModEvent lq (Space &home, long long int n)
 Restrict domain values to be less or equal than n. More...
 
ModEvent le (Space &home, int n)
 Restrict domain values to be less than n. More...
 
ModEvent le (Space &home, long long int n)
 Restrict domain values to be less than n. More...
 
ModEvent gq (Space &home, int n)
 Restrict domain values to be greater or equal than n. More...
 
ModEvent gq (Space &home, long long int n)
 Restrict domain values to be greater or equal than n. More...
 
ModEvent gr (Space &home, int n)
 Restrict domain values to be greater than n. More...
 
ModEvent gr (Space &home, long long int n)
 Restrict domain values to be greater than n. More...
 
ModEvent nq (Space &home, int n)
 Restrict domain values to be different from n. More...
 
ModEvent nq (Space &home, long long int n)
 Restrict domain values to be different from n. More...
 
ModEvent eq (Space &home, int n)
 Restrict domain values to be equal to n. More...
 
ModEvent eq (Space &home, long long int n)
 Restrict domain values to be equal to n. More...
 

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. More...
 
template<class I >
ModEvent inter_r (Space &home, I &i, bool depends=true)
 Intersect domain with ranges described by i. More...
 
template<class I >
ModEvent minus_r (Space &home, I &i, bool depends=true)
 Remove from domain the ranges described by i. More...
 
template<class I >
ModEvent narrow_v (Space &home, I &i, bool depends=true)
 Replace domain by values described by i. More...
 
template<class I >
ModEvent inter_v (Space &home, I &i, bool depends=true)
 Intersect domain with values described by i. More...
 
template<class I >
ModEvent minus_v (Space &home, I &i, bool depends=true)
 Remove from domain the values described by i. More...
 

View-dependent propagator support

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

Delta information for advisors

int min (const Delta &d) const
 Return minimum value just pruned. More...
 
int max (const Delta &d) const
 Return maximum value just pruned. More...
 
bool any (const Delta &d) const
 Test whether arbitrary values got pruned. More...
 

Cloning

void update (Space &home, bool share, OffsetView &y)
 Update this view to be a clone of view y. More...
 

Additional Inherited Members

- Public Types inherited from Gecode::DerivedView< IntView >
typedef IntView::VarImpType VarImpType
 The variable implementation type belonging to the View. More...
 
typedef IntView::VarType VarType
 The variable type belonging to the View. More...
 
- Public Member Functions inherited from Gecode::DerivedView< IntView >
VarImpTypevarimp (void) const
 Return variable implementation of view. More...
 
IntView base (void) const
 Return view from which this view is derived. More...
 
unsigned int degree (void) const
 Return degree (number of subscribed propagators) More...
 
double afc (const Space &home) const
 Return accumulated failure count. More...
 
bool assigned (void) const
 Test whether view is assigned. More...
 
void subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
 Subscribe propagator p with propagation condition pc to view. More...
 
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view. More...
 
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view. More...
 
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a. More...
 
void update (Space &home, bool share, DerivedView< IntView > &y)
 Update this view to be a clone of view y. More...
 
- Static Public Member Functions inherited from Gecode::DerivedView< IntView >
static bool varderived (void)
 Return whether this view is derived from a VarImpView. More...
 
static void schedule (Space &home, Propagator &p, ModEvent me)
 Schedule propagator p with modification event me. More...
 
static ModEvent me (const ModEventDelta &med)
 Return modification event for view type in med. More...
 
static ModEventDelta med (ModEvent)
 Translate modification event me to modification event delta for view. More...
 
static ModEvent modevent (const Delta &d)
 Return modification event. More...
 
- Protected Member Functions inherited from Gecode::DerivedView< IntView >
 DerivedView (void)
 Default constructor. More...
 
 DerivedView (const IntView &y)
 Initialize with view y. More...
 

Detailed Description

Offset integer view.

An offset integer view $o$ for an integer view $x$ and an integer $c$ provides operations such that $o$ behaves as $x+c$.

Definition at line 422 of file view.hpp.

Constructor & Destructor Documentation

Gecode::Int::OffsetView::OffsetView ( void  )
inline

Default constructor.

Definition at line 45 of file offset.hpp.

Gecode::Int::OffsetView::OffsetView ( const IntView y,
int  c 
)
inline

Initialize with integer view y and offset c.

Definition at line 47 of file offset.hpp.

Member Function Documentation

int Gecode::Int::OffsetView::offset ( void  ) const
inline

Return offset.

Definition at line 56 of file offset.hpp.

void Gecode::Int::OffsetView::offset ( int  n)
inline

Change offset to n.

Definition at line 60 of file offset.hpp.

int Gecode::Int::OffsetView::min ( void  ) const
inline

Return minimum of domain.

Definition at line 64 of file offset.hpp.

int Gecode::Int::OffsetView::max ( void  ) const
inline

Return maximum of domain.

Definition at line 68 of file offset.hpp.

int Gecode::Int::OffsetView::med ( void  ) const
inline

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

Definition at line 72 of file offset.hpp.

int Gecode::Int::OffsetView::val ( void  ) const
inline

Return assigned value (only if assigned)

Definition at line 76 of file offset.hpp.

unsigned int Gecode::Int::OffsetView::size ( void  ) const
inline

Return size (cardinality) of domain.

Definition at line 85 of file offset.hpp.

unsigned int Gecode::Int::OffsetView::width ( void  ) const
inline

Return width of domain (distance between maximum and minimum)

Definition at line 81 of file offset.hpp.

unsigned int Gecode::Int::OffsetView::regret_min ( void  ) const
inline

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

Definition at line 89 of file offset.hpp.

unsigned int Gecode::Int::OffsetView::regret_max ( void  ) const
inline

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

Definition at line 93 of file offset.hpp.

bool Gecode::Int::OffsetView::range ( void  ) const
inline

Test whether domain is a range.

Definition at line 102 of file offset.hpp.

bool Gecode::Int::OffsetView::in ( int  n) const
inline

Test whether n is contained in domain.

Definition at line 106 of file offset.hpp.

bool Gecode::Int::OffsetView::in ( long long int  n) const
inline

Test whether n is contained in domain.

Definition at line 110 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::lq ( Space home,
int  n 
)
inline

Restrict domain values to be less or equal than n.

Definition at line 121 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::lq ( Space home,
long long int  n 
)
inline

Restrict domain values to be less or equal than n.

Definition at line 125 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::le ( Space home,
int  n 
)
inline

Restrict domain values to be less than n.

Definition at line 130 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::le ( Space home,
long long int  n 
)
inline

Restrict domain values to be less than n.

Definition at line 134 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gq ( Space home,
int  n 
)
inline

Restrict domain values to be greater or equal than n.

Definition at line 139 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gq ( Space home,
long long int  n 
)
inline

Restrict domain values to be greater or equal than n.

Definition at line 143 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gr ( Space home,
int  n 
)
inline

Restrict domain values to be greater than n.

Definition at line 148 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gr ( Space home,
long long int  n 
)
inline

Restrict domain values to be greater than n.

Definition at line 152 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::nq ( Space home,
int  n 
)
inline

Restrict domain values to be different from n.

Definition at line 157 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::nq ( Space home,
long long int  n 
)
inline

Restrict domain values to be different from n.

Definition at line 161 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::eq ( Space home,
int  n 
)
inline

Restrict domain values to be equal to n.

Definition at line 166 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::eq ( Space home,
long long int  n 
)
inline

Restrict domain values to be equal to n.

Definition at line 170 of file offset.hpp.

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

Replace domain by ranges described by i.

Definition at line 181 of file offset.hpp.

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

Intersect domain with ranges described by i.

Definition at line 187 of file offset.hpp.

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

Remove from domain the ranges described by i.

Definition at line 193 of file offset.hpp.

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

Replace domain by values described by i.

Definition at line 199 of file offset.hpp.

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

Intersect domain with values described by i.

Definition at line 205 of file offset.hpp.

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

Remove from domain the values described by i.

Definition at line 211 of file offset.hpp.

ModEventDelta Gecode::Int::OffsetView::med ( ModEvent  me)
inlinestatic

Translate modification event me to modification event delta for view.

Definition at line 223 of file offset.hpp.

int Gecode::Int::OffsetView::min ( const Delta d) const
inline

Return minimum value just pruned.

Definition at line 233 of file offset.hpp.

int Gecode::Int::OffsetView::max ( const Delta d) const
inline

Return maximum value just pruned.

Definition at line 237 of file offset.hpp.

bool Gecode::Int::OffsetView::any ( const Delta d) const
inline

Test whether arbitrary values got pruned.

Definition at line 241 of file offset.hpp.

void Gecode::Int::OffsetView::update ( Space home,
bool  share,
OffsetView y 
)
inline

Update this view to be a clone of view y.

Definition at line 252 of file offset.hpp.

Friends And Related Function Documentation

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

Print integer offset view.

Definition at line 107 of file print.hpp.

bool same ( const OffsetView x,
const OffsetView y 
)
related

Test whether views x and y are the same.

Definition at line 297 of file offset.hpp.

bool before ( const OffsetView x,
const OffsetView y 
)
related

Test whether view x comes before y (arbitrary order)

Definition at line 301 of file offset.hpp.

Member Data Documentation

int Gecode::Int::OffsetView::c
protected

Offset.

Definition at line 425 of file view.hpp.


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