set.hh

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>
 *
 *  Contributing authors:
 *     Gabor Szokoli <szokoli@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2004
 *     Christian Schulte, 2004
 *     Gabor Szokoli, 2004
 *
 *  Last modified:
 *     $Date: 2008-07-11 10:35:42 +0200 (Fri, 11 Jul 2008) $ by $Author: tack $
 *     $Revision: 7339 $
 *
 *  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_SET_HH__
#define __GECODE_SET_HH__

#include "gecode/kernel.hh"
#include "gecode/int.hh"
#include "gecode/iter.hh"

/*
 * Configure linking
 *
 */
#if !defined(GECODE_STATIC_LIBS) && \
    (defined(__CYGWIN__) || defined(__MINGW32__) || defined(_MSC_VER))

#ifdef GECODE_BUILD_SET
#define GECODE_SET_EXPORT __declspec( dllexport )
#else
#define GECODE_SET_EXPORT __declspec( dllimport )
#endif

#else

#ifdef GECODE_GCC_HAS_CLASS_VISIBILITY
#define GECODE_SET_EXPORT __attribute__ ((visibility("default")))
#else
#define GECODE_SET_EXPORT
#endif

#endif

#include "gecode/set/exception.icc"

namespace Gecode { namespace Set {

  namespace Limits {
    const int max = (Gecode::Int::Limits::max / 2) - 1;
    const int min = -max;
    const unsigned int card = max-min+1;
    void check(int n, const char* l);
    void check(unsigned int n, const char* l);
    void check(const IntSet& s, const char* l);
  }

}}

#include "gecode/set/limits.icc"

#include "gecode/set/var-imp.icc"

namespace Gecode {
  
  namespace Set {
    class SetView;
  }

  class SetVar : public VarBase<Set::SetVarImp> {
    friend class SetVarArray;
  private:
    using VarBase<Set::SetVarImp>::varimp;
    void init(Space* home);
    void init(Space* home,int glbMin,int glbMax,int lubMin,int lubMax,
              unsigned int cardMin = 0,
              unsigned int cardMax = Set::Limits::card);
    void init(Space* home,const IntSet& glbD,int lubMin,int lubMax,
              unsigned int cardMin = 0,
              unsigned int cardMax = Set::Limits::card);
    void init(Space* home,int glbMin,int glbMax,const IntSet& lubD,
              unsigned int cardMin = 0,
              unsigned int cardMax = Set::Limits::card);
    void init(Space* home,const IntSet& glbD,const IntSet& lubD,
              unsigned int cardMin = 0,
              unsigned int cardMax = Set::Limits::card);
  public:


    SetVar(void);
    SetVar(const SetVar& x0);
    SetVar(const Set::SetView& x0);
    SetVar(const Reflection::Var& x0);

    GECODE_SET_EXPORT SetVar(Space* home);

    GECODE_SET_EXPORT 
    SetVar(Space* home,int glbMin,int glbMax,int lubMin,int lubMax,
           unsigned int cardMin = 0,
           unsigned int cardMax = Set::Limits::card);

    GECODE_SET_EXPORT 
    SetVar(Space* home,const IntSet& glbD,int lubMin,int lubMax,
           unsigned int cardMin = 0,
           unsigned int cardMax = Set::Limits::card);

    GECODE_SET_EXPORT 
    SetVar(Space* home,int glbMin,int glbMax,const IntSet& lubD,
           unsigned int cardMin = 0,
           unsigned int cardMax = Set::Limits::card);

    GECODE_SET_EXPORT 
    SetVar(Space* home,const IntSet& glbD,const IntSet& lubD,
           unsigned int cardMin = 0,
           unsigned int cardMax = Set::Limits::card);



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



    bool contains(int i) const;
    bool notContains(int i) const;
    bool assigned(void) const;



    void update(Space* home, bool, SetVar& x);
  };


  class SetVarGlbRanges {
  private:
    Set::GlbRanges<Set::SetVarImp*> iter;
  public:


    SetVarGlbRanges(void);
    SetVarGlbRanges(const SetVar& x);



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



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

  class SetVarLubRanges {
  private:
    Set::LubRanges<Set::SetVarImp*> iter;
  public:


    SetVarLubRanges(void);
    SetVarLubRanges(const SetVar& x);



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



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

  class SetVarUnknownRanges {
  private:
    Set::UnknownRanges<Set::SetVarImp*> iter;
  public:


    SetVarUnknownRanges(void);
    SetVarUnknownRanges(const SetVar& x);



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



    int min(void) const;
    int max(void) const;
    unsigned int width(void) const;
  };
  
  class SetVarGlbValues {
  private:
    Iter::Ranges::ToValues<SetVarGlbRanges> iter;
  public:


    SetVarGlbValues(void);
    SetVarGlbValues(const SetVar& x);



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



    int  val(void) const;
  };

  class SetVarLubValues {
  private:
    Iter::Ranges::ToValues<SetVarLubRanges> iter;
  public:


    SetVarLubValues(void);
    SetVarLubValues(const SetVar& x);



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



    int  val(void) const;
  };

  class SetVarUnknownValues {
  private:
    Iter::Ranges::ToValues<SetVarUnknownRanges> iter;
  public:


    SetVarUnknownValues(void);
    SetVarUnknownValues(const SetVar& x);



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



    int  val(void) const;
  };


}

GECODE_SET_EXPORT std::ostream&
operator<<(std::ostream&, const Gecode::SetVar& x);

#include "gecode/set/view.icc"
#include "gecode/set/propagator.icc"

namespace Gecode {

  typedef PrimArgArray<IntSet> IntSetArgs;
  typedef VarArgArray<SetVar>  SetVarArgs;

  class SetVarArray : public VarArray<SetVar> {
  public:
    SetVarArray(void);
    SetVarArray(const SetVarArray&);
    GECODE_SET_EXPORT SetVarArray(Space* home,int n);
    GECODE_SET_EXPORT 
    SetVarArray(Space* home,int n,int glbMin,int glbMax,int lubMin,int lubMax,
                unsigned int minCard = 0,
                unsigned int maxCard = Set::Limits::card);
    GECODE_SET_EXPORT 
    SetVarArray(Space* home,int n,const IntSet& glb, int lubMin, int lubMax,
                unsigned int minCard = 0,
                unsigned int maxCard = Set::Limits::card);
    GECODE_SET_EXPORT 
    SetVarArray(Space* home,int n,int glbMin,int glbMax,const IntSet& lub,
                unsigned int minCard = 0,
                unsigned int maxCard = Set::Limits::card);
    GECODE_SET_EXPORT 
    SetVarArray(Space* home,int n,
                const IntSet& glb,const IntSet& lub,
                unsigned int minCard = 0,
                unsigned int maxCard = Set::Limits::card);
  };

}

#include "gecode/set/array.icc"

namespace Gecode {

  enum SetRelType {
    SRT_EQ,   
    SRT_NQ,   
    SRT_SUB,  
    SRT_SUP,  
    SRT_DISJ, 
    SRT_CMPL  
  };

  enum SetOpType {
    SOT_UNION,  
    SOT_DUNION, 
    SOT_INTER,  
    SOT_MINUS   
  };


  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, int i);

  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, int i, int j);

  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, const IntSet& s);

  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, int i, BoolVar b);

  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, int i, int j, BoolVar b);

  GECODE_SET_EXPORT void
  dom(Space* home, SetVar x, SetRelType r, const IntSet& s, BoolVar b);

  GECODE_SET_EXPORT void
  cardinality(Space* home, SetVar x, unsigned int i, unsigned int j);




  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetRelType r, SetVar y);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetRelType r, SetVar y, BoolVar b);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar s, SetRelType r, IntVar x);

  GECODE_SET_EXPORT void
  rel(Space* home, IntVar x, SetRelType r, SetVar s);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar s, SetRelType r, IntVar x, BoolVar b);

  GECODE_SET_EXPORT void
  rel(Space* home, IntVar x, SetRelType r, SetVar s, BoolVar b);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar s, IntRelType r, IntVar x);

  GECODE_SET_EXPORT void
  rel(Space* home, IntVar x, IntRelType r, SetVar s);



  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetOpType op, SetVar y, SetRelType r, SetVar z);

  GECODE_SET_EXPORT void
  rel(Space* home, SetOpType op, const SetVarArgs& x, SetVar y);

  GECODE_SET_EXPORT void
  rel(Space* home, SetOpType op, const SetVarArgs& x, const IntSet& z, SetVar y);

  GECODE_SET_EXPORT void
  rel(Space* home, SetOpType op, const IntVarArgs& x, const IntSet& z, SetVar y);

  GECODE_SET_EXPORT void
  rel(Space* home, SetOpType op, const IntVarArgs& x, SetVar y);

  GECODE_SET_EXPORT void
  rel(Space* home, const IntSet& x, SetOpType op, SetVar y,
      SetRelType r, SetVar z);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetOpType op, const IntSet& y,
      SetRelType r, SetVar z);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetOpType op, SetVar y,
      SetRelType r, const IntSet& z);

  GECODE_SET_EXPORT void
  rel(Space* home, const IntSet& x, SetOpType op, SetVar y, SetRelType r,
      const IntSet& z);

  GECODE_SET_EXPORT void
  rel(Space* home, SetVar x, SetOpType op, const IntSet& y, SetRelType r,
      const IntSet& z);




  GECODE_SET_EXPORT void
  convex(Space* home, SetVar x);

  GECODE_SET_EXPORT void
  convexHull(Space* home, SetVar x, SetVar y);



  GECODE_SET_EXPORT void
  sequence(Space* home, const SetVarArgs& x);

  GECODE_SET_EXPORT void
  sequentialUnion(Space* home, const SetVarArgs& y, SetVar x);




  GECODE_SET_EXPORT void
  atmostOne(Space* home, const SetVarArgs& x, unsigned int c);



  GECODE_SET_EXPORT void
  min(Space* home, SetVar s, IntVar x);
  
  GECODE_SET_EXPORT void
  max(Space* home, SetVar s, IntVar x);
  
  GECODE_SET_EXPORT void
  match(Space* home, SetVar s, const IntVarArgs& x);
  
  GECODE_SET_EXPORT void
  channel(Space* home, const IntVarArgs& x,const SetVarArgs& y);

  GECODE_SET_EXPORT void
  channel(Space* home, const BoolVarArgs& x, SetVar y);
  
  GECODE_SET_EXPORT void
  cardinality(Space* home, SetVar s, IntVar x);


  GECODE_SET_EXPORT void
  weights(Space* home, const IntArgs& elements, const IntArgs& weights,
          SetVar x, IntVar y);



  GECODE_SET_EXPORT void
  elementsUnion(Space* home, const SetVarArgs& x, SetVar y, SetVar z);

  GECODE_SET_EXPORT void
  elementsUnion(Space* home, const IntSetArgs& s, SetVar y, SetVar z);

  GECODE_SET_EXPORT void
  elementsInter(Space* home, const SetVarArgs& x, SetVar y, SetVar z);

  GECODE_SET_EXPORT void
  elementsInter(Space* home, const SetVarArgs& x, SetVar y, SetVar z,
               const IntSet& u);

  GECODE_SET_EXPORT void
  elementsDisjoint(Space* home, const SetVarArgs& x, SetVar y);

  GECODE_SET_EXPORT void
  element(Space* home, const SetVarArgs& x, IntVar y, SetVar z);

  GECODE_SET_EXPORT void
  element(Space* home, const IntSetArgs& s, IntVar y, SetVar z);


  
  enum SetVarBranch {
    SET_VAR_NONE,               
    SET_VAR_MIN_CARD,           
    SET_VAR_MAX_CARD,           
    SET_VAR_MIN_UNKNOWN_ELEM,   
    SET_VAR_MAX_UNKNOWN_ELEM    
  };
  
  enum SetValBranch {
    SET_VAL_MIN,                
    SET_VAL_MAX                 
  };

  GECODE_SET_EXPORT void
  branch(Space* home, const SetVarArgs& x, 
         SetVarBranch vars, SetValBranch vals);

}

#endif

// IFDEF: GECODE_HAS_SET_VARS
// STATISTICS: set-post