branch.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>
 *
 *  Contributing authors:
 *     Samuel Gagnon <samuel.gagnon92@gmail.com>

 *  Copyright:
 *     Christian Schulte, 2012
 *     Samuel Gagnon, 2018
 *
 *  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_BRANCH_HH__
#define __GECODE_INT_BRANCH_HH__

#include <gecode/int.hh>

namespace Gecode { namespace Int { namespace Branch {

  template<class View>
  class MeritMin : public MeritBase<View,int> {
  public:
    using typename MeritBase<View,int>::Var;
    MeritMin(Space& home, const VarBranch<Var>& vb);
    MeritMin(Space& home, MeritMin& m);
    int operator ()(const Space& home, View x, int i);
  };

  template<class View>
  class MeritMax : public MeritBase<View,int> {
  public:
    using typename MeritBase<View,int>::Var;
    MeritMax(Space& home, const VarBranch<Var>& vb);
    MeritMax(Space& home, MeritMax& m);
    int operator ()(const Space& home, View x, int i);
  };

  template<class View>
  class MeritSize : public MeritBase<View,unsigned int> {
  public:
    using typename MeritBase<View,unsigned int>::Var;
    MeritSize(Space& home, const VarBranch<Var>& vb);
    MeritSize(Space& home, MeritSize& m);
    unsigned int operator ()(const Space& home, View x, int i);
  };

  template<class View>
  class MeritDegreeSize : public MeritBase<View,double> {
  public:
    using typename MeritBase<View,double>::Var;
    MeritDegreeSize(Space& home, const VarBranch<Var>& vb);
    MeritDegreeSize(Space& home, MeritDegreeSize& m);
    double operator ()(const Space& home, View x, int i);
  };

  template<class View>
  class MeritAFCSize : public MeritBase<View,double> {
    using typename MeritBase<View,double>::Var;
  protected:
    AFC afc;
  public:
    MeritAFCSize(Space& home, const VarBranch<Var>& vb);
    MeritAFCSize(Space& home, MeritAFCSize& m);
    double operator ()(const Space& home, View x, int i);
    bool notice(void) const;
    void dispose(Space& home);
  };

  template<class View>
  class MeritActionSize : public MeritBase<View,double> {
    using typename MeritBase<View,double>::Var;
  protected:
    Action action;
  public:
    MeritActionSize(Space& home, const VarBranch<Var>& vb);
    MeritActionSize(Space& home, MeritActionSize& m);
    double operator ()(const Space& home, View x, int i);
    bool notice(void) const;
    void dispose(Space& home);
  };

  template<class View>
  class MeritCHBSize : public MeritBase<View,double> {
    using typename MeritBase<View,double>::Var;
  protected:
    CHB chb;
  public:
    MeritCHBSize(Space& home, const VarBranch<Var>& vb);
    MeritCHBSize(Space& home, MeritCHBSize& m);
    double operator ()(const Space& home, View x, int i);
    bool notice(void) const;
    void dispose(Space& home);
  };

  template<class View>
  class MeritRegretMin : public MeritBase<View,unsigned int> {
  public:
    using typename MeritBase<View,unsigned int>::Var;
    MeritRegretMin(Space& home, const VarBranch<Var>& vb);
    MeritRegretMin(Space& home, MeritRegretMin& m);
    unsigned int operator ()(const Space& home, View x, int i);
  };

  template<class View>
  class MeritRegretMax : public MeritBase<View,unsigned int> {
  public:
    using typename MeritBase<View,unsigned int>::Var;
    MeritRegretMax(Space& home, const VarBranch<Var>& vb);
    MeritRegretMax(Space& home, MeritRegretMax& m);
    unsigned int operator ()(const Space& home, View x, int i);
  };

}}}

#include <gecode/int/branch/merit.hpp>

namespace Gecode { namespace Int { namespace Branch {

  GECODE_INT_EXPORT
  ViewSel<IntView>* viewsel(Space& home, const IntVarBranch& ivb);
  GECODE_INT_EXPORT
  ViewSel<BoolView>* viewsel(Space& home, const BoolVarBranch& bvb);

}}}

namespace Gecode { namespace Int { namespace Branch {

  template<class View>
  class ValSelMin : public ValSel<View,int> {
  public:
    using typename ValSel<View,int>::Var;
    ValSelMin(Space& home, const ValBranch<Var>& vb);
    ValSelMin(Space& home, ValSelMin& vs);
    int val(const Space& home, View x, int i);
  };

  template<class View>
  class ValSelMax : public ValSel<View,int> {
  public:
    using typename ValSel<View,int>::Var;
    ValSelMax(Space& home, const ValBranch<Var>& vb);
    ValSelMax(Space& home, ValSelMax& vs);
    int val(const Space& home, View x, int i);
  };

  template<class View>
  class ValSelMed : public ValSel<View,int> {
  public:
    using typename ValSel<View,int>::Var;
    ValSelMed(Space& home, const ValBranch<Var>& vb);
    ValSelMed(Space& home, ValSelMed& vs);
    int val(const Space& home, View x, int i);
  };

  template<class View>
  class ValSelAvg : public ValSel<View,int> {
  public:
    using typename ValSel<View,int>::Var;
    ValSelAvg(Space& home, const ValBranch<Var>& vb);
    ValSelAvg(Space& home, ValSelAvg& vs);
    int val(const Space& home, View x, int i);
  };

  template<class View>
  class ValSelRnd : public ValSel<View,int> {
    using typename ValSel<View,int>::Var;
  protected:
    Rnd r;
  public:
    ValSelRnd(Space& home, const ValBranch<Var>& vb);
    ValSelRnd(Space& home, ValSelRnd& vs);
    int val(const Space& home, View x, int i);
    bool notice(void) const;
    void dispose(Space& home);
  };

  class ValSelRangeMin : public ValSel<IntView,int> {
  public:
    ValSelRangeMin(Space& home, const ValBranch<IntVar>& vb);
    ValSelRangeMin(Space& home, ValSelRangeMin& vs);
    int val(const Space& home, IntView x, int i);
  };

  class ValSelRangeMax : public ValSel<IntView,int> {
  public:
    ValSelRangeMax(Space& home, const ValBranch<IntVar>& vb);
    ValSelRangeMax(Space& home, ValSelRangeMax& vs);
    int val(const Space& home, IntView x, int i);
  };

}}}

#include <gecode/int/branch/val-sel.hpp>

namespace Gecode { namespace Int { namespace Branch {

  template<class View>
  class EqNGL : public ViewValNGL<View,int,PC_INT_VAL> {
    using ViewValNGL<View,int,PC_INT_VAL>::x;
    using ViewValNGL<View,int,PC_INT_VAL>::n;
  public:
    EqNGL(Space& home, View x, int n);
    EqNGL(Space& home, EqNGL& ngl);
    virtual NGL::Status status(const Space& home) const;
    virtual ExecStatus prune(Space& home);
    virtual NGL* copy(Space& home);
  };

  template<class View>
  class NqNGL : public ViewValNGL<View,int,PC_INT_DOM> {
    using ViewValNGL<View,int,PC_INT_DOM>::x;
    using ViewValNGL<View,int,PC_INT_DOM>::n;
  public:
    NqNGL(Space& home, View x, int n);
    NqNGL(Space& home, NqNGL& ngl);
    virtual NGL::Status status(const Space& home) const;
    virtual ExecStatus prune(Space& home);
    virtual NGL* copy(Space& home);
  };

  template<class View>
  class LqNGL : public ViewValNGL<View,int,PC_INT_BND> {
    using ViewValNGL<View,int,PC_INT_BND>::x;
    using ViewValNGL<View,int,PC_INT_BND>::n;
  public:
    LqNGL(Space& home, View x, int n);
    LqNGL(Space& home, LqNGL& ngl);
    virtual NGL::Status status(const Space& home) const;
    virtual ExecStatus prune(Space& home);
    virtual NGL* copy(Space& home);
  };

  template<class View>
  class GqNGL : public ViewValNGL<View,int,PC_INT_BND> {
    using ViewValNGL<View,int,PC_INT_BND>::x;
    using ViewValNGL<View,int,PC_INT_BND>::n;
  public:
    GqNGL(Space& home, View x, int n);
    GqNGL(Space& home, GqNGL& ngl);
    virtual NGL::Status status(const Space& home) const;
    virtual ExecStatus prune(Space& home);
    virtual NGL* copy(Space& home);
  };

}}}

#include <gecode/int/branch/ngl.hpp>

namespace Gecode { namespace Int { namespace Branch {

  template<class View>
  class ValCommitEq : public ValCommit<View,int> {
  public:
    using typename ValCommit<View,int>::Var;
    ValCommitEq(Space& home, const ValBranch<Var>& vb);
    ValCommitEq(Space& home, ValCommitEq& vc);
    ModEvent commit(Space& home, unsigned int a, View x, int i, int n);
    NGL* ngl(Space& home, unsigned int a, View x, int n) const;
    void print(const Space& home, unsigned int a, View x, int i, int n,
               std::ostream& o) const;
  };

  template<class View>
  class ValCommitLq : public ValCommit<View,int> {
  public:
    using typename ValCommit<View,int>::Var;
    ValCommitLq(Space& home, const ValBranch<Var>& vb);
    ValCommitLq(Space& home, ValCommitLq& vc);
    ModEvent commit(Space& home, unsigned int a, View x, int i, int n);
    NGL* ngl(Space& home, unsigned int a, View x, int n) const;
    void print(const Space& home, unsigned int a, View x, int i, int n,
               std::ostream& o) const;
  };

  template<class View>
  class ValCommitGq : public ValCommit<View,int> {
  public:
    using typename ValCommit<View,int>::Var;
    ValCommitGq(Space& home, const ValBranch<Var>& vb);
    ValCommitGq(Space& home, ValCommitGq& vc);
    ModEvent commit(Space& home, unsigned int a, View x, int i, int n);
    NGL* ngl(Space& home, unsigned int a, View x, int n) const;
    void print(const Space& home, unsigned int a, View x, int i, int n,
               std::ostream& o) const;
  };

  template<class View>
  class ValCommitGr : public ValCommit<View,int> {
  public:
    using typename ValCommit<View,int>::Var;
    ValCommitGr(Space& home, const ValBranch<Var>& vb);
    ValCommitGr(Space& home, ValCommitGr& vc);
    ModEvent commit(Space& home, unsigned int a, View x, int i, int n);
    NGL* ngl(Space& home, unsigned int a, View x, int n) const;
    void print(const Space& home, unsigned int a, View x, int i, int n,
               std::ostream& o) const;
  };

}}}

#include <gecode/int/branch/val-commit.hpp>

namespace Gecode { namespace Int { namespace Branch {

  GECODE_INT_EXPORT
  ValSelCommitBase<IntView,int>*
  valselcommit(Space& home, const IntValBranch& ivb);

  GECODE_INT_EXPORT
  ValSelCommitBase<BoolView,int>*
  valselcommit(Space& home, const BoolValBranch& bvb);

  GECODE_INT_EXPORT
  ValSelCommitBase<IntView,int>*
  valselcommit(Space& home, const IntAssign& ia);

  GECODE_INT_EXPORT
  ValSelCommitBase<BoolView,int>*
  valselcommit(Space& home, const BoolAssign& ba);

}}}

namespace Gecode { namespace Int { namespace Branch {

  template<int n, bool min, class Filter, class Print>
  class ViewValuesBrancher : public ViewBrancher<IntView,Filter,n> {
  protected:
    using ViewBrancher<IntView,Filter,n>::x;
    using ViewBrancher<IntView,Filter,n>::f;
    Print p;
    ViewValuesBrancher(Space& home, ViewValuesBrancher& b);
    ViewValuesBrancher(Home home, ViewArray<IntView>& x,
                       ViewSel<IntView>* vs[n],
                       IntBranchFilter bf,
                       IntVarValPrint vvp);
  public:
    virtual const Choice* choice(Space& home);
    virtual const Choice* choice(const Space& home, Archive& e);
    virtual ExecStatus commit(Space& home, const Choice& c, unsigned int a);
    virtual NGL* ngl(Space& home, const Choice& c, unsigned int a) const;
    virtual void print(const Space& home, const Choice& c, unsigned int a,
                       std::ostream& o) const;
    virtual Actor* copy(Space& home);
    static void post(Home home, ViewArray<IntView>& x,
                     ViewSel<IntView>* vs[n],
                     IntBranchFilter bf,
                     IntVarValPrint vvp);
    virtual size_t dispose(Space& home);
  };

  template<int n, bool min>
  void postviewvaluesbrancher(Home home, ViewArray<IntView>& x,
                              ViewSel<IntView>* vs[n],
                              IntBranchFilter bf,
                              IntVarValPrint vvp);

}}}

#include <gecode/int/branch/view-values.hpp>

#ifdef GECODE_HAS_CBS

namespace Gecode { namespace Int { namespace Branch {

  template<class View>
  class CBSBrancher : public Brancher {
  private:
    ViewArray<View> x;

    class VarIdToPos : public SharedHandle {
    protected:
      class VarIdToPosO : public SharedHandle::Object {
      public:
        std::unordered_map<unsigned int, unsigned int> _varIdToPos;
      public:
        VarIdToPosO(void) = default;
        virtual ~VarIdToPosO(void) = default;
      };
    public:
      VarIdToPos(void) = default;
      void init(void);
      bool isIn(unsigned int var_id) const;
      int operator[](unsigned int var_id) const;
      void insert(unsigned int var_id, unsigned int pos);
    } varIdToPos;

    struct PropInfo {
      unsigned int domsum;
      unsigned int var_id;
      int val;
      double dens;
      bool visited;
    };

    std::unordered_map<unsigned int, PropInfo,
                       std::hash<unsigned int>,
                       std::equal_to<unsigned int>,
                       space_allocator<std::pair<const unsigned int, PropInfo>>>
    logProp;

  public:
    CBSBrancher(Home home, ViewArray<View>& x0);
    CBSBrancher(Space& home, CBSBrancher& b);
    static void post(Home home, ViewArray<View>& x);
    virtual Actor* copy(Space& home);
    virtual size_t dispose(Space& home);
    virtual bool status(const Space& home) const;
    virtual const Choice* choice(Space& home);
    virtual const Choice* choice(const Space&, Archive& e);
    virtual ExecStatus commit(Space& home, const Choice& c, unsigned int a);
    virtual void print(const Space& home, const Choice& c, unsigned int a,
                       std::ostream& o) const;
  private:
    bool inbrancher(unsigned int varId) const;
  };

}}}

#include <gecode/int/branch/cbs.hpp>

#endif

#endif

// STATISTICS: int-branch