scale.icc

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Christian Schulte <schulte@gecode.org>
 *
 *  Copyright:
 *     Christian Schulte, 2002
 *
 *  Last modified:
 *     $Date: 2008-01-31 18:29:16 +0100 (Thu, 31 Jan 2008) $ by $Author: tack $
 *     $Revision: 6017 $
 *
 *  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.
 *
 */

namespace Gecode {

  namespace Int {

    /*
     * Support functions for division
     *
     */
    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::floor_div(double x) const {
      return static_cast<int>(floor(x / a));
    }

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::ceil_div(double x) const {
      return static_cast<int>(ceil(x / a));
    }

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::exact_div(double x, bool& exact) const {
      double xa = x / a;
      if (ceil(xa) == xa) {
        exact = true;  return static_cast<int>(xa);
      } else {
        exact = false; return 0;
      }
    }

#if GECODE_INT_RND_TWDS_ZERO

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::floor_div(int x) const {
      return ((x >= 0) ? x : (x-a+1))/a;
    }

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::ceil_div(int x) const {
      return ((x >= 0) ? (x+a-1) : x)/a;
    }

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::exact_div(int x, bool& exact) const {
      int xa = x / a;
      if (a * xa == x) {
        exact = true;  return xa;
      } else {
        exact = false; return 0;
      }
    }

#endif


    /*
     * Constructors and initialization
     *
     */
    template <class Val, class UnsVal>
    forceinline
    ScaleView<Val,UnsVal>::ScaleView(void) {}

    template <class Val, class UnsVal>
    forceinline
    ScaleView<Val,UnsVal>::ScaleView(int b, const IntView& x)
      : DerivedViewBase<IntView>(x), a(b) {}

    template <class Val, class UnsVal>
    forceinline
    ScaleView<Val,UnsVal>::ScaleView(Space* home,
                                     const Reflection::VarMap& vars,
                                     Reflection::Arg* arg)
    : DerivedViewBase<IntView>(IntView(home, vars, arg->second())),
      a(arg->first()->toInt()) {}

    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::init(int b, const IntView& x) {
      view=x; a=b;
    }

    template <class Val, class UnsVal>
    forceinline int
    ScaleView<Val,UnsVal>::scale(void) const {
      return a;
    }



    /*
     * Value access
     *
     */
    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::min(void) const {
      Val c = view.min(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::max(void) const {
      Val c = view.max(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::med(void) const {
      Val c = view.med(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::val(void) const {
      Val c = view.val(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline UnsVal
    ScaleView<Val,UnsVal>::size(void) const {
      return static_cast<UnsVal>(view.size());
    }

    template <class Val, class UnsVal>
    forceinline UnsVal
    ScaleView<Val,UnsVal>::width(void) const {
      UnsVal c = view.width(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline UnsVal
    ScaleView<Val,UnsVal>::regret_min(void) const {
      UnsVal c = view.regret_min(); c *= a; return c;
    }

    template <class Val, class UnsVal>
    forceinline UnsVal
    ScaleView<Val,UnsVal>::regret_max(void) const {
      UnsVal c = view.regret_max(); c *= a; return c;
    }


    /*
     * Domain tests
     *
     */
    template <class Val, class UnsVal>
    forceinline bool
    ScaleView<Val,UnsVal>::range(void) const {
      return view.range();
    }

    template <class Val, class UnsVal>
    forceinline bool
    ScaleView<Val,UnsVal>::assigned(void) const {
      return view.assigned();
    }

    template <class Val, class UnsVal>
    forceinline bool
    ScaleView<Val,UnsVal>::in(Val n) const {
      bool exact;
      int nda = exact_div(n, exact);
      return exact && view.in(nda);
    }




    /*
     * Domain update by value
     *
     */
    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::lq(Space* home, Val n) {
      return (n >= max()) ? ME_INT_NONE : view.lq(home,floor_div(n));
    }

    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::le(Space* home, Val n) {
      return (n > max()) ? ME_INT_NONE : view.le(home,floor_div(n));
    }

    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::gq(Space* home, Val n) {
      return (n <= min()) ? ME_INT_NONE : view.gq(home,ceil_div(n));
    }
    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::gr(Space* home, Val n) {
      return (n < min()) ? ME_INT_NONE : view.gr(home,ceil_div(n));
    }

    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::nq(Space* home, Val n) {
      bool exact;
      int nda = exact_div(n,exact);
      return exact ? view.nq(home,nda) :  ME_INT_NONE;
    }

    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::eq(Space* home, Val n) {
      bool exact;
      int nda = exact_div(n,exact);
      return exact ? view.eq(home,nda) : ME_INT_FAILED;
    }


    /*
     * Propagator modification events
     *
     */
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::schedule(Space* home, Propagator* p, ModEvent me) {
      return IntView::schedule(home,p,me);
    }
    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::me(ModEventDelta med) {
      return IntView::me(med);
    }

    template <class Val, class UnsVal>
    forceinline ModEventDelta
    ScaleView<Val,UnsVal>::med(ModEvent me) {
      return IntView::med(me);
    }



    /*
     * Dependencies
     *
     */
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::subscribe(Space* home, Propagator* p, PropCond pc,
                                     bool process) {
      view.subscribe(home,p,pc,process);
    }
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::cancel(Space* home, Propagator* p, PropCond pc) {
      view.cancel(home,p,pc);
    }
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::subscribe(Space* home, Advisor* a) {
      view.subscribe(home,a);
    }
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::cancel(Space* home, Advisor* a) {
      view.cancel(home,a);
    }


    /*
     * Delta information for advisors
     *
     */
    template <class Val, class UnsVal>
    forceinline ModEvent
    ScaleView<Val,UnsVal>::modevent(const Delta* d) {
      return IntView::modevent(d);
    }
    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::min(const Delta* d) const {
      Val c = view.min(d); c *= a; return c;
    }
    template <class Val, class UnsVal>
    forceinline Val
    ScaleView<Val,UnsVal>::max(const Delta* d) const {
      Val c = view.max(d); c *= a; return c;
    }
    template <class Val, class UnsVal>
    forceinline bool
    ScaleView<Val,UnsVal>::any(const Delta* d) const {
      return view.any(d);
    }



    /*
     * Cloning
     *
     */
    template <class Val, class UnsVal>
    forceinline void
    ScaleView<Val,UnsVal>::update(Space* home, bool share,
                                  ScaleView<Val,UnsVal>& x) {
      a=x.a; view.update(home,share,x.view);
    }

    /*
     * Serialization
     *
     */
    template <class Val, class UnsVal>
    forceinline Reflection::Arg*
    ScaleView<Val,UnsVal>::spec(const Space* home,
                                Reflection::VarMap& m) const {
      return Reflection::Arg::newPair(Reflection::Arg::newInt(a), 
                                      view.spec(home, m));
    }
    template <class Val, class UnsVal>
    inline Support::Symbol
    ScaleView<Val,UnsVal>::type(void) {
      return Support::Symbol("Gecode::Int::ScaleView");
    }


    template <>
    class ViewRanges<IntScaleView>
      : public Iter::Ranges::ScaleUp<int,unsigned int,ViewRanges<IntView> > {
    public:


      ViewRanges(void);
      ViewRanges(const IntScaleView& x);
      void init(const IntScaleView& x);
    };

    forceinline
    ViewRanges<IntScaleView>::ViewRanges(void) {}
    forceinline
    ViewRanges<IntScaleView>::ViewRanges(const IntScaleView& x) {
      ViewRanges<IntView> xi(x.base());
      Iter::Ranges::ScaleUp<int,unsigned int,ViewRanges<IntView> >::init
        (xi,x.scale());
    }
    forceinline void
    ViewRanges<IntScaleView>::init(const IntScaleView& x) {
      ViewRanges<IntView> xi(x.base());
      Iter::Ranges::ScaleUp<int,unsigned int,ViewRanges<IntView> >::init
        (xi,x.scale());
    }


    template <>
    class ViewRanges<DoubleScaleView>
      : public Iter::Ranges::ScaleUp<double,double,ViewRanges<IntView> > {
    public:


      ViewRanges(void);
      ViewRanges(const DoubleScaleView& x);
      void init(const DoubleScaleView& x);
    };

    forceinline
    ViewRanges<DoubleScaleView>::ViewRanges(void) {}
    forceinline
    ViewRanges<DoubleScaleView>::ViewRanges(const DoubleScaleView& x) {
      ViewRanges<IntView> xi(x.base());
      Iter::Ranges::ScaleUp<double,double,ViewRanges<IntView> >::init
        (xi,x.scale());
    }
    forceinline void
    ViewRanges<DoubleScaleView>::init(const DoubleScaleView& x) {
      ViewRanges<IntView> xi(x.base());
      Iter::Ranges::ScaleUp<double,double,ViewRanges<IntView> >::init
        (xi,x.scale());
    }

  }



  /*
   * View comparison
   *
   */
  template <class Val, class UnsVal>
  forceinline bool
  same(const Int::ScaleView<Val,UnsVal>& x,
       const Int::ScaleView<Val,UnsVal>& y) {
    return same(x.base(),y.base()) && (x.scale() == y.scale());
  }
  template <class Val, class UnsVal>
  forceinline bool
  before(const Int::ScaleView<Val,UnsVal>& x,
         const Int::ScaleView<Val,UnsVal>& y) {
    return before(x.base(),y.base())
      || (same(x.base(),y.base()) && (x.scale() < y.scale()));
  }

}

// STATISTICS: int-var