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

Scale float view. More...

#include <view.hpp>

Protected Attributes

FloatVal a
 Scale factor.
 
- Protected Attributes inherited from Gecode::DerivedView< FloatView >
FloatView x
 View from which this view is derived.
 

Constructors and initialization

 ScaleView (void)
 Default constructor.
 
 ScaleView (FloatVal b, const FloatView &y)
 Initialize as $b\cdot y$.
 

Value access

FloatVal domain (void) const
 Return domain.
 
FloatVal scale (void) const
 Return scale factor of scale view.
 
FloatNum min (void) const
 Return minimum of domain.
 
FloatNum max (void) const
 Return maximum of domain.
 
FloatNum med (void) const
 Return median of domain (closest representation)
 
FloatVal val (void) const
 Return assigned value.
 
FloatNum size (void) const
 Return size of domain (distance between maximum and minimum)
 

Domain tests

bool zero_in (void) const
 Test whether 0 is contained in domain.
 
bool in (FloatNum n) const
 Test whether n is contained in domain.
 
bool in (const FloatVal &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, FloatNum n)
 Restrict domain values to be less or equal than n.
 
ModEvent lq (Space &home, FloatVal 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, FloatNum n)
 Restrict domain values to be greater or equal than n.
 
ModEvent gq (Space &home, FloatVal n)
 Restrict domain values to be greater or equal than n.
 
ModEvent eq (Space &home, int n)
 Restrict domain values to be equal to n.
 
ModEvent eq (Space &home, FloatNum n)
 Restrict domain values to be equal to n.
 
ModEvent eq (Space &home, const FloatVal &n)
 Restrict domain values to be equal to n.
 

Delta information for advisors

FloatNum min (const Delta &d) const
 Return minimum value just pruned.
 
FloatNum max (const Delta &d) const
 Return maximum value just pruned.
 

Cloning

void update (Space &home, ScaleView &y)
 

Ordering

bool operator< (const ScaleView &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.
 

View comparison

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< (std::basic_ostream< Char, Traits > &os, const ScaleView &x)
 Print scale view.
 
bool operator== (const ScaleView &x, const ScaleView &y)
 Test whether views x and y are the same.
 
bool operator!= (const ScaleView &x, const ScaleView &y)
 Test whether views x and y are not the same.
 

Additional Inherited Members

- Public Types inherited from Gecode::DerivedView< FloatView >
typedef FloatView::VarImpType VarImpType
 The variable implementation type belonging to the View.
 
typedef FloatView::VarType VarType
 The variable type belonging to the View.
 
- Public Member Functions inherited from Gecode::DerivedView< FloatView >
 DerivedView (const FloatView &y)
 Initialize with view y.
 
VarImpTypevarimp (void) const
 Return variable implementation of view.
 
FloatView 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< FloatView > &y)
 Update this view to be a clone of view y.
 
bool operator< (const DerivedView< FloatView > &y) const
 Whether this view comes before view y (arbitray order)
 
- Static Public Member Functions inherited from Gecode::DerivedView< FloatView >
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< FloatView >
 DerivedView (void)
 Default constructor.
 

Detailed Description

Scale float view.

A scale float view $s$ for a float view $x$ and a non-negative float $a$ provides operations such that $s$ behaves as $a\cdot x$.

Definition at line 395 of file view.hpp.

Constructor & Destructor Documentation

◆ ScaleView() [1/2]

Gecode::Float::ScaleView::ScaleView ( void )
inline

Default constructor.

Definition at line 43 of file scale.hpp.

◆ ScaleView() [2/2]

Gecode::Float::ScaleView::ScaleView ( FloatVal b,
const FloatView & y )
inline

Initialize as $b\cdot y$.

Definition at line 45 of file scale.hpp.

Member Function Documentation

◆ domain()

FloatVal Gecode::Float::ScaleView::domain ( void ) const
inline

Return domain.

Definition at line 58 of file scale.hpp.

◆ scale()

FloatVal Gecode::Float::ScaleView::scale ( void ) const
inline

Return scale factor of scale view.

Definition at line 54 of file scale.hpp.

◆ min() [1/2]

FloatNum Gecode::Float::ScaleView::min ( void ) const
inline

Return minimum of domain.

Definition at line 62 of file scale.hpp.

◆ max() [1/2]

FloatNum Gecode::Float::ScaleView::max ( void ) const
inline

Return maximum of domain.

Definition at line 66 of file scale.hpp.

◆ med() [1/2]

FloatNum Gecode::Float::ScaleView::med ( void ) const
inline

Return median of domain (closest representation)

Definition at line 70 of file scale.hpp.

◆ val()

FloatVal Gecode::Float::ScaleView::val ( void ) const
inline

Return assigned value.

Throws an exception of type Float::ValOfUnassignedVar if variable is not yet assigned.

Definition at line 74 of file scale.hpp.

◆ size()

FloatNum Gecode::Float::ScaleView::size ( void ) const
inline

Return size of domain (distance between maximum and minimum)

Definition at line 79 of file scale.hpp.

◆ zero_in()

bool Gecode::Float::ScaleView::zero_in ( void ) const
inline

Test whether 0 is contained in domain.

Definition at line 89 of file scale.hpp.

◆ in() [1/2]

bool Gecode::Float::ScaleView::in ( FloatNum n) const
inline

Test whether n is contained in domain.

Definition at line 93 of file scale.hpp.

◆ in() [2/2]

bool Gecode::Float::ScaleView::in ( const FloatVal & n) const
inline

Test whether n is contained in domain.

Definition at line 97 of file scale.hpp.

◆ lq() [1/3]

ModEvent Gecode::Float::ScaleView::lq ( Space & home,
int n )
inline

Restrict domain values to be less or equal than n.

Definition at line 107 of file scale.hpp.

◆ lq() [2/3]

ModEvent Gecode::Float::ScaleView::lq ( Space & home,
FloatNum n )
inline

Restrict domain values to be less or equal than n.

Definition at line 112 of file scale.hpp.

◆ lq() [3/3]

ModEvent Gecode::Float::ScaleView::lq ( Space & home,
FloatVal n )
inline

Restrict domain values to be less or equal than n.

Definition at line 117 of file scale.hpp.

◆ gq() [1/3]

ModEvent Gecode::Float::ScaleView::gq ( Space & home,
int n )
inline

Restrict domain values to be greater or equal than n.

Definition at line 123 of file scale.hpp.

◆ gq() [2/3]

ModEvent Gecode::Float::ScaleView::gq ( Space & home,
FloatNum n )
inline

Restrict domain values to be greater or equal than n.

Definition at line 128 of file scale.hpp.

◆ gq() [3/3]

ModEvent Gecode::Float::ScaleView::gq ( Space & home,
FloatVal n )
inline

Restrict domain values to be greater or equal than n.

Definition at line 133 of file scale.hpp.

◆ eq() [1/3]

ModEvent Gecode::Float::ScaleView::eq ( Space & home,
int n )
inline

Restrict domain values to be equal to n.

Definition at line 139 of file scale.hpp.

◆ eq() [2/3]

ModEvent Gecode::Float::ScaleView::eq ( Space & home,
FloatNum n )
inline

Restrict domain values to be equal to n.

Definition at line 144 of file scale.hpp.

◆ eq() [3/3]

ModEvent Gecode::Float::ScaleView::eq ( Space & home,
const FloatVal & n )
inline

Restrict domain values to be equal to n.

Definition at line 149 of file scale.hpp.

◆ min() [2/2]

FloatNum Gecode::Float::ScaleView::min ( const Delta & d) const
inline

Return minimum value just pruned.

Definition at line 160 of file scale.hpp.

◆ max() [2/2]

FloatNum Gecode::Float::ScaleView::max ( const Delta & d) const
inline

Return maximum value just pruned.

Definition at line 164 of file scale.hpp.

◆ med() [2/2]

ModEventDelta Gecode::Float::ScaleView::med ( ModEvent me)
inlinestatic

Translate modification event me to modification event delta for view.

Definition at line 169 of file scale.hpp.

◆ update()

void Gecode::Float::ScaleView::update ( Space & home,
ScaleView & y )
inline

Definition at line 179 of file scale.hpp.

◆ operator<()

bool Gecode::Float::ScaleView::operator< ( const ScaleView & y) const
inline

Whether this view comes before view y (arbitray order)

Definition at line 188 of file scale.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 ScaleView & x )
related

Print scale view.

Definition at line 45 of file print.hpp.

◆ operator==()

bool operator== ( const ScaleView & x,
const ScaleView & y )
related

Test whether views x and y are the same.

Definition at line 200 of file scale.hpp.

◆ operator!=()

bool operator!= ( const ScaleView & x,
const ScaleView & y )
related

Test whether views x and y are not the same.

Definition at line 204 of file scale.hpp.

Member Data Documentation

◆ a

FloatVal Gecode::Float::ScaleView::a
protected

Scale factor.

Definition at line 399 of file view.hpp.


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