set.cc

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *     Christian Schulte <schulte@gecode.org>
 *     Mikael Lagerkvist <lagerkvist@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2005
 *     Christian Schulte, 2005
 *     Mikael Lagerkvist, 2005
 *
 *  Last modified:
 *     $Date: 2008-02-27 17:57:55 +0100 (Wed, 27 Feb 2008) $ by $Author: tack $
 *     $Revision: 6328 $
 *
 *  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.
 *
 */

#include "test/set.hh"

#include <algorithm>

namespace Test { namespace Set {

  CountableSet::CountableSet(const Gecode::IntSet& d0) : d(d0), cur(0) {
    Gecode::IntSetRanges isr(d);
    lubmax =
      static_cast<unsigned int>(pow(static_cast<double>(2.0),
        static_cast<int>(Gecode::Iter::Ranges::size(isr))));
  }

  void CountableSet::operator++(void) {
    cur++;
  }

  void CountableSet::init(const Gecode::IntSet& d0) {
    d = d0;
    cur = 0;
    Gecode::IntSetRanges isr(d);
    lubmax =
      static_cast<unsigned int>(pow(static_cast<double>(2.0),
        static_cast<int>(Gecode::Iter::Ranges::size(isr))));
  }

  int CountableSet::val(void) const {
    return cur;
  }

  SetAssignment::SetAssignment(int n0, const Gecode::IntSet& d0, int _withInt)
    : n(n0), dsv(new CountableSet[n]), ir(_withInt, d0), done(false), lub(d0), 
      withInt(_withInt) {
    for (int i=n; i--; )
      dsv[i].init(lub);
  }

  void
  SetAssignment::operator++(void) {
    int i = n-1;
    while (true) {
      ++dsv[i];
      if (dsv[i]())
        return;
      dsv[i].init(lub);
      --i;
      if (i<0) {
        if (withInt==0) {
          done = true;
          return;
        }
        ++ir;
        if (ir()) {
          i = n-1;
          for (int j=n; j--; )
            dsv[j].init(lub);
        } else {
          done = true;
          return;
        }
      }
    }
  }

}}

std::ostream&
operator<<(std::ostream& os, const Test::Set::SetAssignment& a) {
  int n = a.size();
  os << "{";
  for (int i=0; i<n; i++) {
    Test::Set::CountableSetRanges csv(a.lub, a[i]);
    Gecode::IntSet icsv(csv);
    os << icsv << ((i!=n-1) ? "," : "}");
  }
  if (a.withInt > 0)
    os << a.ints();
  return os;
}

namespace Test { namespace Set {

  class SetTestSpace : public Gecode::Space {
  public:
    Gecode::IntSet d;
    Gecode::SetVarArray x;
    Gecode::IntVarArray y;
    int withInt;
    Gecode::BoolVar b;
    bool reified;
    SetTest* test;

  public:
    SetTestSpace(int n, Gecode::IntSet& d0, int i, bool r, SetTest* t,
                 bool log=true)
      : d(d0), x(this, n, Gecode::IntSet::empty, d), y(this, i, d), 
        withInt(i), b(this, 0, 1), reified(r), test(t) {
      if (opt.log && log) {
        olog << ind(2) << "Initial: x[]=" << x;
        olog << " y[]=" << y;
        if (reified)
          olog << " b=" << b;
        olog << std::endl;
      }
    }
    
    SetTestSpace(bool share, SetTestSpace& s)
    : Gecode::Space(share,s), d(s.d), withInt(s.withInt),
      reified(s.reified), test(s.test) {
      x.update(this, share, s.x);
      y.update(this, share, s.y);
      b.update(this, share, s.b);
    }

    virtual Gecode::Space* copy(bool share) {
      return new SetTestSpace(share,*this);
    }

    SetTestSpace* cloneWithReflection(void) {
      SetTestSpace* c = new SetTestSpace(x.size(), d, withInt, reified, test);
      Gecode::Reflection::VarMap vm;
      vm.putArray(this, x, "x");
      vm.putArray(this, y, "y");
      vm.put(this, b, "b");
      Gecode::Reflection::VarMap cvm;
      cvm.putArray(c, c->x, "x", true);
      cvm.putArray(c, c->y, "y", true);
      cvm.put(c, c->b, "b", true);
      Gecode::Reflection::Unreflector d(c, cvm);
      Gecode::Reflection::VarMapIter vmi(vm);
      try {
        for (Gecode::Reflection::ActorSpecIter si(this, vm); si(); ++si) {
          Gecode::Reflection::ActorSpec s = si.actor();
          for (; vmi(); ++vmi) {
            try {
              d.var(vmi.spec());
            } catch (Gecode::Reflection::ReflectionException e) {
              delete c;
              return NULL;
            }            
          }
          try {
            d.post(s);
          } catch (Gecode::Reflection::ReflectionException e) {
            delete c;
            return NULL;
          }
        }
        for (; vmi(); ++vmi) {
          try {
            d.var(vmi.spec());
          } catch (Gecode::Reflection::ReflectionException e) {
            delete c;
            return NULL;
          }
        }
        assert(c != NULL);
        if (failed())
          c->fail();
        return c;
      } catch (Gecode::Reflection::ReflectionException e) {
        delete c;
        if (status() == Gecode::SS_FAILED)
          return this;
        return static_cast<SetTestSpace*>(clone());
      }
    }

    void post(void) {
      if (reified){
        test->post(this,x,y,b);
        if (opt.log)
          olog << ind(3) << "Posting reified propagator" << std::endl;
      } else {
        test->post(this,x,y);
        if (opt.log)
          olog << ind(3) << "Posting propagator" << std::endl;
      }
    }
    bool failed(void) {
      if (opt.log) {
        olog << ind(3) << "Fixpoint: x[]=" << x
             << " y[]=" << y << std::endl;
        bool f=(status() == Gecode::SS_FAILED);
        olog << ind(3) << "     -->  x[]=" << x 
             << " y[]=" << y << std::endl;
        return f;
      } else {
        return status() == Gecode::SS_FAILED;
      }
    }

    void rel(int i, Gecode::SetRelType srt, const Gecode::IntSet& is) {
      if (opt.log) {
        olog << ind(4) << "x[" << i << "] ";
        switch (srt) {
        case Gecode::SRT_EQ: olog << "="; break;
        case Gecode::SRT_NQ: olog << "!="; break;
        case Gecode::SRT_SUB: olog << "<="; break;
        case Gecode::SRT_SUP: olog << ">="; break;
        case Gecode::SRT_DISJ: olog << "||"; break;
        case Gecode::SRT_CMPL: olog << "^-1 = "; break;
        }
        olog << is << std::endl;
      }
      Gecode::dom(this, x[i], srt, is);
    }
    void cardinality(int i, int cmin, int cmax) {
      if (opt.log) {
        olog << ind(4) << cmin << " <= #(x[" << i << "]) <= " << cmax
             << std::endl;
      }
      Gecode::cardinality(this, x[i], cmin, cmax);
    }
    void rel(int i, Gecode::IntRelType irt, int n) {
      if (opt.log) {
        olog << ind(4) << "y[" << i << "] ";
        switch (irt) {
        case Gecode::IRT_EQ: olog << "="; break;
        case Gecode::IRT_NQ: olog << "!="; break;
        case Gecode::IRT_LQ: olog << "<="; break;
        case Gecode::IRT_LE: olog << "<"; break;
        case Gecode::IRT_GQ: olog << ">="; break;
        case Gecode::IRT_GR: olog << ">"; break;
        }
        olog << " " << n << std::endl;
      }
      Gecode::rel(this, y[i], irt, n);
    }
    void rel(bool sol) {
      int n = sol ? 1 : 0;
      assert(reified);
      if (opt.log) 
        olog << ind(4) << "b = " << n << std::endl;
      Gecode::rel(this, b, Gecode::IRT_EQ, n);
    }

    void assign(const SetAssignment& a) {
      for (int i=a.size(); i--; ) {
        CountableSetRanges csv(a.lub, a[i]);
        Gecode::IntSet ai(csv);
        rel(i, Gecode::SRT_EQ, ai);
        if (Base::fixpoint() && failed())
          return;
      }
      for (int i=withInt; i--; ) {
        rel(i, Gecode::IRT_EQ, a.ints()[i]);
        if (Base::fixpoint() && failed())
          return;
      }
    }

    bool assigned(void) const {
      for (int i=x.size(); i--; )
        if (!x[i].assigned())
          return false;
      for (int i=y.size(); i--; )
        if (!y[i].assigned())
          return false;
      return true;
    }
    void removeFromLub(int v, int i, const SetAssignment& a) {
      using namespace Gecode;
      SetVarUnknownRanges ur(x[i]);
      CountableSetRanges air(a.lub, a[i]);
      Gecode::Iter::Ranges::Diff<Gecode::SetVarUnknownRanges, 
        CountableSetRanges> diff(ur, air);
      Gecode::Iter::Ranges::ToValues<Gecode::Iter::Ranges::Diff
        <Gecode::SetVarUnknownRanges, CountableSetRanges> > diffV(diff);
      for (int j=0; j<v; j++, ++diffV);
      rel(i, Gecode::SRT_DISJ, Gecode::IntSet(diffV.val(), diffV.val()));
    }
    void addToGlb(int v, int i, const SetAssignment& a) {
      using namespace Gecode;
      SetVarUnknownRanges ur(x[i]);
      CountableSetRanges air(a.lub, a[i]);
      Gecode::Iter::Ranges::Inter<Gecode::SetVarUnknownRanges, 
        CountableSetRanges> inter(ur, air);
      Gecode::Iter::Ranges::ToValues<Gecode::Iter::Ranges::Inter
        <Gecode::SetVarUnknownRanges, CountableSetRanges> > interV(inter);
      for (int j=0; j<v; j++, ++interV);
      rel(i, Gecode::SRT_SUP, Gecode::IntSet(interV.val(), interV.val()));
    }
    bool fixprob(void) {
      if (failed())
        return true;
      SetTestSpace* c = static_cast<SetTestSpace*>(clone());
      if (opt.log)
        olog << ind(3) << "Testing fixpoint on copy" << std::endl;
      c->post();
      if (c->failed()) {
        delete c; return false;
      }

      for (int i=x.size(); i--; )
        if (x[i].glbSize() != c->x[i].glbSize() ||
            x[i].lubSize() != c->x[i].lubSize() ||
            x[i].cardMin() != c->x[i].cardMin() ||
            x[i].cardMax() != c->x[i].cardMax()) {
          delete c;
          return false;
        }
      for (int i=y.size(); i--; )
        if (y[i].size() != c->y[i].size()) {
          delete c; return false;
        }
      if (reified && (b.size() != c->b.size())) {
        delete c; return false;
      }
      if (opt.log)
        olog << ind(3) << "Finished testing fixpoint on copy" << std::endl;
      delete c;
      return true;
    }
    bool prune(const SetAssignment& a) {
      using namespace Gecode;
      bool setsAssigned = true;
      for (int j=x.size(); j--; )
        if (!x[j].assigned()) {
          setsAssigned = false;
          break;
        }
      bool intsAssigned = true;
      for (int j=y.size(); j--; )
        if (!y[j].assigned()) {
          intsAssigned = false;
          break;
        }

      // Select variable to be pruned
      int i;
      if (intsAssigned) {
        i = Base::rand(x.size());
      } else if (setsAssigned) {
        i = Base::rand(y.size());
      } else {
        i = Base::rand(x.size()+y.size());
      }

      if (setsAssigned || i>=x.size()) {
        if (i>=x.size())
          i = i-x.size();
        while (y[i].assigned()) {
          i = (i+1) % y.size();
        }
        // Prune int var

        // Select mode for pruning
        switch (Base::rand(3)) {
        case 0:
          if (a.ints()[i] < y[i].max()) {
            int v=a.ints()[i]+1+
              Base::rand(static_cast<unsigned int>(y[i].max()-a.ints()[i]));
            assert((v > a.ints()[i]) && (v <= y[i].max()));
            rel(i, Gecode::IRT_LE, v);
          }
          break;
        case 1:
          if (a.ints()[i] > y[i].min()) {
            int v=y[i].min()+
              Base::rand(static_cast<unsigned int>(a.ints()[i]-y[i].min()));
            assert((v < a.ints()[i]) && (v >= y[i].min()));
            rel(i, Gecode::IRT_GR, v);
          }
          break;
        default:
          int v;
          Gecode::Int::ViewRanges<Gecode::Int::IntView> it(y[i]);
          unsigned int skip = Base::rand(y[i].size()-1);
          while (true) {
            if (it.width() > skip) {
              v = it.min() + skip;
              if (v == a.ints()[i]) {
                if (it.width() == 1) {
                  ++it; v = it.min();
                } else if (v < it.max()) {
                  ++v;
                } else {
                  --v;
                }
              }
              break;
            }
            skip -= it.width();
            ++it;
          }
          rel(i, Gecode::IRT_NQ, v);
        }
        return (!Base::fixpoint() || fixprob());
      }
      while (x[i].assigned()) {
        i = (i+1) % x.size();
      }
      Gecode::SetVarUnknownRanges ur1(x[i]);
      CountableSetRanges air1(a.lub, a[i]);
      Gecode::Iter::Ranges::Diff<Gecode::SetVarUnknownRanges, 
        CountableSetRanges> diff(ur1, air1);
      Gecode::SetVarUnknownRanges ur2(x[i]);
      CountableSetRanges air2(a.lub, a[i]);
      Gecode::Iter::Ranges::Inter<Gecode::SetVarUnknownRanges, 
        CountableSetRanges> inter(ur2, air2);

      CountableSetRanges aisizer(a.lub, a[i]);
      unsigned int aisize = Gecode::Iter::Ranges::size(aisizer);

      // Select mode for pruning
      switch (Base::rand(5)) {
      case 0:
        if (inter()) {
          int v = Base::rand(Gecode::Iter::Ranges::size(inter));
          addToGlb(v, i, a);
        }
        break;
      case 1:
        if (diff()) {
          int v = Base::rand(Gecode::Iter::Ranges::size(diff));
          removeFromLub(v, i, a);
        }
        break;
      case 2:
        if (x[i].cardMin() < aisize) {
          unsigned int newc = x[i].cardMin() + 1 +
            Base::rand(aisize - x[i].cardMin());
          assert( newc > x[i].cardMin() );
          assert( newc <= aisize );
          cardinality(i, newc, Gecode::Set::Limits::card);
        }
        break;
      case 3:
        if (x[i].cardMax() > aisize) {
          unsigned int newc = x[i].cardMax() - 1 -
            Base::rand(x[i].cardMax() - aisize);
          assert( newc < x[i].cardMax() );
          assert( newc >= aisize );
          cardinality(i, 0, newc);
        }
        break;
      default:
        if (inter()) {
          int v = Base::rand(Gecode::Iter::Ranges::size(inter));
          addToGlb(v, i, a);
        } else {
          int v = Base::rand(Gecode::Iter::Ranges::size(diff));
          removeFromLub(v, i, a);
        }      
      }
      return (!Base::fixpoint() || fixprob());
    }

  };


#define CHECK_TEST(T,M)                                         \
if (opt.log)                                                    \
  olog << ind(3) << "Check: " << (M) << std::endl;              \
if (!(T)) {                                                     \
  problem = (M); delete s; goto failed;                         \
}

#define START_TEST(T)                                           \
  if (opt.log) {                                                \
     olog.str("");                                              \
     olog << ind(2) << "Testing: " << (T) << std::endl;         \
  }                                                             \
  test = (T);

  bool
  SetTest::run(void) {
    const char* test    = "NONE";
    const char* problem = "NONE";

    SetAssignment* ap = new SetAssignment(arity,lub,withInt);
    SetAssignment& a = *ap;
    while (a()) {
      bool is_sol = solution(a);
      if (opt.log)
        olog << ind(1) << "Assignment: " << a 
             << (is_sol ? " (solution)" : " (no solution)")
             << std::endl;

      START_TEST("Assignment (after posting)");
      {
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,false,this);
        SetTestSpace* sc = NULL;
        s->post();
        switch (Base::rand(3)) {
          case 0:
            if (opt.log)
              olog << ind(3) << "No copy" << std::endl;
            sc = s;
            s = NULL;
            break;
          case 1:
            if (opt.log)
              olog << ind(3) << "Unshared copy" << std::endl;
            if (s->status() != Gecode::SS_FAILED) {
              sc = static_cast<SetTestSpace*>(s->clone(true));
            } else {
              sc = s; s = NULL;
            }
            break;
          case 2:
            if (opt.log)
              olog << ind(3) << "Unshared copy" << std::endl;
            if (s->status() != Gecode::SS_FAILED) {
              sc = static_cast<SetTestSpace*>(s->clone(false));
            } else {
              sc = s; s = NULL;
            }
            break;
          default: assert(false);          
        }
        sc->assign(a);
        if (is_sol) {
          CHECK_TEST(!sc->failed(), "Failed on solution");
          CHECK_TEST(sc->propagators()==0, "No subsumption");
        } else {
          CHECK_TEST(sc->failed(), "Solved on non-solution");
        }
        delete s; delete sc;
      }
      if (opt.reflection) {
        START_TEST("Assignment (after posting + reflection)");
        {
          SetTestSpace* s = new SetTestSpace(arity,lub,withInt,false,this);
          SetTestSpace* sc = NULL;
          s->post();
          if (opt.log)
            olog << ind(3) << "Reflection copy" << std::endl;
          sc = s->cloneWithReflection();
          if (sc == s)
            s = NULL;
          CHECK_TEST(sc != NULL, "Reflection error");
          sc->assign(a);
          if (is_sol) {
            CHECK_TEST(!sc->failed(), "Failed on solution");
            CHECK_TEST(sc->propagators()==0, "No subsumption");
          } else {
            CHECK_TEST(sc->failed(), "Solved on non-solution");
          }
          delete s; delete sc;
        }
      }
      START_TEST("Assignment (before posting)");
      {
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,false,this);
        s->assign(a);
        s->post();
        if (is_sol) {
          CHECK_TEST(!s->failed(), "Failed on solution");
          CHECK_TEST(s->propagators()==0, "No subsumption");
        } else {
          CHECK_TEST(s->failed(), "Solved on non-solution");
        }
        delete s;
      }
      if (reified) {
        START_TEST("Assignment reified (before posting)");
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,true,this);
        s->assign(a);
        s->post();
        CHECK_TEST(!s->failed(), "Failed");
        CHECK_TEST(s->propagators()==0, "No subsumption");
        CHECK_TEST(s->b.assigned(), "Control variable unassigned");
        if (is_sol) {
          CHECK_TEST(s->b.val()==1, "Zero on solution");
        } else {
          CHECK_TEST(s->b.val()==0, "One on non-solution");
        }
        delete s;
      }
      if (reified) {
        START_TEST("Assignment reified (after posting)");
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,true,this);
        s->post();
        s->assign(a);
        CHECK_TEST(!s->failed(), "Failed");
        CHECK_TEST(s->propagators()==0, "No subsumption");
        CHECK_TEST(s->b.assigned(), "Control variable unassigned");
        if (is_sol) {
          CHECK_TEST(s->b.val()==1, "Zero on solution");
        } else {
          CHECK_TEST(s->b.val()==0, "One on non-solution");
        }
        delete s;
      }
      if (opt.reflection && reified) {
        START_TEST("Assignment reified (after posting + reflection)");
        {
          SetTestSpace* s = new SetTestSpace(arity,lub,withInt,true,this);
          SetTestSpace* sc = NULL;
          s->post();
          if (opt.log)
            olog << ind(3) << "Reflection copy" << std::endl;
          sc = s->cloneWithReflection();
          if (sc == s)
            s = NULL;
          CHECK_TEST(sc != NULL, "Reflection error");
          sc->assign(a);
          CHECK_TEST(!sc->failed(), "Failed");
          CHECK_TEST(sc->propagators()==0, "No subsumption");
          if (is_sol) {
            CHECK_TEST(sc->b.val()==1, "Zero on solution");
          } else {
            CHECK_TEST(sc->b.val()==0, "One on non-solution");
          }
          delete s; delete sc;
        }
      }
      START_TEST("Prune");
      {
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,false,this);
        s->post();
        while (!s->failed() && !s->assigned())
           if (!s->prune(a)) {
             problem = "No fixpoint";
             delete s;
             goto failed;
           }
        s->assign(a);
        if (is_sol) {
          CHECK_TEST(!s->failed(), "Failed on solution");
          CHECK_TEST(s->propagators()==0, "No subsumption");
        } else {
          CHECK_TEST(s->failed(), "Solved on non-solution");
        }
        delete s;
      }
      if (reified) {
        START_TEST("Prune reified");
        SetTestSpace* s = new SetTestSpace(arity,lub,withInt,true,this);
        s->post();
        while (!s->assigned() && !s->b.assigned())
           if (!s->prune(a)) {
             problem = "No fixpoint";
             delete s;
             goto failed;
           }
        CHECK_TEST(!s->failed(), "Failed");
        CHECK_TEST(s->propagators()==0, "No subsumption");
        CHECK_TEST(s->b.assigned(), "Control variable unassigned");
        if (is_sol) {
          CHECK_TEST(s->b.val()==1, "Zero on solution");
        } else {
          CHECK_TEST(s->b.val()==0, "One on non-solution");
        }
        delete s;
      }
      ++a;
    }
    delete ap;
    return true;
   failed:
        if (opt.log)
          olog << "FAILURE" << std::endl
               << ind(1) << "Test:       " << test << std::endl
               << ind(1) << "Problem:    " << problem << std::endl;
        if (a() && opt.log)
          olog << ind(1) << "Assignment: " << a << std::endl;
     delete ap;

     return false;
  }

  const Gecode::SetRelType SetRelTypes::srts[] = 
    {Gecode::SRT_EQ,Gecode::SRT_NQ,Gecode::SRT_SUB,
     Gecode::SRT_SUP,Gecode::SRT_DISJ,Gecode::SRT_CMPL};

  const Gecode::SetOpType SetOpTypes::sots[] = 
    {Gecode::SOT_UNION, Gecode::SOT_DUNION,
     Gecode::SOT_INTER, Gecode::SOT_MINUS};

}}

#undef START_TEST
#undef CHECK_TEST

// STATISTICS: test-set