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
 *
 *  Last modified:
 *     $Date: 2008-07-11 10:52:51 +0200 (Fri, 11 Jul 2008) $ by $Author: tack $
 *     $Revision: 7352 $
 *
 *  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/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, bool share, AbsBnd& p);
    AbsBnd(Space* home, View x0, View x1);
  public:

    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus  propagate(Space* home, ModEventDelta med);
    static  ExecStatus  post(Space* home, View x0, View x1);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                        Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

  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, bool share, AbsDom& p);
    AbsDom(Space* home, View x0, View x1);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus  propagate(Space* home, ModEventDelta med);
    static  ExecStatus  post(Space* home, View x0, View x1);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                        Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



  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, bool share, MaxBnd& p);
    MaxBnd(Space* home, View x0, View x1, View x2);
  public:
    MaxBnd(Space* home, bool share, Propagator& p, View x0, View x1, View x2);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static  ExecStatus post(Space* home, View x0, View x1, View x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

  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, bool share, NaryMaxBnd& p);
    NaryMaxBnd(Space* home, ViewArray<View>& x, View y);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static  ExecStatus post(Space* home, ViewArray<View>& x, View y);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

  template <class View>
  class MaxDom : public 
  MixTernaryPropagator<View,PC_INT_DOM,View,PC_INT_DOM,View,PC_INT_BND> {
  protected:
    using MixTernaryPropagator<View,PC_INT_DOM,View,PC_INT_DOM,View,PC_INT_BND>::x0;
    using MixTernaryPropagator<View,PC_INT_DOM,View,PC_INT_DOM,View,PC_INT_BND>::x1;
    using MixTernaryPropagator<View,PC_INT_DOM,View,PC_INT_DOM,View,PC_INT_BND>::x2;

    MaxDom(Space* home, bool share, MaxDom& p);
    MaxDom(Space* home, View x0, View x1, View x2);
  public:
    MaxDom(Space* home, bool share, Propagator& p, View x0, View x1, View x2);
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static  ExecStatus post(Space* home, View x0, View x1, View x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    NaryMaxDom(Space* home, bool share, NaryMaxDom& p);
    NaryMaxDom(Space* home, ViewArray<View>& x, View y);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static  ExecStatus post(Space* home, ViewArray<View>& x, View y);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };




  template <class VA, class VB>
  class SqrPlusBnd : 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;
    SqrPlusBnd(Space* home, VA x0, VB x1);
    SqrPlusBnd(Space* home, bool share, SqrPlusBnd<VA,VB>& p);
  public:
    static ExecStatus post(Space* home, VA x0, VB x1);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    SqrBnd(Space* home, bool share, SqrBnd<View>& p);
    SqrBnd(Space* home, View x0, View x1);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    static ExecStatus post(Space* home, View x0, View x1);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



  template <class VA, class VB>
  class SqrPlusDom : 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;
    SqrPlusDom(Space* home, VA x0, VB x1);
    SqrPlusDom(Space* home, bool share, SqrPlusDom<VA,VB>& p);
  public:
    static ExecStatus post(Space* home, VA x0, VB x1);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    SqrDom(Space* home, bool share, SqrDom<View>& p);
    SqrDom(Space* home, View x0, View x1);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual PropCost cost(ModEventDelta med) const;
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    static ExecStatus post(Space* home, View x0, View x1);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



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

    SqrtBnd(Space* home, bool share, SqrtBnd<View>& p);
    SqrtBnd(Space* home, View x0, View x1);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    static ExecStatus post(Space* home, View x0, View x1);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    SqrtDom(Space* home, bool share, SqrtDom<View>& p);
    SqrtDom(Space* home, View x0, View x1);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual PropCost cost(ModEventDelta med) const;
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    static ExecStatus post(Space* home, View x0, View x1);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



  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, bool share, MultZeroOne<View,pc>& p);
    MultZeroOne(Space* home, View x0, View x1);
    static RelTest equal(View x, int n);
  public:
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    static ExecStatus post(Space* home, View x0, View x1);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



  template <class Val, 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(Space* home, VA x0, VB x1, VC x2);
    MultPlusBnd(Space* home, bool share, MultPlusBnd<Val,VA,VB,VC>& p);
    static ExecStatus post(Space* home, VA x0, VB x1, VC x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    MultBnd(Space* home, bool share, MultBnd<View>& p);
  public:
    MultBnd(Space* home, View x0, View x1, View x2);
    static  ExecStatus post(Space* home, View x0, View x1, View x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                        Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };



  template <class Val, 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(Space* home, VA x0, VB x1, VC x2);
    MultPlusDom(Space* home, bool share, MultPlusDom<Val,VA,VB,VC>& p);
    static ExecStatus post(Space* home, VA x0, VB x1, VC x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

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

    MultDom(Space* home, bool share, MultDom<View>& p);
  public:
    MultDom(Space* home, View x0, View x1, View x2);
    static  ExecStatus post(Space* home, View x0, View x1, View x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual PropCost cost(ModEventDelta med) const;
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                        Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

  template <class Val, class VA, class VB, class VC, bool towardsMinInf=true>
  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(Space* home, VA x0, VB x1, VC x2);
    DivPlusBnd(Space* home, bool share,
               DivPlusBnd<Val,VA,VB,VC,towardsMinInf>& p);
    static ExecStatus post(Space* home, VA x0, VB x1, VC x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

  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, bool share, DivBnd<View>& p);
  public:
    DivBnd(Space* home, View x0, View x1, View x2);
    static  ExecStatus post(Space* home, View x0, View x1, View x2);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                        Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };
  
  template <class View>
  class DivMod : public BinaryPropagator<View,PC_INT_BND> {
  protected:
    using BinaryPropagator<View,PC_INT_BND>::x0;
    using BinaryPropagator<View,PC_INT_BND>::x1;
    
    DivMod(Space* home, bool share, DivMod<View>& p);
  public:
    DivMod(Space* home, View x0, View x1);
    static  ExecStatus post(Space* home, View x0, View x1);
    static void post(Space* home, Reflection::VarMap& vars,
                     const Reflection::ActorSpec& spec);
    virtual Actor* copy(Space* home, bool share);
    virtual ExecStatus propagate(Space* home, ModEventDelta med);
    virtual Reflection::ActorSpec spec(const Space* home,
                                       Reflection::VarMap& m) const;
    static Support::Symbol ati(void);
  };

}}}

#include "gecode/int/arithmetic/abs.icc"
#include "gecode/int/arithmetic/max.icc"
#include "gecode/int/arithmetic/sqr.icc"
#include "gecode/int/arithmetic/sqrt.icc"
#include "gecode/int/arithmetic/mult.icc"
#include "gecode/int/arithmetic/divmod.icc"

#endif

// STATISTICS: int-prop