wait.hpp
Go to the documentation of this file.
/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
*
* Copyright:
* Christian Schulte, 2009
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
namespace Gecode {
template<class View>
class UnaryWait : public Propagator {
protected:
View x;
SharedData<std::function<void(Space& home)>> c;
UnaryWait(Home home, View x, std::function<void(Space& home)> c0);
UnaryWait(Space& home, UnaryWait& p);
public:
virtual Actor* copy(Space& home);
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
virtual void reschedule(Space& home);
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
static ExecStatus post(Home home, View x,
std::function<void(Space& home)> c);
virtual size_t dispose(Space& home);
};
template<class View>
class NaryWait : public Propagator {
protected:
ViewArray<View> x;
SharedData<std::function<void(Space& home)>> c;
NaryWait(Home home, ViewArray<View>& x,
std::function<void(Space& home)> c0);
NaryWait(Space& home, NaryWait& p);
public:
virtual Actor* copy(Space& home);
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
virtual void reschedule(Space& home);
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
static ExecStatus post(Home home, ViewArray<View>& x,
std::function<void(Space& home)> c);
virtual size_t dispose(Space& home);
};
/*
* Wait propagator for single view
*
*/
template<class View>
forceinline
UnaryWait<View>::UnaryWait(Home home, View x0,
std::function<void(Space& home)> c0)
: Propagator(home), x(x0), c(c0) {
x.subscribe(home,*this,PC_GEN_ASSIGNED);
home.notice(*this,AP_DISPOSE);
}
template<class View>
forceinline
UnaryWait<View>::UnaryWait(Space& home, UnaryWait& p)
: Propagator(home,p), c(p.c) {
x.update(home,p.x);
}
template<class View>
Actor*
UnaryWait<View>::copy(Space& home) {
return new (home) UnaryWait<View>(home,*this);
}
template<class View>
PropCost
UnaryWait<View>::cost(const Space&, const ModEventDelta&) const {
return PropCost::unary(PropCost::LO);
}
template<class View>
void
UnaryWait<View>::reschedule(Space& home) {
x.reschedule(home,*this,PC_GEN_ASSIGNED);
}
template<class View>
ExecStatus
UnaryWait<View>::propagate(Space& home, const ModEventDelta&) {
assert(x.assigned());
GECODE_VALID_FUNCTION(c());
c()(home);
return home.failed() ? ES_FAILED : home.ES_SUBSUMED(*this);
}
template<class View>
forceinline ExecStatus
UnaryWait<View>::post(Home home, View x,
std::function<void(Space& home)> c) {
if (!c)
throw InvalidFunction("UnaryWait::post");
if (x.assigned()) {
c(home);
return home.failed() ? ES_FAILED : ES_OK;
} else {
(void) new (home) UnaryWait<View>(home,x,c);
return ES_OK;
}
}
template<class View>
size_t
UnaryWait<View>::dispose(Space& home) {
x.cancel(home,*this,PC_GEN_ASSIGNED);
home.ignore(*this,AP_DISPOSE);
c.~SharedData<std::function<void(Space& home)>>();
(void) Propagator::dispose(home);
return sizeof(*this);
}
/*
* Wait propagator for several views
*
*/
template<class View>
forceinline
NaryWait<View>::NaryWait(Home home, ViewArray<View>& x0,
std::function<void(Space& home)> c0)
: Propagator(home), x(x0), c(c0) {
assert(!x[0].assigned());
x[0].subscribe(home,*this,PC_GEN_ASSIGNED);
home.notice(*this,AP_DISPOSE);
}
template<class View>
forceinline
NaryWait<View>::NaryWait(Space& home, NaryWait& p)
: Propagator(home,p), c(p.c) {
x.update(home,p.x);
}
template<class View>
Actor*
NaryWait<View>::copy(Space& home) {
assert(!x[0].assigned());
for (int i=x.size()-1; i>0; i--)
if (x[i].assigned())
x.move_lst(i);
assert(x.size() > 0);
return new (home) NaryWait<View>(home,*this);
}
template<class View>
PropCost
NaryWait<View>::cost(const Space&, const ModEventDelta&) const {
return PropCost::unary(PropCost::HI);
}
template<class View>
void
NaryWait<View>::reschedule(Space& home) {
x[0].reschedule(home,*this,PC_GEN_ASSIGNED);
}
template<class View>
ExecStatus
NaryWait<View>::propagate(Space& home, const ModEventDelta& ) {
assert(x[0].assigned());
for (int i=x.size()-1; i>0; i--)
if (x[i].assigned())
x.move_lst(i);
assert(x.size() > 0);
if (x.size() == 1) {
x.size(0);
GECODE_VALID_FUNCTION(c());
c()(home);
return home.failed() ? ES_FAILED : home.ES_SUBSUMED(*this);
} else {
// Create new subscription
x.move_lst(0);
assert(!x[0].assigned());
x[0].subscribe(home,*this,PC_GEN_ASSIGNED,false);
return ES_OK;
}
}
template<class View>
forceinline ExecStatus
NaryWait<View>::post(Home home, ViewArray<View>& x,
std::function<void(Space& home)> c) {
if (!c)
throw InvalidFunction("NaryWait::post");
for (int i=x.size(); i--; )
if (x[i].assigned())
x.move_lst(i);
if (x.size() == 0) {
c(home);
return home.failed() ? ES_FAILED : ES_OK;
} else {
x.unique();
if (x.size() == 1) {
return UnaryWait<View>::post(home,x[0],c);
} else {
(void) new (home) NaryWait<View>(home,x,c);
return ES_OK;
}
}
}
template<class View>
size_t
NaryWait<View>::dispose(Space& home) {
if (x.size() > 0)
x[0].cancel(home,*this,PC_GEN_ASSIGNED);
home.ignore(*this,AP_DISPOSE);
c.~SharedData<std::function<void(Space& home)>>();
(void) Propagator::dispose(home);
return sizeof(*this);
}
}
// STATISTICS: kernel-prop
Gecode::Actor
Base-class for both propagators and branchers.
Definition core.hpp:628
Gecode::Actor::dispose
virtual size_t dispose(Space &home)
Delete actor and return its size.
Definition core.hpp:3252
Gecode::Home
Home class for posting propagators
Definition core.hpp:856
Gecode::InvalidFunction
Exception: invalid function
Definition exception.hpp:114
Gecode::NaryWait::cost
virtual PropCost cost(const Space &home, const ModEventDelta &med) const
Const function (defined as high unary).
Definition wait.hpp:201
Gecode::NaryWait::dispose
virtual size_t dispose(Space &home)
Delete propagator and return its size.
Definition wait.hpp:254
Gecode::NaryWait::copy
virtual Actor * copy(Space &home)
Perform copying during cloning.
Definition wait.hpp:191
Gecode::NaryWait::NaryWait
NaryWait(Home home, ViewArray< View > &x, std::function< void(Space &home)> c0)
Constructor for creation.
Definition wait.hpp:176
Gecode::NaryWait::reschedule
virtual void reschedule(Space &home)
Schedule function.
Definition wait.hpp:206
Gecode::NaryWait::c
SharedData< std::function< void(Space &home)> > c
Continuation to execute.
Definition wait.hpp:81
Gecode::NaryWait::x
ViewArray< View > x
Views to wait for becoming assigned.
Definition wait.hpp:79
Gecode::NaryWait::post
static ExecStatus post(Home home, ViewArray< View > &x, std::function< void(Space &home)> c)
Post propagator that waits until x becomes assigned and then executes c.
Definition wait.hpp:232
Gecode::NaryWait::propagate
virtual ExecStatus propagate(Space &home, const ModEventDelta &med)
Perform propagation.
Definition wait.hpp:211
Gecode::PropCost
Propagation cost.
Definition core.hpp:486
Gecode::PropCost::unary
static PropCost unary(PropCost::Mod m)
Single variable for modifier pcm.
Definition core.hpp:4813
Gecode::PropCost::LO
@ LO
Cheap.
Definition core.hpp:513
Gecode::PropCost::HI
@ HI
Expensive.
Definition core.hpp:514
Gecode::Propagator::Space
friend class Space
Definition core.hpp:1066
Gecode::Propagator::med
ModEventDelta med
A set of modification events (used during propagation).
Definition core.hpp:1075
Gecode::Propagator::Propagator
Propagator(Home home)
Constructor for posting.
Definition core.hpp:3498
Gecode::SharedData
Class for sharing data between spaces.
Definition shared-data.hpp:38
Gecode::UnaryWait::x
View x
View to wait for becoming assigned.
Definition wait.hpp:46
Gecode::UnaryWait::reschedule
virtual void reschedule(Space &home)
Schedule function.
Definition wait.hpp:134
Gecode::UnaryWait::dispose
virtual size_t dispose(Space &home)
Delete propagator and return its size.
Definition wait.hpp:161
Gecode::UnaryWait::c
SharedData< std::function< void(Space &home)> > c
Continuation to execute.
Definition wait.hpp:48
Gecode::UnaryWait::post
static ExecStatus post(Home home, View x, std::function< void(Space &home)> c)
Post propagator that waits until x becomes assigned and then executes c.
Definition wait.hpp:147
Gecode::UnaryWait::UnaryWait
UnaryWait(Home home, View x, std::function< void(Space &home)> c0)
Constructor for creation.
Definition wait.hpp:110
Gecode::UnaryWait::copy
virtual Actor * copy(Space &home)
Perform copying during cloning.
Definition wait.hpp:124
Gecode::UnaryWait::cost
virtual PropCost cost(const Space &home, const ModEventDelta &med) const
Const function (defined as low unary).
Definition wait.hpp:129
Gecode::UnaryWait::propagate
virtual ExecStatus propagate(Space &home, const ModEventDelta &med)
Perform propagation.
Definition wait.hpp:139
Gecode::View
Gecode::ViewArray
View arrays.
Definition array.hpp:253
Gecode::Space::ES_SUBSUMED
ExecStatus ES_SUBSUMED(Propagator &p)
Definition core.hpp:3563
Gecode::Space::ignore
void ignore(Actor &a, ActorProperty p, bool duplicate=false)
Ignore actor property.
Definition core.hpp:4074
Gecode::ModEventDelta
int ModEventDelta
Modification event deltas.
Definition core.hpp:89
Gecode::Space::failed
bool failed(void) const
Check whether space is failed.
Definition core.hpp:4044
Gecode::Space::notice
void notice(Actor &a, ActorProperty p, bool duplicate=false)
Notice actor property.
Definition core.hpp:4059
Gecode::AP_DISPOSE
@ AP_DISPOSE
Actor must always be disposed.
Definition core.hpp:562
Gecode
Gecode toplevel namespace
Gecode::PC_GEN_ASSIGNED
const PropCond PC_GEN_ASSIGNED
Propagation condition for an assigned variable.
Definition core.hpp:76
Gecode::ExecStatus
ExecStatus
Definition core.hpp:472
Gecode::ES_OK
@ ES_OK
Execution is okay.
Definition core.hpp:476
Gecode::ES_FAILED
@ ES_FAILED
Execution has resulted in failure.
Definition core.hpp:474
forceinline
#define forceinline
Definition config.hpp:187
GECODE_VALID_FUNCTION
#define GECODE_VALID_FUNCTION(f)
Assert that a function is valid.
Definition macros.hpp:94