1
0
This repository has been archived on 2025-03-06. You can view files and clone it, but cannot push or open issues or pull requests.
Jip J. Dekker 1d9faf38de Squashed 'software/gecode/' content from commit 313e8764
git-subtree-dir: software/gecode
git-subtree-split: 313e87646da4fc2752a70e83df16d993121a8e40
2021-06-16 14:02:33 +10:00

388 lines
13 KiB
C++

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
* Guido Tack <tack@gecode.org>
*
* Contributing authors:
* Gabor Szokoli <szokoli@gecode.org>
*
* Copyright:
* Christian Schulte, 2002
* Guido Tack, 2004
* Gabor Szokoli, 2003
*
* 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_DISTINCT_HH
#define GECODE_INT_DISTINCT_HH
#include <gecode/int.hh>
#include <gecode/int/view-val-graph.hh>
#include <gecode/int/rel.hh>
/**
* \namespace Gecode::Int::Distinct
* \brief %Distinct propagators
*/
namespace Gecode { namespace Int { namespace Distinct {
/**
* \brief Naive value distinct propagator
*
* Eliminates values of assigned views of type \a View.
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
template<class View>
class Val : public NaryPropagator<View,PC_INT_VAL> {
protected:
using NaryPropagator<View,PC_INT_VAL>::x;
/// Constructor for posting
Val(Home home, ViewArray<View>& x);
/// Constructor for cloning \a p
Val(Space& home, Val<View>& p);
public:
#ifdef GECODE_HAS_CBS
/// Solution distribution computation for branching
virtual void solndistrib(Space& home, Propagator::SendMarginal send) const;
/// Sum of variables cardinalities
virtual void domainsizesum(Propagator::InDecision in,
unsigned int& size, unsigned int& size_b) const;
#endif
/// Copy propagator during cloning
virtual Actor* copy(Space& home);
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/// Post propagator for view array \a x
static ExecStatus post(Home home, ViewArray<View>& x);
};
#ifdef GECODE_HAS_CBS
/**
* \brief Solution distribution computation for the AllDifferent constraint
*
* The algorithm is taken from:
* Gagnon, Samuel & Pesant, Gilles. (2018).
* Accelerating Counting-Based Search.
* In book: Integration of Constraint Programming,
* Artificial Intelligence, and Operations Research, pp.245-253
* Available at http://www.polymtl.ca/labo-quosseca/en/publications
*/
template<class View>
void cbsdistinct(Space& home, unsigned int prop_id, const ViewArray<View>& x,
Propagator::SendMarginal send);
template<class View>
void cbssize(const ViewArray<View>& x, Propagator::InDecision in,
unsigned int& size, unsigned int& size_b);
#endif
/**
* \brief Eliminate singletons by naive value propagation
*
* This is actually the propagation algorithm for Distinct::Val.
* It is available as separate function as it is reused for
* both bounds consistent and domain consistent distinct
* propagators.
*
* If \a complete is true, computes fixpoint, otherwise might not
* compute fixpoint. This can be helpful when used together with
* bounds or domain propagation to protect from pathological cases
* which can be handled more efficiently with bounds propagation.
*/
template<class View, bool complete>
ExecStatus prop_val(Space& home, ViewArray<View>&);
/**
* \brief Bounds consistent distinct propagator
*
* The propagator uses staging: first it uses naive value-based
* propagation and only then uses bounds consistent propagation.
* Due to using naive value-based propagation, the propagator
* might actually achieve stronger consistency than just
* bounds consistency.
*
* The algorithm is taken from:
* A. Lopez-Ortiz, C.-G. Quimper, J. Tromp, and P. van Beek.
* A fast and simple algorithm for bounds consistency of the
* alldifferent constraint. IJCAI-2003.
*
* This implementation uses the code that is provided by
* Peter Van Beek:
* http://ai.uwaterloo.ca/~vanbeek/software/software.html
* The code (originally by John Tromp) here has only been slightly modified
* to fit %Gecode (taking idempotent/non-idempotent propagation into account)
* and uses a more efficient layout of datastructures (keeping the number
* of different arrays small).
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
template<class View>
class Bnd : public Propagator {
protected:
/// Views on which to perform bounds-propagation
ViewArray<View> x;
/// Views on which to perform value-propagation (subset of \c x)
ViewArray<View> y;
/// Minimum (approximation) of view in \a x
int min_x;
/// Maximum (approximation) of view in \a x
int max_x;
/// Constructor for posting
Bnd(Home home, ViewArray<View>& x);
/// Constructor for cloning \a p
Bnd(Space& home, Bnd<View>& p);
public:
#ifdef GECODE_HAS_CBS
/// Solution distribution computation for branching
virtual void solndistrib(Space& home, Propagator::SendMarginal send) const;
/// Sum of variables cardinalities
virtual void domainsizesum(Propagator::InDecision in,
unsigned int& size, unsigned int& size_b) const;
#endif
/// Post propagator for view array \a x
static ExecStatus post(Home home, ViewArray<View>& x);
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/**
* \brief Cost function
*
* If in stage for naive value propagation, the cost is
* low linear. Otherwise it is low quadratic.
*/
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
/// Schedule function
virtual void reschedule(Space& home);
/// Copy propagator during cloning
virtual Actor* copy(Space& home);
/// Destructor
virtual size_t dispose(Space& home);
};
/**
* \brief Perform bounds consistent distinct propagation
*
* This is actually the propagation algorithm for Distinct::Bnd.
* It is available as separate function as it is reused for
* both bounds consistent and domain consistent distinct
* propagators.
*/
template<class View>
ExecStatus prop_bnd(Space& home, ViewArray<View>& x, int& min_x, int& max_x);
/**
* \brief Perform bounds consistent distinct propagation
*
* This is actually the propagation algorithm for Distinct::Bnd.
* It is available as separate function as it is reused for
* both bounds consistent and domain consistent distinct
* propagators.
*/
template<class View>
ExecStatus prop_bnd(Space& home, ViewArray<View>& x);
/// View-value graph for propagation
template<class View>
class Graph : public ViewValGraph::Graph<View> {
public:
using ViewValGraph::Graph<View>::view;
using ViewValGraph::Graph<View>::n_view;
using ViewValGraph::Graph<View>::val;
using ViewValGraph::Graph<View>::n_val;
using ViewValGraph::Graph<View>::count;
using ViewValGraph::Graph<View>::scc;
using ViewValGraph::Graph<View>::match;
/// Construct graph as not yet initialized
Graph(void);
/// Initialize graph
ExecStatus init(Space& home, ViewArray<View>& x);
/// Mark edges in graph, return true if pruning is at all possible
bool mark(void);
/// Prune unmarked edges, \a assigned is true if a view got assigned
ExecStatus prune(Space& home, bool& assigned);
/// Synchronize graph with new view domains
bool sync(void);
};
/**
* \brief Propagation controller for domain consistent distinct
*
* The propagation controller provides convenient access to
* performing incremental domain consistent distinct propagation
* so that the routines can be reused easily.
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
template<class View>
class DomCtrl {
protected:
/// Propagation is performed on a view-value graph
Graph<View> g;
public:
/// Initialize with non-initialized view-value graph
DomCtrl(void);
/// Check whether a view-value graph is available
bool available(void);
/// Initialize view-value graph for views \a x
ExecStatus init(Space& home, ViewArray<View>& x);
/// Synchronize available view-value graph
ExecStatus sync(void);
/// Perform propagation, \a assigned is true if a view gets assigned
ExecStatus propagate(Space& home, bool& assigned);
};
/**
* \brief Domain consistent distinct propagator
*
* The propagator uses staging: first it uses naive value-based
* propagation and only then uses domain consistent propagation.
*
* The algorithm is taken from:
* Jean-Charles Régin, A filtering algorithm for constraints
* of difference in CSPs, Proceedings of the Twelfth National
* Conference on Artificial Intelligence, pages 362--367.
* Seattle, WA, USA, 1994.
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
template<class View>
class Dom : public NaryPropagator<View,PC_INT_DOM> {
protected:
using NaryPropagator<View,PC_INT_DOM>::x;
/// Propagation controller
DomCtrl<View> dc;
/// Constructor for cloning \a p
Dom(Space& home, Dom<View>& p);
/// Constructor for posting
Dom(Home home, ViewArray<View>& x);
public:
#ifdef GECODE_HAS_CBS
/// Solution distribution computation for branching
virtual void solndistrib(Space& home, Propagator::SendMarginal send) const;
/// Sum of variables cardinalities
virtual void domainsizesum(Propagator::InDecision in,
unsigned int& size, unsigned int& size_b) const;
#endif
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/**
* \brief Cost function
*
* If in stage for naive value propagation, the cost is
* low linear. Otherwise it is high quadratic.
*/
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
/// Copy propagator during cloning
virtual Actor* copy(Space& home);
/// Post propagator for views \a x
static ExecStatus post(Home home, ViewArray<View>& x);
};
/**
* \brief Ternary domain consistent distinct propagator
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
template<class View>
class TerDom : public TernaryPropagator<View,PC_INT_DOM> {
protected:
using TernaryPropagator<View,PC_INT_DOM>::x0;
using TernaryPropagator<View,PC_INT_DOM>::x1;
using TernaryPropagator<View,PC_INT_DOM>::x2;
/// Constructor for cloning \a p
TerDom(Space& home, TerDom<View>& p);
/// Constructor for posting
TerDom(Home home, View x0, View x1, View x2);
public:
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/// Copy propagator during cloning
virtual Actor* copy(Space& home);
/// Post propagator for views \a x
static ExecStatus post(Home home, View x0, View x1, View x2);
};
/**
* \brief Equal-if-then-else domain-consistent propagator
*
* Implements the propagator \f$x_1=(x_0 = c_0) ? c_1 : x_0\f$.
*
* Requires \code #include <gecode/int/distinct.hh> \endcode
* \ingroup FuncIntProp
*/
class EqIte : public BinaryPropagator<IntView,PC_INT_DOM> {
protected:
using BinaryPropagator<IntView,PC_INT_DOM>::x0;
using BinaryPropagator<IntView,PC_INT_DOM>::x1;
/// The integer constant
int c0, c1;
/// Constructor for cloning \a p
EqIte(Space& home, EqIte& p);
/// Constructor for creation
EqIte(Home home, IntView x0, IntView x1, int c0, int c1);
public:
/// Copy propagator during cloning
GECODE_INT_EXPORT
virtual Actor* copy(Space& home);
/// Cost function (defined as high ternary)
GECODE_INT_EXPORT
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
/// Perform propagation
GECODE_INT_EXPORT
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/// Post if-then-else propagator
static ExecStatus post(Home home, IntView x0, IntView x1, int c0, int c1);
};
}}}
#include <gecode/int/distinct/cbs.hpp>
#include <gecode/int/distinct/val.hpp>
#include <gecode/int/distinct/bnd.hpp>
#include <gecode/int/distinct/ter-dom.hpp>
#include <gecode/int/distinct/graph.hpp>
#include <gecode/int/distinct/dom-ctrl.hpp>
#include <gecode/int/distinct/dom.hpp>
#include <gecode/int/distinct/eqite.hpp>
#endif
// STATISTICS: int-prop