arithmetic.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>
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Christian Schulte, 2002
 *     Guido Tack, 2004
 *
 *  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_ARITHMETIC_HH__
#define __GECODE_INT_ARITHMETIC_HH__

#include <gecode/int.hh>

#include <gecode/int/idx-view.hh>
#include <gecode/int/rel.hh>
#include <gecode/int/linear.hh>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class View>
  class AbsBnd : public BinaryPropagator<View,PC_INT_BND> {
  protected:
    using BinaryPropagator<View,PC_INT_BND>::x0;
    using BinaryPropagator<View,PC_INT_BND>::x1;

    AbsBnd(Space& home, AbsBnd& p);
    AbsBnd(Home home, View x0, View x1);
  public:

    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus  propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus  post(Home home, View x0, View x1);
  };

  template<class View>
  class AbsDom : public BinaryPropagator<View,PC_INT_DOM> {
  protected:
    using BinaryPropagator<View,PC_INT_DOM>::x0;
    using BinaryPropagator<View,PC_INT_DOM>::x1;

    AbsDom(Space& home, AbsDom& p);
    AbsDom(Home home, View x0, View x1);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus  propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus  post(Home home, View x0, View x1);
  };

}}}

#include <gecode/int/arithmetic/abs.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class View>
  class MaxBnd : public TernaryPropagator<View,PC_INT_BND> {
  protected:
    using TernaryPropagator<View,PC_INT_BND>::x0;
    using TernaryPropagator<View,PC_INT_BND>::x1;
    using TernaryPropagator<View,PC_INT_BND>::x2;

    MaxBnd(Space& home, MaxBnd& p);
    MaxBnd(Home home, View x0, View x1, View x2);
  public:
    MaxBnd(Space& home, Propagator& p, View x0, View x1, View x2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, View x0, View x1, View x2);
  };

  template<class View>
  class NaryMaxBnd : public NaryOnePropagator<View,PC_INT_BND> {
  protected:
    using NaryOnePropagator<View,PC_INT_BND>::x;
    using NaryOnePropagator<View,PC_INT_BND>::y;

    NaryMaxBnd(Space& home, NaryMaxBnd& p);
    NaryMaxBnd(Home home, ViewArray<View>& x, View y);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<View>& x, View y);
  };

  template<class View>
  class MaxDom : 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;

    MaxDom(Space& home, MaxDom& p);
    MaxDom(Home home, View x0, View x1, View x2);
  public:
    MaxDom(Space& home, Propagator& p, View x0, View x1, View x2);
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, View x0, View x1, View x2);
  };

  template<class View>
  class NaryMaxDom : public NaryOnePropagator<View,PC_INT_DOM> {
  protected:
    using NaryOnePropagator<View,PC_INT_DOM>::x;
    using NaryOnePropagator<View,PC_INT_DOM>::y;

    NaryMaxDom(Space& home, NaryMaxDom& p);
    NaryMaxDom(Home home, ViewArray<View>& x, View y);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static  ExecStatus post(Home home, ViewArray<View>& x, View y);
  };

}}}

#include <gecode/int/arithmetic/max.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class VA, class VB, bool tiebreak>
  class ArgMax : public Propagator {
  protected:
    IdxViewArray<VA> x;
    VB y;
    ArgMax(Space& home, ArgMax& p);
    ArgMax(Home home, IdxViewArray<VA>& x, VB y);
  public:
    virtual Actor* copy(Space& home);
    // Cost function (defined as low linear)
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual void reschedule(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    virtual size_t dispose(Space& home);
    static  ExecStatus post(Home home, IdxViewArray<VA>& x, VB y);
  };

}}}

#include <gecode/int/arithmetic/argmax.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  class SqrOps {
  public:
    bool even(void) const;
    int exp(void) const;
    void exp(int m);
    template<class IntType>
    IntType pow(IntType x) const;
    int tpow(int x) const;
    int fnroot(int x) const;
    int cnroot(int x) const;
  };

  class PowOps {
  protected:
    int n;
    static bool even(int m);
    bool powgr(long long int r, int x) const;
    bool powle(long long int r, int x) const;
  public:
    PowOps(int n);
    bool even(void) const;
    int exp(void) const;
    void exp(int m);
    template<class IntType>
    IntType pow(IntType x) const;
    int tpow(int x) const;
    int fnroot(int x) const;
    int cnroot(int x) const;
  };

}}}

#include <gecode/int/arithmetic/pow-ops.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class VA, class VB, class Ops>
  class PowPlusBnd : public MixBinaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND> {
  protected:
    using MixBinaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND>::x0;
    using MixBinaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND>::x1;
    Ops ops;
    PowPlusBnd(Home home, VA x0, VB x1, const Ops& ops);
    PowPlusBnd(Space& home, PowPlusBnd<VA,VB,Ops>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, VA x0, VB x1, Ops ops);
  };

  template<class Ops>
  class PowBnd : public BinaryPropagator<IntView,PC_INT_BND> {
  protected:
    using BinaryPropagator<IntView,PC_INT_BND>::x0;
    using BinaryPropagator<IntView,PC_INT_BND>::x1;
    Ops ops;
    PowBnd(Space& home, PowBnd& p);
    PowBnd(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

  template<class VA, class VB, class Ops>
  class PowPlusDom : public MixBinaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM> {
  protected:
    using MixBinaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM>::x0;
    using MixBinaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM>::x1;
    Ops ops;
    PowPlusDom(Home home, VA x0, VB x1, const Ops& ops);
    PowPlusDom(Space& home, PowPlusDom<VA,VB,Ops>& p);
  public:
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, VA x0, VB x1, Ops ops);
  };

  template<class Ops>
  class PowDom : public BinaryPropagator<IntView,PC_INT_DOM> {
  protected:
    using BinaryPropagator<IntView,PC_INT_DOM>::x0;
    using BinaryPropagator<IntView,PC_INT_DOM>::x1;
    Ops ops;
    PowDom(Space& home, PowDom<Ops>& p);
    PowDom(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

}}}

#include <gecode/int/arithmetic/pow.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class Ops, bool minus>
  class NrootPlusBnd : public BinaryPropagator<IntView,PC_INT_BND> {
  protected:
    using BinaryPropagator<IntView,PC_INT_BND>::x0;
    using BinaryPropagator<IntView,PC_INT_BND>::x1;
    Ops ops;
    NrootPlusBnd(Space& home, NrootPlusBnd<Ops,minus>& p);
    NrootPlusBnd(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

  template<class Ops>
  class NrootBnd : public BinaryPropagator<IntView,PC_INT_BND> {
  protected:
    using BinaryPropagator<IntView,PC_INT_BND>::x0;
    using BinaryPropagator<IntView,PC_INT_BND>::x1;
    Ops ops;
    NrootBnd(Space& home, NrootBnd<Ops>& p);
    NrootBnd(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

  template<class Ops, bool minus>
  class NrootPlusDom : public BinaryPropagator<IntView,PC_INT_DOM> {
  protected:
    using BinaryPropagator<IntView,PC_INT_DOM>::x0;
    using BinaryPropagator<IntView,PC_INT_DOM>::x1;
    Ops ops;
    NrootPlusDom(Space& home, NrootPlusDom<Ops,minus>& p);
    NrootPlusDom(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

  template<class Ops>
  class NrootDom : public BinaryPropagator<IntView,PC_INT_DOM> {
  protected:
    using BinaryPropagator<IntView,PC_INT_DOM>::x0;
    using BinaryPropagator<IntView,PC_INT_DOM>::x1;
    Ops ops;
    NrootDom(Space& home, NrootDom<Ops>& p);
    NrootDom(Home home, IntView x0, IntView x1, const Ops& ops);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    static ExecStatus post(Home home, IntView x0, IntView x1, Ops ops);
  };

}}}

#include <gecode/int/arithmetic/nroot.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class View, PropCond pc>
  class MultZeroOne : public BinaryPropagator<View,pc> {
  protected:
    using BinaryPropagator<View,pc>::x0;
    using BinaryPropagator<View,pc>::x1;

    MultZeroOne(Space& home, MultZeroOne<View,pc>& p);
    MultZeroOne(Home home, View x0, View x1);
    static RelTest equal(View x, int n);
  public:
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
    static ExecStatus post(Home home, View x0, View x1);
  };



  template<class VA, class VB, class VC>
  class MultPlusBnd :
    public MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND> {
  protected:
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x0;
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x1;
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x2;
  public:
    MultPlusBnd(Home home, VA x0, VB x1, VC x2);
    MultPlusBnd(Space& home, MultPlusBnd<VA,VB,VC>& p);
    static ExecStatus post(Home home, VA x0, VB x1, VC x2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

  class MultBnd : public TernaryPropagator<IntView,PC_INT_BND> {
  protected:
    using TernaryPropagator<IntView,PC_INT_BND>::x0;
    using TernaryPropagator<IntView,PC_INT_BND>::x1;
    using TernaryPropagator<IntView,PC_INT_BND>::x2;
    MultBnd(Space& home, MultBnd& p);
  public:
    MultBnd(Home home, IntView x0, IntView x1, IntView x2);
    GECODE_INT_EXPORT
    static ExecStatus post(Home home, IntView x0, IntView x1, IntView x2);
    GECODE_INT_EXPORT
    virtual Actor* copy(Space& home);
    GECODE_INT_EXPORT
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };



  template<class VA, class VB, class VC>
  class MultPlusDom :
    public MixTernaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM,VC,PC_INT_DOM> {
  protected:
    using MixTernaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM,VC,PC_INT_DOM>::x0;
    using MixTernaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM,VC,PC_INT_DOM>::x1;
    using MixTernaryPropagator<VA,PC_INT_DOM,VB,PC_INT_DOM,VC,PC_INT_DOM>::x2;
  public:
    MultPlusDom(Home home, VA x0, VB x1, VC x2);
    MultPlusDom(Space& home, MultPlusDom<VA,VB,VC>& p);
    static ExecStatus post(Home home, VA x0, VB x1, VC x2);
    virtual Actor* copy(Space& home);
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

  class MultDom : public TernaryPropagator<IntView,PC_INT_DOM> {
  protected:
    using TernaryPropagator<IntView,PC_INT_DOM>::x0;
    using TernaryPropagator<IntView,PC_INT_DOM>::x1;
    using TernaryPropagator<IntView,PC_INT_DOM>::x2;
    MultDom(Space& home, MultDom& p);
  public:
    MultDom(Home home, IntView x0, IntView x1, IntView x2);
    GECODE_INT_EXPORT
    static ExecStatus post(Home home, IntView x0, IntView x1, IntView x2);
    GECODE_INT_EXPORT
    virtual Actor* copy(Space& home);
    GECODE_INT_EXPORT
    virtual PropCost cost(const Space& home, const ModEventDelta& med) const;
    GECODE_INT_EXPORT
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

}}}

#include <gecode/int/arithmetic/mult.hpp>

namespace Gecode { namespace Int { namespace Arithmetic {

  template<class VA, class VB, class VC>
  class DivPlusBnd :
    public MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND> {
  protected:
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x0;
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x1;
    using MixTernaryPropagator<VA,PC_INT_BND,VB,PC_INT_BND,VC,PC_INT_BND>::x2;
  public:
    DivPlusBnd(Home home, VA x0, VB x1, VC x2);
    DivPlusBnd(Space& home, DivPlusBnd<VA,VB,VC>& p);
    static ExecStatus post(Home home, VA x0, VB x1, VC x2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

  template<class View>
  class DivBnd : public TernaryPropagator<View,PC_INT_BND> {
  protected:
    using TernaryPropagator<View,PC_INT_BND>::x0;
    using TernaryPropagator<View,PC_INT_BND>::x1;
    using TernaryPropagator<View,PC_INT_BND>::x2;

    DivBnd(Space& home, DivBnd<View>& p);
  public:
    DivBnd(Home home, View x0, View x1, View x2);
    static  ExecStatus post(Home home, View x0, View x1, View x2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

  template<class View>
  class DivMod : public TernaryPropagator<View,PC_INT_BND> {
  protected:
    using TernaryPropagator<View,PC_INT_BND>::x0;
    using TernaryPropagator<View,PC_INT_BND>::x1;
    using TernaryPropagator<View,PC_INT_BND>::x2;

    DivMod(Space& home, DivMod<View>& p);
  public:
    DivMod(Home home, View x0, View x1, View x2);
    static  ExecStatus post(Home home, View x0, View x1, View x2);
    virtual Actor* copy(Space& home);
    virtual ExecStatus propagate(Space& home, const ModEventDelta& med);
  };

}}}

#include <gecode/int/arithmetic/divmod.hpp>

#endif

// STATISTICS: int-prop