var-imp.hpp

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *
 *  Contributing authors:
 *     Christian Schulte <schulte@gecode.org>
 *     Gabor Szokoli <szokoli@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2004
 *     Christian Schulte, 2004
 *     Gabor Szokoli, 2004
 *
 *  Last modified:
 *     $Date: 2011-09-06 10:22:20 +0200 (Tue, 06 Sep 2011) $ by $Author: tack $
 *     $Revision: 12392 $
 *
 *  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 <iostream>

namespace Gecode { namespace Set {

  class SetVarImp;
  class LUBndSet;
  class GLBndSet;

  class SetDelta : public Delta {
    friend class SetVarImp;
    friend class LUBndSet;
    friend class GLBndSet;
  private:
    int _glbMin; 
    int _glbMax; 
    int _lubMin; 
    int _lubMax; 
  public:
    SetDelta(void);
    SetDelta(int glbMin, int glbMax, int lubMin, int lubMax);
    int glbMin(void) const;
    int glbMax(void) const;
    int lubMin(void) const;
    int lubMax(void) const;
    bool glbAny(void) const;
    bool lubAny(void) const;
  };

}}

#include <gecode/set/var-imp/delta.hpp>

namespace Gecode { namespace Set {

  class BndSet  {
  private:
    RangeList* first;
    RangeList* last;
  protected:
    unsigned int _size;
    unsigned int _card;
    void fst(RangeList* r);
    void lst(RangeList* r);

    RangeList* fst(void) const;
    RangeList* lst(void) const;

  public:
    static const int MAX_OF_EMPTY = Limits::min-1;
    static const int MIN_OF_EMPTY = Limits::max+1;



    BndSet(void);
    BndSet(Space& home, int i, int j);
    GECODE_SET_EXPORT BndSet(Space& home, const IntSet& s);



    void dispose(Space& home);



    int min(void) const;
    int max(void) const;
    int minN(unsigned int n) const;
    unsigned int size(void) const;
    unsigned int card(void) const;
    void card(unsigned int c);



    bool empty(void) const;
    bool in(int i) const;



    void become(Space& home, const BndSet& s);



    RangeList* ranges(void) const;

  protected:
    template<class I> bool overwrite(Space& home,I& i);

  public:


    void update(Space& home, BndSet& x);

    GECODE_SET_EXPORT bool isConsistent(void) const;
  };

  class BndSetRanges : public Iter::Ranges::RangeList {
  public:


    BndSetRanges(void);
    BndSetRanges(const BndSet& s);
    void init(const BndSet& s);
  };

  class GLBndSet : public BndSet {
  private:
    GECODE_SET_EXPORT bool include_full(Space& home,int,int,SetDelta&);
  public:


    GLBndSet(void);
    GLBndSet(Space&);
    GLBndSet(Space& home, int i, int j);
    GLBndSet(Space& home, const IntSet& s);
    void init(Space& home);



    bool include(Space& home,int i,int j,SetDelta& d);
    template<class I> bool includeI(Space& home,I& i);
  private:
    GLBndSet(const GLBndSet&);
    const GLBndSet& operator =(const GLBndSet&);
  };

  class LUBndSet: public BndSet{
  private:
    GECODE_SET_EXPORT bool exclude_full(Space& home, int, int, SetDelta&);
    GECODE_SET_EXPORT bool intersect_full(Space& home, int i, int j);
  public:


    LUBndSet(void);
    LUBndSet(Space& home);
    LUBndSet(Space& home, int i, int j);
    LUBndSet(Space& home, const IntSet& s);
    void init(Space& home);



    bool exclude(Space& home, int i, int j, SetDelta& d);
    bool intersect(Space& home, int i, int j);
    template<class I> bool intersectI(Space& home, I& i);
    template<class I> bool excludeI(Space& home, I& i);
    void excludeAll(Space& home);
  private:
    LUBndSet(const LUBndSet&);
    const LUBndSet& operator =(const LUBndSet&);
  };

  /*
   * Iterators
   *
   */


  template<class I>
  class RangesCompl :
    public Iter::Ranges::Compl<Limits::min, Limits::max, I> {
  public:


    RangesCompl(void);
    RangesCompl(I& i);
    void init(I& i);
  };

  template<class T> class LubRanges {
  public:


    LubRanges(void);
    LubRanges(const T& x);
    void init(const T& x);



    bool operator ()(void) const;
    void operator ++(void);



    int min(void) const;
    int max(void) const;
    unsigned int width(void) const;
  };

  template<class T> class GlbRanges {
  public:


    GlbRanges(void);
    GlbRanges(const T& x);
    void init(const T& x);



    bool operator ()(void) const;
    void operator ++(void);



    int min(void) const;
    int max(void) const;
    unsigned int width(void) const;
  };

  template<class T>
  class UnknownRanges : public Iter::Ranges::Diff<LubRanges<T>, GlbRanges<T> >{
  private:
    LubRanges<T> i1;
    GlbRanges<T> i2;
  public:


    UnknownRanges(void);
    UnknownRanges(const T& x);
    void init(const T& x);
  };

}}

#include <gecode/set/var-imp/integerset.hpp>
#include <gecode/set/var-imp/iter.hpp>

namespace Gecode { namespace Set {

  class SetVarImp : public SetVarImpBase {
    friend class LubRanges<SetVarImp*>;
    friend class GlbRanges<SetVarImp*>;
  private:
    LUBndSet lub;
    GLBndSet glb;

  protected:
    SetVarImp(Space& home, bool share, SetVarImp& x);
  public:


    SetVarImp(Space& home);
    SetVarImp(Space& home,int glbMin,int glbMax,int lubMin,int lubMax,
               unsigned int cardMin = 0,
               unsigned int cardMax = Limits::card);
    SetVarImp(Space& home,const IntSet& glbD,int lubMin,int lubMax,
              unsigned int cardMin,unsigned int cardMax);
    SetVarImp(Space& home,int glbMin,int glbMax,const IntSet& lubD,
              unsigned int cardMin,unsigned int cardMax);
    SetVarImp(Space& home,const IntSet& glbD,const IntSet& lubD,
              unsigned int cardMin,unsigned int cardMax);



    unsigned int cardMin(void) const;
    unsigned int cardMax(void) const;
    int lubMin(void) const;
    int lubMax(void) const;
    int lubMinN(unsigned int n) const;
    int glbMin(void) const;
    int glbMax(void) const;
    unsigned int glbSize(void) const;
    unsigned int lubSize(void) const;



    bool assigned(void) const;
    bool knownIn(int n) const;
    bool knownOut(int) const;

  private:


    template<class I> ModEvent includeI_full(Space& home,int mi, int ma, I& i);
    template<class I> ModEvent excludeI_full(Space& home,int mi, int ma, I& i);
    template<class I> ModEvent intersectI_full(Space& home,int mi, int ma, I& i);

    GECODE_SET_EXPORT ModEvent processLubChange(Space& home, SetDelta& d);
    GECODE_SET_EXPORT ModEvent processGlbChange(Space& home, SetDelta& d);



    GECODE_SET_EXPORT ModEvent cardMin_full(Space& home);
    GECODE_SET_EXPORT ModEvent cardMax_full(Space& home);

  public:



    ModEvent include(Space& home,int n);
    ModEvent include(Space& home,int i,int j);
    ModEvent exclude(Space& home,int n);
    ModEvent exclude(Space& home,int i,int j);
    ModEvent intersect(Space& home,int n);
    ModEvent intersect(Space& home,int i,int j);
    ModEvent cardMin(Space& home,unsigned int n);
    ModEvent cardMax(Space& home,unsigned int n);



    template<class I> ModEvent includeI(Space& home,I& i);
    template<class I> ModEvent excludeI(Space& home,I& i);
    template<class I> ModEvent intersectI(Space& home,I& i);

  public:


    void subscribe(Space& home, Propagator& p, PropCond pc, bool schedule=true);
    void cancel(Space& home, Propagator& p, PropCond pc);
    void subscribe(Space& home, Advisor& a);
    void cancel(Space& home, Advisor& a);

  private:
    GECODE_SET_EXPORT SetVarImp* perform_copy(Space& home, bool share);

  public:


    SetVarImp* copy(Space& home, bool share);



    static int glbMin(const Delta& d);
    static int glbMax(const Delta& d);
    static bool glbAny(const Delta& d);
    static int lubMin(const Delta& d);
    static int lubMax(const Delta& d);
    static bool lubAny(const Delta& d);

  };

  class SetView;

}}

#include <gecode/set/var-imp/set.hpp>

// STATISTICS: set-var