bool.hh

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Christian Schulte <schulte@gecode.org>
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Christian Schulte, 2002
 *     Guido Tack, 2004
 *
 *  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.
 *
 */

#ifndef __GECODE_INT_BOOL_HH__
#define __GECODE_INT_BOOL_HH__

#include <gecode/int.hh>

namespace Gecode { namespace Int { namespace Bool {

  /*
   * Base Classes
   *
   */

  template<class BVA, class BVB>
  class BoolBinary : public Propagator {
  protected:
    BVA x0; 
    BVB x1; 

    BoolBinary(Home home, BVA b0, BVB b1);
    BoolBinary(Space& home, BoolBinary& p);
    BoolBinary(Space& home, Propagator& p,
               BVA b0, BVB b1);
  public:
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual void reschedule(Space& home);
    virtual size_t dispose(Space& home);
  };

  template<class BVA, class BVB, class BVC>
  class BoolTernary : public Propagator {
  protected:
    BVA x0; 
    BVB x1; 
    BVC x2; 

    BoolTernary(Home home, BVA b0, BVB b1, BVC b2);
    BoolTernary(Space& home, BoolTernary& p);
  public:
    BoolTernary(Space& home, Propagator& p,
                BVA b0, BVB b1, BVC b2);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual void reschedule(Space& home);
    virtual size_t dispose(Space& home);
  };

  template<class BVA, class BVB>
  class Eq : public BoolBinary<BVA,BVB> {
  protected:
    using BoolBinary<BVA,BVB>::x0;
    using BoolBinary<BVA,BVB>::x1;
    Eq(Home home, BVA b0, BVB b1);
    Eq(Space& home, Eq& p);
  public:
    Eq(Space& home, Propagator& p,
       BVA b0, BVB b1);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BVA x0, BVB x1);
  };


  template<class BV>
  class NaryEq : public NaryPropagator<BV,PC_BOOL_VAL> {
  protected:
    using NaryPropagator<BV,PC_BOOL_VAL>::x;
    NaryEq(Home home, ViewArray<BV>& x);
    NaryEq(Space& home, NaryEq& p);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<BV>& x);
  };


  template<class BV>
  class Lq : public BoolBinary<BV,BV> {
  protected:
    using BoolBinary<BV,BV>::x0;
    using BoolBinary<BV,BV>::x1;
    Lq(Home home, BV b0, BV b1);
    Lq(Space& home, Lq& p);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BV b0, BV b1);
  };

  template<class VX>
  class NaryLq : public NaryPropagator<VX,PC_BOOL_NONE> {
  protected:
    using NaryPropagator<VX,PC_BOOL_NONE>::x;
    bool run;
    int n_zero;
    int n_one;
    Council<Advisor> c;
    NaryLq(Home home,  ViewArray<VX>& x);
    NaryLq(Space& home, NaryLq<VX>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus advise(Space& home, Advisor& a, const Delta& d);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<VX>& x);
    virtual size_t dispose(Space& home);
  };




  template<class BV>
  class Le {
  public:
    static  ExecStatus post(Home home, BV b0, BV b1);
  };


  template<class BVA, class BVB>
  class BinOrTrue : public BoolBinary<BVA,BVB> {
  protected:
    using BoolBinary<BVA,BVB>::x0;
    using BoolBinary<BVA,BVB>::x1;
    BinOrTrue(Home home, BVA b0, BVB b1);
    BinOrTrue(Space& home, BinOrTrue& p);
  public:
    BinOrTrue(Space& home, Propagator& p,
              BVA b0, BVB b1);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BVA b0, BVB b1);
  };

  template<class BV>
  class TerOrTrue : public BoolBinary<BV,BV> {
  protected:
    using BoolBinary<BV,BV>::x0;
    using BoolBinary<BV,BV>::x1;
    BV x2;
    TerOrTrue(Home home, BV b0, BV b1, BV b2);
    TerOrTrue(Space& home, TerOrTrue& p);
  public:
    TerOrTrue(Space& home, Propagator& p,
              BV b0, BV b1, BV b2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BV b0, BV b1, BV b2);
    virtual size_t dispose(Space& home);
  };

  template<class BV>
  class QuadOrTrue : public BoolBinary<BV,BV> {
  protected:
    using BoolBinary<BV,BV>::x0;
    using BoolBinary<BV,BV>::x1;
    BV x2;
    BV x3;
    QuadOrTrue(Home home, BV b0, BV b1, BV b2, BV b3);
    QuadOrTrue(Space& home, QuadOrTrue& p);
  public:
    QuadOrTrue(Space& home, Propagator& p,
               BV b0, BV b1, BV b2, BV b3);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BV b0, BV b1, BV b2, BV b3);
    virtual size_t dispose(Space& home);
  };

  template<class BVA, class BVB, class BVC>
  class Or : public BoolTernary<BVA,BVB,BVC> {
  protected:
    using BoolTernary<BVA,BVB,BVC>::x0;
    using BoolTernary<BVA,BVB,BVC>::x1;
    using BoolTernary<BVA,BVB,BVC>::x2;
    Or(Home home, BVA b0, BVB b1, BVC b2);
    Or(Space& home, Or& p);
  public:
    Or(Space& home, Propagator& p, BVA b0, BVB b1, BVC b2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BVA b0, BVB b1, BVC b2);
  };

  template<class VX,class VY>
  class NaryOr
    : public MixNaryOnePropagator<VX,PC_BOOL_NONE,VY,PC_BOOL_VAL> {
  protected:
    using MixNaryOnePropagator<VX,PC_BOOL_NONE,VY,PC_BOOL_VAL>::x;
    using MixNaryOnePropagator<VX,PC_BOOL_NONE,VY,PC_BOOL_VAL>::y;
    int n_zero;
    Council<Advisor> c;
    NaryOr(Home home,  ViewArray<VX>& x, VY y);
    NaryOr(Space& home, NaryOr<VX,VY>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus advise(Space& home, Advisor& a, const Delta& d);
    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<VX>& x, VY y);
    virtual size_t dispose(Space& home);
  };


  template<class BV>
  class NaryOrTrue : public BinaryPropagator<BV,PC_BOOL_VAL> {
  protected:
    using BinaryPropagator<BV,PC_BOOL_VAL>::x0;
    using BinaryPropagator<BV,PC_BOOL_VAL>::x1;
    ViewArray<BV> x;
    ExecStatus resubscribe(Space& home, BV& x0, BV x1);
    NaryOrTrue(Home home, ViewArray<BV>& x);
    NaryOrTrue(Space& home, NaryOrTrue<BV>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<BV>& b);
    virtual size_t dispose(Space& home);
  };


  template<class BVA, class BVB, class BVC>
  class Eqv : public BoolTernary<BVA,BVB,BVC> {
  protected:
    using BoolTernary<BVA,BVB,BVC>::x0;
    using BoolTernary<BVA,BVB,BVC>::x1;
    using BoolTernary<BVA,BVB,BVC>::x2;
    Eqv(Space& home, Eqv& p);
    Eqv(Home home, BVA b0 ,BVB b1, BVC b2);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, BVA b0, BVB b1, BVC b2);
  };


  class NaryEqv : public BinaryPropagator<BoolView,PC_BOOL_VAL> {
  protected:
    using BinaryPropagator<BoolView,PC_BOOL_VAL>::x0;
    using BinaryPropagator<BoolView,PC_BOOL_VAL>::x1;
    ViewArray<BoolView> x;
    int pm2;
    void resubscribe(Space& home, BoolView& x0);
    NaryEqv(Home home, ViewArray<BoolView>& x, int pm2);
    NaryEqv(Space& home, NaryEqv& p);
  public:
    GECODE_INT_EXPORT
    virtual Actor* copy(Space& home);
    GECODE_INT_EXPORT
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    GECODE_INT_EXPORT
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    GECODE_INT_EXPORT
    static ExecStatus post(Home home, ViewArray<BoolView>& x, int pm2);
    virtual size_t dispose(Space& home);
  };


  template<class VX, class VY>
  class Clause : public Propagator {
  protected:
    ViewArray<VX> x;
    ViewArray<VY> y;
    VX z;
    int n_zero;
    class Tagged : public Advisor {
    public:
      const bool x;
      Tagged(Space& home, Propagator& p, Council<Tagged>& c, bool x);
      Tagged(Space& home, Tagged& a);
    };
    Council<Tagged> c;
    void cancel(Space& home);
    Clause(Home home,  ViewArray<VX>& x, ViewArray<VY>& y, VX z);
    Clause(Space& home, Clause<VX,VY>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus advise(Space& home, Advisor& a, const Delta& d);
    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<VX>& x, ViewArray<VY>& y,
                            VX z);
    virtual size_t dispose(Space& home);
  };


  template<class VX, class VY>
  class ClauseTrue
    : public MixBinaryPropagator<VX,PC_BOOL_VAL,VY,PC_BOOL_VAL> {
  protected:
    using MixBinaryPropagator<VX,PC_BOOL_VAL,VY,PC_BOOL_VAL>::x0;
    using MixBinaryPropagator<VX,PC_BOOL_VAL,VY,PC_BOOL_VAL>::x1;
    ViewArray<VX> x;
    ViewArray<VY> y;
    ClauseTrue(Home home, ViewArray<VX>& x, ViewArray<VY>& y);
    ClauseTrue(Space& home, ClauseTrue<VX,VY>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<VX>& x, ViewArray<VY>& y);
    virtual size_t dispose(Space& home);
  };


  template<class V0, class V1, class V2, PropCond pc>
  class IteBase : public Propagator {
  protected:
    BoolView b;
    V0 x0; V1 x1; V2 x2;
    IteBase(Space& home, IteBase& p);
    IteBase(Home home, BoolView b, V0 x0, V1 x1, V2 x2);
  public:
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual void reschedule(Space& home);
    virtual size_t dispose(Space& home);
  };

  template<class V0, class V1, class V2>
  class IteBnd : public IteBase<V0,V1,V2,PC_INT_BND> {
  protected:
    using IteBase<V0,V1,V2,PC_INT_BND>::b;
    using IteBase<V0,V1,V2,PC_INT_BND>::x0;
    using IteBase<V0,V1,V2,PC_INT_BND>::x1;
    using IteBase<V0,V1,V2,PC_INT_BND>::x2;
    IteBnd(Space& home, IteBnd& p);
    IteBnd(Home home, BoolView b, V0 x0, V1 x1, V2 x2);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, BoolView b, V0 x0, V1 x1, V2 x2);
  };

  template<class V0, class V1, class V2>
  class IteDom : public IteBase<V0,V1,V2,PC_INT_DOM> {
  protected:
    using IteBase<V0,V1,V2,PC_INT_DOM>::b;
    using IteBase<V0,V1,V2,PC_INT_DOM>::x0;
    using IteBase<V0,V1,V2,PC_INT_DOM>::x1;
    using IteBase<V0,V1,V2,PC_INT_DOM>::x2;
    IteDom(Space& home, IteDom& p);
    IteDom(Home home, BoolView b, V0 x0, V1 x1, V2 x2);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, BoolView b, V0 x0, V1 x1, V2 x2);
  };

}}}

#include <gecode/int/bool/base.hpp>
#include <gecode/int/bool/eq.hpp>
#include <gecode/int/bool/lq.hpp>
#include <gecode/int/bool/or.hpp>
#include <gecode/int/bool/eqv.hpp>
#include <gecode/int/bool/clause.hpp>
#include <gecode/int/bool/ite.hpp>

#endif

// STATISTICS: int-prop