Generated on Tue Feb 11 2025 17:33:26 for Gecode by doxygen 1.12.0

Offset integer view. More...

#include <view.hpp>

Protected Attributes

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

View comparison

typedef ScaleView< int, unsigned int > IntScaleView
 Integer-precision integer scale view.
 
typedef ScaleView< long long int, unsigned long long int > LLongScaleView
 Long long-precision integer scale view.
 
template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< (std::basic_ostream< Char, Traits > &os, const OffsetView &x)
 Print integer offset view.
 
bool operator== (const OffsetView &x, const OffsetView &y)
 Test whether views x and y are the same.
 
bool operator!= (const OffsetView &x, const OffsetView &y)
 Test whether views x and y are not the same.
 
template<class View >
View & operator() (View &x)
 Integer-precision integer scale view.
 
template<class View >
void update (const NoOffset &)
 Integer-precision integer scale view.
 
template<class View >
int offset (void) const
 Integer-precision integer scale view.
 
 Offset (int off)
 Integer-precision integer scale view.
 
void update (const Offset &o)
 Integer-precision integer scale view.
 
int offset (void) const
 Integer-precision integer scale view.
 
OffsetView operator() (IntView &x)
 Integer-precision integer scale view.
 

Constructors and initialization

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

Value access

int offset (void) const
 Return offset.
 
void offset (int n)
 Change offset to n.
 
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.
 

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.
 

Cloning

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

Ordering

bool operator< (const OffsetView &y) const
 Whether this view comes before view y (arbitray order)
 

View-dependent propagator support

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

Additional Inherited Members

- Public Types inherited from Gecode::DerivedView< IntView >
typedef IntView::VarImpType VarImpType
 The variable implementation type belonging to the View.
 
typedef IntView::VarType VarType
 The variable type belonging to the View.
 
- Public Member Functions inherited from Gecode::DerivedView< IntView >
 DerivedView (const IntView &y)
 Initialize with view y.
 
VarImpTypevarimp (void) const
 Return variable implementation of view.
 
IntView base (void) const
 Return view from which this view is derived.
 
unsigned int degree (void) const
 Return degree (number of subscribed propagators)
 
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 subscribe (Space &home, Advisor &a, bool fail=false)
 Subscribe advisor a to view.
 
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view.
 
void cancel (Space &home, Advisor &a, bool fail=false)
 Cancel subscription of advisor a.
 
void reschedule (Space &home, Propagator &p, PropCond pc)
 Re-schedule propagator p with propagation condition pc.
 
void update (Space &home, DerivedView< IntView > &y)
 Update this view to be a clone of view y.
 
bool operator< (const DerivedView< IntView > &y) const
 Whether this view comes before view y (arbitray order)
 
- Static Public Member Functions inherited from Gecode::DerivedView< IntView >
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)
 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::DerivedView< IntView >
 DerivedView (void)
 Default constructor.
 

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 443 of file view.hpp.

Constructor & Destructor Documentation

◆ OffsetView() [1/2]

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

Default constructor.

Definition at line 45 of file offset.hpp.

◆ OffsetView() [2/2]

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

◆ offset() [1/2]

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

Return offset.

Definition at line 56 of file offset.hpp.

◆ offset() [2/2]

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

Change offset to n.

Definition at line 60 of file offset.hpp.

◆ min() [1/2]

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

Return minimum of domain.

Definition at line 64 of file offset.hpp.

◆ max() [1/2]

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

Return maximum of domain.

Definition at line 68 of file offset.hpp.

◆ med() [1/2]

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.

◆ val()

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

Return assigned value (only if assigned)

Definition at line 76 of file offset.hpp.

◆ size()

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

Return size (cardinality) of domain.

Definition at line 91 of file offset.hpp.

◆ width() [1/2]

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

Return width of domain (distance between maximum and minimum)

Definition at line 87 of file offset.hpp.

◆ regret_min()

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

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

Definition at line 95 of file offset.hpp.

◆ regret_max()

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

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

Definition at line 99 of file offset.hpp.

◆ range()

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

Test whether domain is a range.

Definition at line 108 of file offset.hpp.

◆ in() [1/2]

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

Test whether n is contained in domain.

Definition at line 112 of file offset.hpp.

◆ in() [2/2]

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

Test whether n is contained in domain.

Definition at line 116 of file offset.hpp.

◆ lq() [1/2]

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

Restrict domain values to be less or equal than n.

Definition at line 127 of file offset.hpp.

◆ lq() [2/2]

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 131 of file offset.hpp.

◆ le() [1/2]

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

Restrict domain values to be less than n.

Definition at line 136 of file offset.hpp.

◆ le() [2/2]

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

Restrict domain values to be less than n.

Definition at line 140 of file offset.hpp.

◆ gq() [1/2]

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

Restrict domain values to be greater or equal than n.

Definition at line 145 of file offset.hpp.

◆ gq() [2/2]

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 149 of file offset.hpp.

◆ gr() [1/2]

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

Restrict domain values to be greater than n.

Definition at line 154 of file offset.hpp.

◆ gr() [2/2]

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

Restrict domain values to be greater than n.

Definition at line 158 of file offset.hpp.

◆ nq() [1/2]

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

Restrict domain values to be different from n.

Definition at line 163 of file offset.hpp.

◆ nq() [2/2]

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

Restrict domain values to be different from n.

Definition at line 167 of file offset.hpp.

◆ eq() [1/2]

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

Restrict domain values to be equal to n.

Definition at line 172 of file offset.hpp.

◆ eq() [2/2]

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

Restrict domain values to be equal to n.

Definition at line 176 of file offset.hpp.

◆ narrow_r()

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 187 of file offset.hpp.

◆ inter_r()

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 193 of file offset.hpp.

◆ minus_r()

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 199 of file offset.hpp.

◆ narrow_v()

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

◆ inter_v()

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 211 of file offset.hpp.

◆ minus_v()

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 217 of file offset.hpp.

◆ med() [2/2]

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

Translate modification event me to modification event delta for view.

Definition at line 229 of file offset.hpp.

◆ min() [2/2]

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

Return minimum value just pruned.

Definition at line 239 of file offset.hpp.

◆ max() [2/2]

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

Return maximum value just pruned.

Definition at line 243 of file offset.hpp.

◆ width() [2/2]

unsigned int Gecode::Int::OffsetView::width ( const Delta & d) const
inline

Return width of values just pruned.

Definition at line 247 of file offset.hpp.

◆ any()

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

Test whether arbitrary values got pruned.

Definition at line 251 of file offset.hpp.

◆ update()

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

Update this view to be a clone of view y.

Definition at line 262 of file offset.hpp.

◆ operator<()

bool Gecode::Int::OffsetView::operator< ( const OffsetView & y) const
inline

Whether this view comes before view y (arbitray order)

Definition at line 272 of file offset.hpp.

Member Data Documentation

◆ c

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

Offset.

Definition at line 446 of file view.hpp.


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