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: 2011-08-24 16:34:16 +0200 (Wed, 24 Aug 2011) $ by $Author: tack $
 *     $Revision: 12346 $
 *
 *  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

// Configure auto-linking
#ifndef GECODE_BUILD_SET
#define GECODE_LIBRARY_NAME "Set"
#include <gecode/support/auto-link.hpp>
#endif


#include <gecode/set/exception.hpp>

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.hpp>

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

namespace Gecode {

  namespace Set {
    class SetView;
  }

  class SetVar : public VarImpVar<Set::SetVarImp> {
    friend class SetVarArray;
    friend class SetVarArgs;
    using VarImpVar<Set::SetVarImp>::x;
  public:


    SetVar(void);
    SetVar(const SetVar& y);
    SetVar(const Set::SetView& y);

    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;
  };


  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;
  };


  template<class Char, class Traits>
  std::basic_ostream<Char,Traits>&
  operator <<(std::basic_ostream<Char,Traits>& os, const SetVar& x);

}

#include <gecode/set/view.hpp>

namespace Gecode {

}

#include <gecode/set/array-traits.hpp>

namespace Gecode {

  class SetVarArgs : public VarArgArray<SetVar> {
  public:


    SetVarArgs(void) {}
    explicit SetVarArgs(int n) : VarArgArray<SetVar>(n) {}
    SetVarArgs(const SetVarArgs& a) : VarArgArray<SetVar>(a) {}
    SetVarArgs(const VarArray<SetVar>& a) : VarArgArray<SetVar>(a) {}
    GECODE_SET_EXPORT
    SetVarArgs(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
    SetVarArgs(Space& home,int n,const IntSet& glb,
               int lubMin, int lubMax,
               unsigned int minCard = 0,
               unsigned int maxCard = Set::Limits::card);
    GECODE_SET_EXPORT
    SetVarArgs(Space& home,int n,int glbMin,int glbMax,
               const IntSet& lub,
               unsigned int minCard = 0,
               unsigned int maxCard = Set::Limits::card);
    GECODE_SET_EXPORT
    SetVarArgs(Space& home,int n,
               const IntSet& glb,const IntSet& lub,
               unsigned int minCard = 0,
               unsigned int maxCard = Set::Limits::card);
  };

  class SetVarArray : public VarArray<SetVar> {
  public:


    SetVarArray(void);
    SetVarArray(const SetVarArray&);
    SetVarArray(Space& home, const SetVarArgs&);
    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.hpp>

namespace Gecode {

  enum SetRelType {
    SRT_EQ,   
    SRT_NQ,   
    SRT_SUB,  
    SRT_SUP,  
    SRT_DISJ, 
    SRT_CMPL, 
    SRT_LQ,   
    SRT_LE,   
    SRT_GQ,   
    SRT_GR    
  };

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


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

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

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

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

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

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

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




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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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




  GECODE_SET_EXPORT void
  convex(Home home, SetVar x);

  GECODE_SET_EXPORT void
  convex(Home home, SetVar x, SetVar y);



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

  GECODE_SET_EXPORT void
  sequence(Home home, const SetVarArgs& y, SetVar x);




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



  GECODE_SET_EXPORT void
  min(Home home, SetVar s, IntVar x);

  GECODE_SET_EXPORT void
  notMin(Home home, SetVar s, IntVar x);

  GECODE_SET_EXPORT void
  min(Home home, SetVar s, IntVar x, BoolVar b);

  GECODE_SET_EXPORT void
  max(Home home, SetVar s, IntVar x);

  GECODE_SET_EXPORT void
  notMax(Home home, SetVar s, IntVar x);

  GECODE_SET_EXPORT void
  max(Home home, SetVar s, IntVar x, BoolVar b);

  GECODE_SET_EXPORT void
  channelSorted(Home home, const IntVarArgs& x, SetVar y);

  GECODE_SET_EXPORT void
  channel(Home home, const IntVarArgs& x,const SetVarArgs& y);

  GECODE_SET_EXPORT void
  channel(Home home, const BoolVarArgs& x, SetVar y);

  GECODE_SET_EXPORT void
  cardinality(Home home, SetVar s, IntVar x);


  GECODE_SET_EXPORT void
  weights(Home home, IntSharedArray elements, IntSharedArray weights,
          SetVar x, IntVar y);


  GECODE_SET_EXPORT void
  precede(Home home, const SetVarArgs& x, int s, int t);
  GECODE_SET_EXPORT void
  precede(Home home, const SetVarArgs& x, const IntArgs& c);


  GECODE_SET_EXPORT void
  element(Home home, SetOpType op, const SetVarArgs& x, SetVar y, SetVar z,
    const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));

  GECODE_SET_EXPORT void
  element(Home home, SetOpType op, const IntVarArgs& x, SetVar y, SetVar z,
          const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));

  GECODE_SET_EXPORT void
  element(Home home, SetOpType op, const IntSetArgs& x, SetVar y, SetVar z,
          const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));

  GECODE_SET_EXPORT void
  element(Home home, SetOpType op, const IntArgs& x, SetVar y, SetVar z,
          const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));

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

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

  GECODE_SET_EXPORT void
  element(Home home, const IntSetArgs& a, 
          IntVar x, int w, IntVar y, int h, SetVar z);
  GECODE_SET_EXPORT void
  element(Home home, const SetVarArgs& a, 
          IntVar x, int w, IntVar y, int h, SetVar z);


  GECODE_SET_EXPORT void
  wait(Home home, SetVar x, void (*c)(Space& home));
  GECODE_SET_EXPORT void
  wait(Home home, const SetVarArgs& x, void (*c)(Space& home));


  enum SetVarBranch {
    SET_VAR_NONE = 0,   
    SET_VAR_RND,        
    SET_VAR_DEGREE_MIN, 
    SET_VAR_DEGREE_MAX, 
    SET_VAR_AFC_MIN,    
    SET_VAR_AFC_MAX,    
    SET_VAR_MIN_MIN,    
    SET_VAR_MIN_MAX,    
    SET_VAR_MAX_MIN,    
    SET_VAR_MAX_MAX,    
    SET_VAR_SIZE_MIN,   
    SET_VAR_SIZE_MAX,   
    SET_VAR_SIZE_DEGREE_MIN, 
    SET_VAR_SIZE_DEGREE_MAX, 
    SET_VAR_SIZE_AFC_MIN, 
    SET_VAR_SIZE_AFC_MAX  
  };

  enum SetValBranch {
    SET_VAL_MIN_INC, 
    SET_VAL_MIN_EXC, 
    SET_VAL_MED_INC, 
    SET_VAL_MED_EXC, 
    SET_VAL_MAX_INC, 
    SET_VAL_MAX_EXC, 
    SET_VAL_RND_INC, 
    SET_VAL_RND_EXC  
  };

  GECODE_SET_EXPORT void
  branch(Home home, const SetVarArgs& x,
         SetVarBranch vars, SetValBranch vals,
         const VarBranchOptions& o_vars = VarBranchOptions::def,
         const ValBranchOptions& o_vals = ValBranchOptions::def);
  GECODE_SET_EXPORT void
  branch(Home home, const SetVarArgs& x,
         const TieBreakVarBranch<SetVarBranch>& vars, SetValBranch vals,
         const TieBreakVarBranchOptions& o_vars = TieBreakVarBranchOptions::def,
         const ValBranchOptions& o_vals = ValBranchOptions::def);
  GECODE_SET_EXPORT void
  branch(Home home, SetVar x, SetValBranch vals,
         const ValBranchOptions& o_vals = ValBranchOptions::def);


  enum SetAssign {
    SET_ASSIGN_MIN_INC, 
    SET_ASSIGN_MIN_EXC, 
    SET_ASSIGN_MED_INC, 
    SET_ASSIGN_MED_EXC, 
    SET_ASSIGN_MAX_INC, 
    SET_ASSIGN_MAX_EXC, 
    SET_ASSIGN_RND_INC, 
    SET_ASSIGN_RND_EXC  
  };

  GECODE_SET_EXPORT void
  assign(Home home, const SetVarArgs& x, SetAssign vals,
         const ValBranchOptions& o_vals = ValBranchOptions::def);
  GECODE_SET_EXPORT void
  assign(Home home, SetVar x, SetAssign vals,
         const ValBranchOptions& o_vals = ValBranchOptions::def);


}

#endif

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