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 2572df0663 Squashed 'software/gecode_base/' content from commit bbefcea214
git-subtree-dir: software/gecode_base
git-subtree-split: bbefcea214fec798a0f5acc442581984555acd21
2021-07-11 17:26:05 +10:00

235 lines
7.1 KiB
C++

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
* Guido Tack <tack@gecode.org>
* Vincent Barichard <Vincent.Barichard@univ-angers.fr>
*
* Copyright:
* Christian Schulte, 2002
* Guido Tack, 2004
* Vincent Barichard, 2012
*
* 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_FLOAT_LINEAR_HH
#define GECODE_FLOAT_LINEAR_HH
#include <gecode/int.hh>
#include <gecode/float.hh>
/**
* \namespace Gecode::Float::Linear
* \brief %Linear propagators
*/
namespace Gecode { namespace Float { namespace Linear {
/**
* \brief Base-class for n-ary linear propagators
*
* Positive views are of type \a P whereas negative views are of type \a N.
*/
template<class P, class N, PropCond pc>
class Lin : public Propagator {
protected:
/// Array of positive views
ViewArray<P> x;
/// Array of negative views
ViewArray<N> y;
/// Constant value
FloatVal c;
/// Constructor for cloning \a p
Lin(Space& home, Lin<P,N,pc>& p);
/// Constructor for creation
Lin(Home home, ViewArray<P>& x, ViewArray<N>& y, FloatVal c);
public:
/// Cost function (defined as low linear)
virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
/// Schedule function
virtual void reschedule(Space& home);
/// Delete propagator and return its size
virtual size_t dispose(Space& home);
};
/**
* \brief Compute bounds information for positive views
*
* \relates Lin
*/
template<class View>
void bounds_p(ModEventDelta med, ViewArray<View>& x,
FloatVal& c, FloatNum& sl, FloatNum& su);
/**
* \brief Compute bounds information for negative views
*
* \relates Lin
*/
template<class View>
void bounds_n(ModEventDelta med, ViewArray<View>& y,
FloatVal& c, FloatNum& sl, FloatNum& su);
/**
* \brief %Propagator for bounds consistent n-ary linear equality
*
* Positive views are of type \a P whereas negative views are of type \a N.
*
* Requires \code #include <gecode/float/linear.hh> \endcode
* \ingroup FuncFloatProp
*/
template<class P, class N>
class Eq : public Lin<P,N,PC_FLOAT_BND> {
protected:
using Lin<P,N,PC_FLOAT_BND>::x;
using Lin<P,N,PC_FLOAT_BND>::y;
using Lin<P,N,PC_FLOAT_BND>::c;
/// Constructor for cloning \a p
Eq(Space& home, Eq& p);
public:
/// Constructor for creation
Eq(Home home, ViewArray<P>& x, ViewArray<N>& y, FloatVal c);
/// Create copy during cloning
virtual Actor* copy(Space& home);
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/// Post propagator for \f$\sum_{i=0}^{|x|-1}x_i-\sum_{i=0}^{|y|-1}y_i=c\f$
static ExecStatus
post(Home home, ViewArray<P>& x, ViewArray<N>& y, FloatVal c);
};
/**
* \brief %Propagator for bounds consistent n-ary linear less or equal
*
* Positive views are of type \a P whereas negative views are of type \a N.
*
* Requires \code #include <gecode/float/linear.hh> \endcode
* \ingroup FuncFloatProp
*/
template<class P, class N>
class Lq : public Lin<P,N,PC_FLOAT_BND> {
protected:
using Lin<P,N,PC_FLOAT_BND>::x;
using Lin<P,N,PC_FLOAT_BND>::y;
using Lin<P,N,PC_FLOAT_BND>::c;
/// Constructor for cloning \a p
Lq(Space& home, Lq& p);
public:
/// Constructor for creation
Lq(Home home, ViewArray<P>& x, ViewArray<N>& y, FloatVal c);
/// Create copy during cloning
virtual Actor* copy(Space& home);
/// Perform propagation
virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
/// Post propagator for \f$\sum_{i=0}^{|x|-1}x_i-\sum_{i=0}^{|y|-1}y_i\leq c\f$
static ExecStatus
post(Home home, ViewArray<P>& x, ViewArray<N>& y, FloatVal c);
};
}}}
#include <gecode/float/linear/nary.hpp>
namespace Gecode { namespace Float { namespace Linear {
/**
* \brief Class for describing linear term \f$a\cdot x\f$
*
*/
class Term {
public:
/// Coefficient
FloatVal a;
/// View
FloatView x;
};
/** \brief Estimate lower and upper bounds
*
* Estimates the boundaries for a linear expression
* \f$\sum_{i=0}^{n-1}t_i + c\f$. If the boundaries exceed
* the limits as defined in Limits::Float, these boundaries
* are returned.
*
* \param t array of linear terms
* \param n size of array
* \param c constant
* \param l lower bound
* \param u upper bound
*
*/
GECODE_FLOAT_EXPORT void
estimate(Term* t, int n, FloatVal c, FloatNum& l, FloatNum& u);
/**
* \brief Post propagator for linear constraint over floats
* \param home current space
* \param t array of linear terms over floats
* \param n size of array
* \param frt type of relation
* \param c result of linear constraint
*
* All variants for linear constraints share the following properties:
* - Variables occuring multiply in the term array are replaced
* by a single occurence: for example, \f$ax+bx\f$ becomes
* \f$(a+b)x\f$.
*
* Requires \code #include <gecode/float/linear.hh> \endcode
* \ingroup FuncFloatProp
*/
GECODE_FLOAT_EXPORT void
post(Home home, Term* t, int n, FloatRelType frt, FloatVal c);
/**
* \brief Post propagator for reified linear constraint over floats
* \param home current space
* \param t array of linear terms over Booleans
* \param n size of array
* \param frt type of relation
* \param c result of linear constraint
* \param r reification specification
*
* All variants for linear constraints share the following properties:
* - Variables occuring multiply in the term array are replaced
* by a single occurence: for example, \f$ax+bx\f$ becomes
* \f$(a+b)x\f$.
*
* Requires \code #include <gecode/float/linear.hh> \endcode
* \ingroup FuncFloatProp
*/
GECODE_FLOAT_EXPORT void
post(Home home, Term* t, int n, FloatRelType frt, FloatVal c, Reify r);
}}}
#endif
// STATISTICS: float-prop