/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */ /* * Main authors: * Christian Schulte * * Contributing authors: * Samuel Gagnon * 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 /** * \namespace Gecode::Int::Branch * \brief Integer branchers */ namespace Gecode { namespace Int { namespace Branch { /** * \defgroup FuncIntViewSel Merit-based integer view selection for branchers * * Contains merit-based view selection strategies on integer * views that can be used together with the generic view/value * brancher classes. * * All merit-based view selection classes require * \code #include \endcode * \ingroup Other */ /** * \brief Merit class for mimimum of integer views * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritMin : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritMin(Space& home, const VarBranch& vb); /// Constructor for cloning MeritMin(Space& home, MeritMin& m); /// Return minimum as merit for view \a x at position \a i int operator ()(const Space& home, View x, int i); }; /** * \brief Merit class for maximum * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritMax : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritMax(Space& home, const VarBranch& vb); /// Constructor for cloning MeritMax(Space& home, MeritMax& m); /// Return maximum as merit for view \a x at position \a i int operator ()(const Space& home, View x, int i); }; /** * \brief Merit class for size * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritSize : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritSize(Space& home, const VarBranch& vb); /// Constructor for cloning MeritSize(Space& home, MeritSize& m); /// Return size as merit for view \a x at position \a i unsigned int operator ()(const Space& home, View x, int i); }; /** * \brief Merit class for degree over size * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritDegreeSize : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritDegreeSize(Space& home, const VarBranch& vb); /// Constructor for cloning MeritDegreeSize(Space& home, MeritDegreeSize& m); /// Return degree over size as merit for view \a x at position \a i double operator ()(const Space& home, View x, int i); }; /** * \brief Merit class for AFC over size * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritAFCSize : public MeritBase { using typename MeritBase::Var; protected: /// AFC information AFC afc; public: /// Constructor for initialization MeritAFCSize(Space& home, const VarBranch& vb); /// Constructor for cloning MeritAFCSize(Space& home, MeritAFCSize& m); /// Return AFC over size as merit for view \a x at position \a i double operator ()(const Space& home, View x, int i); /// Whether dispose must always be called (that is, notice is needed) bool notice(void) const; /// Dispose view selection void dispose(Space& home); }; /** * \brief Merit class for action over size * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritActionSize : public MeritBase { using typename MeritBase::Var; protected: /// Action information Action action; public: /// Constructor for initialization MeritActionSize(Space& home, const VarBranch& vb); /// Constructor for cloning MeritActionSize(Space& home, MeritActionSize& m); /// Return action over size as merit for view \a x at position \a i double operator ()(const Space& home, View x, int i); /// Whether dispose must always be called (that is, notice is needed) bool notice(void) const; /// Dispose view selection void dispose(Space& home); }; /** * \brief Merit class for CHB over size * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritCHBSize : public MeritBase { using typename MeritBase::Var; protected: /// CHB information CHB chb; public: /// Constructor for initialization MeritCHBSize(Space& home, const VarBranch& vb); /// Constructor for cloning MeritCHBSize(Space& home, MeritCHBSize& m); /// Return size over action as merit for view \a x at position \a i double operator ()(const Space& home, View x, int i); /// Whether dispose must always be called (that is, notice is needed) bool notice(void) const; /// Dispose view selection void dispose(Space& home); }; /** * \brief Merit class for minimum regret * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritRegretMin : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritRegretMin(Space& home, const VarBranch& vb); /// Constructor for cloning MeritRegretMin(Space& home, MeritRegretMin& m); /// Return minimum regret as merit for view \a x at position \a i unsigned int operator ()(const Space& home, View x, int i); }; /** * \brief Merit class for maximum regret * * Requires \code #include \endcode * \ingroup FuncIntViewSel */ template class MeritRegretMax : public MeritBase { public: using typename MeritBase::Var; /// Constructor for initialization MeritRegretMax(Space& home, const VarBranch& vb); /// Constructor for cloning MeritRegretMax(Space& home, MeritRegretMax& m); /// Return maximum regret as merit for view \a x at position \a i unsigned int operator ()(const Space& home, View x, int i); }; }}} #include namespace Gecode { namespace Int { namespace Branch { /// Return view selectors for integer views GECODE_INT_EXPORT ViewSel* viewsel(Space& home, const IntVarBranch& ivb); /// Return view selectors for Boolean views GECODE_INT_EXPORT ViewSel* viewsel(Space& home, const BoolVarBranch& bvb); }}} namespace Gecode { namespace Int { namespace Branch { /** * \defgroup FuncIntValSel Integer value selection for brancher * * Contains a description of value selection strategies on integer * views that can be used together with the generic view/value * branchers. * * All value selection classes require * \code #include \endcode * \ingroup Other */ /** * \brief Value selection class for mimimum of view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ template class ValSelMin : public ValSel { public: using typename ValSel::Var; /// Constructor for initialization ValSelMin(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelMin(Space& home, ValSelMin& vs); /// Return value of view \a x at position \a i int val(const Space& home, View x, int i); }; /** * \brief Value selection class for maximum of view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ template class ValSelMax : public ValSel { public: using typename ValSel::Var; /// Constructor for initialization ValSelMax(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelMax(Space& home, ValSelMax& vs); /// Return value of view \a x at position \a i int val(const Space& home, View x, int i); }; /** * \brief Value selection class for median of view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ template class ValSelMed : public ValSel { public: using typename ValSel::Var; /// Constructor for initialization ValSelMed(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelMed(Space& home, ValSelMed& vs); /// Return value of view \a x at position i int val(const Space& home, View x, int i); }; /** * \brief Value selection class for average of view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ template class ValSelAvg : public ValSel { public: using typename ValSel::Var; /// Constructor for initialization ValSelAvg(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelAvg(Space& home, ValSelAvg& vs); /// Return value of view \a x at position \a i int val(const Space& home, View x, int i); }; /** * \brief Value selection class for random value of view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ template class ValSelRnd : public ValSel { using typename ValSel::Var; protected: /// The used random number generator Rnd r; public: /// Constructor for initialization ValSelRnd(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelRnd(Space& home, ValSelRnd& vs); /// Return value of view \a x at position \a i int val(const Space& home, View x, int i); /// Whether dispose must always be called (that is, notice is needed) bool notice(void) const; /// Delete value selection void dispose(Space& home); }; /** * \brief Value selection class for minimum range of integer view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ class ValSelRangeMin : public ValSel { public: /// Constructor for initialization ValSelRangeMin(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelRangeMin(Space& home, ValSelRangeMin& vs); /// Return value of integer view \a x at position \a i int val(const Space& home, IntView x, int i); }; /** * \brief Value selection class for maximum range of integer view * * Requires \code #include \endcode * \ingroup FuncIntValSel */ class ValSelRangeMax : public ValSel { public: /// Constructor for initialization ValSelRangeMax(Space& home, const ValBranch& vb); /// Constructor for cloning ValSelRangeMax(Space& home, ValSelRangeMax& vs); /// Return value of integer view \a x at position \a i int val(const Space& home, IntView x, int i); }; }}} #include namespace Gecode { namespace Int { namespace Branch { /// No-good literal for equality template class EqNGL : public ViewValNGL { using ViewValNGL::x; using ViewValNGL::n; public: /// Constructor for creation EqNGL(Space& home, View x, int n); /// Constructor for cloning \a ngl EqNGL(Space& home, EqNGL& ngl); /// Test the status of the no-good literal virtual NGL::Status status(const Space& home) const; /// Propagate the negation of the no-good literal virtual ExecStatus prune(Space& home); /// Create copy virtual NGL* copy(Space& home); }; /// No-good literal for disequality template class NqNGL : public ViewValNGL { using ViewValNGL::x; using ViewValNGL::n; public: /// Constructor for creation NqNGL(Space& home, View x, int n); /// Constructor for cloning \a ngl NqNGL(Space& home, NqNGL& ngl); /// Test the status of the no-good literal virtual NGL::Status status(const Space& home) const; /// Propagate the negation of the no-good literal virtual ExecStatus prune(Space& home); /// Create copy virtual NGL* copy(Space& home); }; /// No-good literal for less or equal template class LqNGL : public ViewValNGL { using ViewValNGL::x; using ViewValNGL::n; public: /// Constructor for creation LqNGL(Space& home, View x, int n); /// Constructor for cloning \a ngl LqNGL(Space& home, LqNGL& ngl); /// Test the status of the no-good literal virtual NGL::Status status(const Space& home) const; /// Propagate the negation of the no-good literal virtual ExecStatus prune(Space& home); /// Create copy virtual NGL* copy(Space& home); }; /// No-good literal for greater or equal template class GqNGL : public ViewValNGL { using ViewValNGL::x; using ViewValNGL::n; public: /// Constructor for creation GqNGL(Space& home, View x, int n); /// Constructor for cloning \a ngl GqNGL(Space& home, GqNGL& ngl); /// Test the status of the no-good literal virtual NGL::Status status(const Space& home) const; /// Propagate the negation of the no-good literal virtual ExecStatus prune(Space& home); /// Create copy virtual NGL* copy(Space& home); }; }}} #include namespace Gecode { namespace Int { namespace Branch { /** * \defgroup FuncIntValCommit Integer value commit classes * * Contains the value commit classes for integer and Boolean * views that can be used together with the generic view/value * branchers. * * All value commit classes require * \code #include \endcode * \ingroup Other */ /** * \brief Value commit class for equality * * Requires \code #include \endcode * \ingroup FuncIntValCommit */ template class ValCommitEq : public ValCommit { public: using typename ValCommit::Var; /// Constructor for initialization ValCommitEq(Space& home, const ValBranch& vb); /// Constructor for cloning ValCommitEq(Space& home, ValCommitEq& vc); /// Commit view \a x at position \a i to value \a n for alternative \a a ModEvent commit(Space& home, unsigned int a, View x, int i, int n); /// Create no-good literal for alternative \a a NGL* ngl(Space& home, unsigned int a, View x, int n) const; /// Print on \a o the alternative \a with view \a x at position \a i and value \a n void print(const Space& home, unsigned int a, View x, int i, int n, std::ostream& o) const; }; /** * \brief Value commit class for less or equal * * Requires \code #include \endcode * \ingroup FuncIntValCommit */ template class ValCommitLq : public ValCommit { public: using typename ValCommit::Var; /// Constructor for initialization ValCommitLq(Space& home, const ValBranch& vb); /// Constructor for cloning ValCommitLq(Space& home, ValCommitLq& vc); /// Commit view \a x at position \a i to value \a n for alternative \a a ModEvent commit(Space& home, unsigned int a, View x, int i, int n); /// Create no-good literal for alternative \a a NGL* ngl(Space& home, unsigned int a, View x, int n) const; /// Print on \a o the alternative \a with view \a x at position \a i and value \a n void print(const Space& home, unsigned int a, View x, int i, int n, std::ostream& o) const; }; /** * \brief Value commit class for greater or equal * * Requires \code #include \endcode * \ingroup FuncIntValCommit */ template class ValCommitGq : public ValCommit { public: using typename ValCommit::Var; /// Constructor for initialization ValCommitGq(Space& home, const ValBranch& vb); /// Constructor for cloning ValCommitGq(Space& home, ValCommitGq& vc); /// Commit view \a x at position \a i to value \a n for alternative \a a ModEvent commit(Space& home, unsigned int a, View x, int i, int n); /// Create no-good literal for alternative \a a NGL* ngl(Space& home, unsigned int a, View x, int n) const; /// Print on \a o the alternative \a with view \a x at position \a i and value \a n void print(const Space& home, unsigned int a, View x, int i, int n, std::ostream& o) const; }; /** * \brief Value commit class for greater * * Requires \code #include \endcode * \ingroup FuncIntValCommit */ template class ValCommitGr : public ValCommit { public: using typename ValCommit::Var; /// Constructor for initialization ValCommitGr(Space& home, const ValBranch& vb); /// Constructor for cloning ValCommitGr(Space& home, ValCommitGr& vc); /// Commit view \a x at position \a i to value \a n for alternative \a a ModEvent commit(Space& home, unsigned int a, View x, int i, int n); /// Create no-good literal for alternative \a a NGL* ngl(Space& home, unsigned int a, View x, int n) const; /// Print on \a o the alternative \a with view \a x at position \a i and value \a n void print(const Space& home, unsigned int a, View x, int i, int n, std::ostream& o) const; }; }}} #include namespace Gecode { namespace Int { namespace Branch { /// Return value and commit for integer views GECODE_INT_EXPORT ValSelCommitBase* valselcommit(Space& home, const IntValBranch& ivb); /// Return value and commit for Boolean views GECODE_INT_EXPORT ValSelCommitBase* valselcommit(Space& home, const BoolValBranch& bvb); /// Return value and commit for integer views GECODE_INT_EXPORT ValSelCommitBase* valselcommit(Space& home, const IntAssign& ia); /// Return value and commit for Boolean views GECODE_INT_EXPORT ValSelCommitBase* valselcommit(Space& home, const BoolAssign& ba); }}} namespace Gecode { namespace Int { namespace Branch { /** * \brief %Brancher by view and values selection * */ template class ViewValuesBrancher : public ViewBrancher { protected: using ViewBrancher::x; using ViewBrancher::f; /// Print function Print p; /// Constructor for cloning \a b ViewValuesBrancher(Space& home, ViewValuesBrancher& b); /// Constructor for creation ViewValuesBrancher(Home home, ViewArray& x, ViewSel* vs[n], IntBranchFilter bf, IntVarValPrint vvp); public: /// Return choice virtual const Choice* choice(Space& home); /// Return choice virtual const Choice* choice(const Space& home, Archive& e); /// Perform commit for choice \a c and alternative \a a virtual ExecStatus commit(Space& home, const Choice& c, unsigned int a); /// Create no-good literal for choice \a c and alternative \a a virtual NGL* ngl(Space& home, const Choice& c, unsigned int a) const; /** * \brief Print branch for choice \a c and alternative \a a * * Prints an explanation of the alternative \a a of choice \a c * on the stream \a o. * */ virtual void print(const Space& home, const Choice& c, unsigned int a, std::ostream& o) const; /// Perform cloning virtual Actor* copy(Space& home); /// Post function for creation static void post(Home home, ViewArray& x, ViewSel* vs[n], IntBranchFilter bf, IntVarValPrint vvp); /// Delete brancher and return its size virtual size_t dispose(Space& home); }; /// Post brancher for view and values template void postviewvaluesbrancher(Home home, ViewArray& x, ViewSel* vs[n], IntBranchFilter bf, IntVarValPrint vvp); }}} #include #ifdef GECODE_HAS_CBS namespace Gecode { namespace Int { namespace Branch { /** * \brief %Brancher using counting-based search * */ template class CBSBrancher : public Brancher { private: /// Views to branch on ViewArray x; /** * \brief Map of variable ids to positions in \a x * * Once created, this mapping doesn't need to be updated. Because of this, * we can share a handle of the map across all instances of CBSBrancher in * all spaces. */ class VarIdToPos : public SharedHandle { protected: class VarIdToPosO : public SharedHandle::Object { public: /// The map we want to share std::unordered_map _varIdToPos; public: /// Default constructur VarIdToPosO(void) = default; /// Delete implementation virtual ~VarIdToPosO(void) = default; }; public: /// Default constructor VarIdToPos(void) = default; /// Allocation of the shared handle void init(void); /// Tests if a variable id is in the map bool isIn(unsigned int var_id) const; /// Returns the position of the variable id in \a x int operator[](unsigned int var_id) const; /// Inserts a new position for a variable id void insert(unsigned int var_id, unsigned int pos); } varIdToPos; /** * \brief Propagator information for counting-based search * * Keeps the best branching choice for each propagators (i.e. variable and * value with highest solution density). We also keep \a domsum to know * wether we need to recompute solution densities for the given propagator * when computing a new branching choice. */ struct PropInfo { /// Sum of variable cardinalities unsigned int domsum; /// Variable with the highest solution density unsigned int var_id; /// Value with highest solution density int val; /// Density of the above pair double dens; /// Flag for deleting propagator if unvisited when branching bool visited; }; /** * \brief Map of propagator ids to PropInfo * * Any active propagator that: * * - shares a variable with \a x * - has a counting algorithm (i.e. overloads solndistrib) * * will have an entry in this map. */ std::unordered_map, std::equal_to, space_allocator>> logProp; public: /// Constructor for creation CBSBrancher(Home home, ViewArray& x0); /// Constructor for cloning \a b CBSBrancher(Space& home, CBSBrancher& b); /// Post brancher static void post(Home home, ViewArray& x); /// Copy brancher during cloning virtual Actor* copy(Space& home); /// Delete brancher and return its size virtual size_t dispose(Space& home); /// Check status of brancher, return true if alternatives left virtual bool status(const Space& home) const; /// Return choice virtual const Choice* choice(Space& home); /// Return choice virtual const Choice* choice(const Space&, Archive& e); /// Commit choice \a c for alternative \a a virtual ExecStatus commit(Space& home, const Choice& c, unsigned int a); /// Print on \a o the alternative \a with view \a x at position \a i and value \a n virtual void print(const Space& home, const Choice& c, unsigned int a, std::ostream& o) const; private: /// Returns wether a variable is in \a x or not bool inbrancher(unsigned int varId) const; }; }}} #include #endif #endif // STATISTICS: int-branch