Generated on Thu Jul 25 2019 00:00:00 for Gecode by doxygen 1.8.15
Gecode::Float::Linear::Lin< P, N, pc > Class Template Reference

Base-class for n-ary linear propagators. More...

#include <linear.hh>

Public Member Functions

virtual PropCost cost (const Space &home, const ModEventDelta &med) const
 Cost function (defined as low linear) More...
 
virtual void reschedule (Space &home)
 Schedule function. More...
 
virtual size_t dispose (Space &home)
 Delete propagator and return its size. More...
 
- Public Member Functions inherited from Gecode::Propagator
virtual ExecStatus propagate (Space &home, const ModEventDelta &med)=0
 Propagation function. More...
 
ModEventDelta modeventdelta (void) const
 Return the modification event delta. More...
 
virtual ExecStatus advise (Space &home, Advisor &a, const Delta &d)
 Advise function. More...
 
virtual void advise (Space &home, Advisor &a)
 Run advisor a to be run on failure in failed space. More...
 
double afc (void) const
 Return the accumlated failure count. More...
 
unsigned int id (void) const
 Return propagator id. More...
 
PropagatorGroup group (void) const
 Return group propagator belongs to. More...
 
void group (PropagatorGroup g)
 Add propagator to group g. More...
 
bool disabled (void) const
 Whether propagator is currently disabled. More...
 
- Public Member Functions inherited from Gecode::Actor
virtual Actorcopy (Space &home, bool share)=0
 Create copy. More...
 
virtual ~Actor (void)
 To avoid warnings. More...
 

Protected Member Functions

 Lin (Space &home, bool share, Lin< P, N, pc > &p)
 Constructor for cloning p. More...
 
 Lin (Home home, ViewArray< P > &x, ViewArray< N > &y, FloatVal c)
 Constructor for creation. More...
 
- Protected Member Functions inherited from Gecode::Propagator
 Propagator (Home home)
 Constructor for posting. More...
 
 Propagator (Space &home, bool share, Propagator &p)
 Constructor for cloning p. More...
 
Propagatorfwd (void) const
 Return forwarding pointer during copying. More...
 
GPI::Infogpi (void)
 Provide access to global propagator information. More...
 

Protected Attributes

ViewArray< P > x
 Array of positive views. More...
 
ViewArray< N > y
 Array of negative views. More...
 
FloatVal c
 Constant value. More...
 

Related Functions

(Note that these are not member functions.)

template<class View >
void bounds_p (ModEventDelta med, ViewArray< View > &x, FloatVal &c, FloatNum &sl, FloatNum &su)
 Compute bounds information for positive views. More...
 
template<class View >
void bounds_n (ModEventDelta med, ViewArray< View > &y, FloatVal &c, FloatNum &sl, FloatNum &su)
 Compute bounds information for negative views. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Gecode::Actor
static void * operator new (size_t s)
 Not used. More...
 
static void operator delete (void *p)
 Not used. More...
 
static void * operator new (size_t s, Space &home)
 Allocate memory from space. More...
 
static void operator delete (void *p, Space &home)
 No-op for exceptions. More...
 

Detailed Description

template<class P, class N, PropCond pc>
class Gecode::Float::Linear::Lin< P, N, pc >

Base-class for n-ary linear propagators.

Positive views are of type P whereas negative views are of type N.

Definition at line 61 of file linear.hh.

Constructor & Destructor Documentation

◆ Lin() [1/2]

template<class P, class N, PropCond pc>
Gecode::Float::Linear::Lin< P, N, pc >::Lin ( Space home,
bool  share,
Lin< P, N, pc > &  p 
)
inlineprotected

Constructor for cloning p.

Definition at line 56 of file nary.hpp.

◆ Lin() [2/2]

template<class P, class N, PropCond pc>
Gecode::Float::Linear::Lin< P, N, pc >::Lin ( Home  home,
ViewArray< P > &  x,
ViewArray< N > &  y,
FloatVal  c 
)
inlineprotected

Constructor for creation.

Definition at line 48 of file nary.hpp.

Member Function Documentation

◆ cost()

template<class P , class N , PropCond pc>
PropCost Gecode::Float::Linear::Lin< P, N, pc >::cost ( const Space home,
const ModEventDelta med 
) const
virtual

Cost function (defined as low linear)

Implements Gecode::Propagator.

Definition at line 64 of file nary.hpp.

◆ reschedule()

template<class P , class N , PropCond pc>
void Gecode::Float::Linear::Lin< P, N, pc >::reschedule ( Space home)
virtual

Schedule function.

Implements Gecode::Propagator.

Definition at line 70 of file nary.hpp.

◆ dispose()

template<class P , class N , PropCond pc>
size_t Gecode::Float::Linear::Lin< P, N, pc >::dispose ( Space home)
inlinevirtual

Delete propagator and return its size.

Reimplemented from Gecode::Actor.

Definition at line 77 of file nary.hpp.

Friends And Related Function Documentation

◆ bounds_p()

template<class View >
void bounds_p ( ModEventDelta  med,
ViewArray< View > &  x,
FloatVal c,
FloatNum sl,
FloatNum su 
)
related

Compute bounds information for positive views.

◆ bounds_n()

template<class View >
void bounds_n ( ModEventDelta  med,
ViewArray< View > &  y,
FloatVal c,
FloatNum sl,
FloatNum su 
)
related

Compute bounds information for negative views.

Member Data Documentation

◆ x

template<class P, class N, PropCond pc>
ViewArray<P> Gecode::Float::Linear::Lin< P, N, pc >::x
protected

Array of positive views.

Definition at line 64 of file linear.hh.

◆ y

template<class P, class N, PropCond pc>
ViewArray<N> Gecode::Float::Linear::Lin< P, N, pc >::y
protected

Array of negative views.

Definition at line 66 of file linear.hh.

◆ c

template<class P, class N, PropCond pc>
FloatVal Gecode::Float::Linear::Lin< P, N, pc >::c
protected

Constant value.

Definition at line 68 of file linear.hh.


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