array.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>
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Christian Schulte, 2003
 *     Guido Tack, 2004
 *
 *  Last modified:
 *     $Date: 2008-02-20 08:39:15 +0100 (Wed, 20 Feb 2008) $ by $Author: tack $
 *     $Revision: 6240 $
 *
 *  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.
 *
 */

#include <cstdarg>
#include <iostream>

namespace Gecode {

  template <class Var> class VarArray;
  template <class Var> class VarArgArray;

  template <class Var>
  class VarArray {
  protected:
    int  used;
    int n;
    Var* x;
  public:


    VarArray(void);
    VarArray(Space*, int m);
    VarArray(Space*,const VarArgArray<Var>&);
    VarArray(const VarArray<Var>& a);
    const VarArray<Var>& operator=(const VarArray<Var>& a);
    ~VarArray(void);



    int size(void) const;
    void resize(Space* home, int m);



    Var& operator[](int i);
    const Var& operator[](int i) const;
    void add(Space* home, const Var& v);



    void update(Space*, bool share, VarArray<Var>& a);
  private:
    static void* operator new(size_t);
    static void  operator delete(void*,size_t);
  };


  template <class View>
  class ViewArray {
  private:
    int  n;
    View* x;
    class ViewLess {
    public:
      bool operator()(const View&, const View&);
    };
    static void sort(View* x, int n);
  public:


    ViewArray(void);
    ViewArray(Space* home, int m);
    ViewArray(const ViewArray<View>& a);
    ViewArray(Space* home, const Reflection::VarMap& vars,
              Reflection::Arg* spec);
    ViewArray(Space* home, const ViewArray<View>& a);
    const ViewArray<View>& operator=(const ViewArray<View>& a);
    template <class Var>
    ViewArray(Space* home, const VarArgArray<Var>& a)
      : n(a.size()) {
      // This may not be in the icc file (to satisfy the MS compiler)
      if (n>0) {
        x = static_cast<View*>(home->alloc(sizeof(View)*n));
        for (int i = n; i--; )
          x[i] = a[i];
      } else {
        x = NULL;
      }
    }



    int size(void) const;
    void size(int n);



    View& operator[](int i);
    const View& operator[](int i) const;



    void subscribe(Space* home, Propagator* p, PropCond pc, bool process=true);
    void cancel(Space* home, Propagator* p, PropCond pc);
    void subscribe(Space* home, Advisor* a);
    void cancel(Space* home, Advisor* a);



    void update(Space*, bool share, ViewArray<View>& a);




    void move_fst(int i);
    void move_lst(int i);
    void move_fst(int i, Space* home, Propagator* p, PropCond pc);
    void move_lst(int i, Space* home, Propagator* p, PropCond pc);
    void move_fst(int i, Space* home, Advisor* a);
    void move_lst(int i, Space* home, Advisor* a);



    void drop_fst(int i);
    void drop_lst(int i);
    void drop_fst(int i, Space* home, Propagator* p, PropCond pc);
    void drop_lst(int i, Space* home, Propagator* p, PropCond pc);
    void drop_fst(int i, Space* home, Advisor* a);
    void drop_lst(int i, Space* home, Advisor* a);



    bool same(void) const;
    bool same(const View& y) const;
    void unique(void);



    bool shared(void) const;
    bool shared(const View& y) const;


    Reflection::Arg* spec(const Space* home, Reflection::VarMap& m) const;

  private:
    static void* operator new(size_t);
    static void  operator delete(void*,size_t);
  };

  template <class T>
  class ArgArrayBase {
  protected:
    int n;
    T*  a;
    static const int onstack_size = 16;
    T onstack[onstack_size];
    T* allocate(int n);
  public:


    ArgArrayBase(int n);
    ArgArrayBase(const ArgArrayBase<T>& a);
    const ArgArrayBase<T>& operator=(const ArgArrayBase<T>& a);



    int size(void) const;



    T& operator[](int i);
    const T& operator[](int i) const;



    ~ArgArrayBase(void);
  private:
    static void* operator new(size_t);
    static void  operator delete(void*,size_t);
  };


  template <class T>
  class PrimArgArray : public ArgArrayBase<T> {
  protected:
    using ArgArrayBase<T>::a;
  public:
    using ArgArrayBase<T>::size;


    PrimArgArray(int n);
    PrimArgArray(int n, T e0, ...);
    PrimArgArray(int n, const T* e);
    PrimArgArray(const PrimArgArray<T>& a);
  };

  template <class Var>
  class VarArgArray : public ArgArrayBase<Var> {
  protected:
    using ArgArrayBase<Var>::a;
    using ArgArrayBase<Var>::n;
    class VarLess {
    public:
      bool operator()(const Var&, const Var&);
    };
  public:
    using ArgArrayBase<Var>::size;


    VarArgArray(int n);
    VarArgArray(const VarArgArray<Var>& a);
    VarArgArray(const VarArray<Var>& a);



    bool same(void) const;
    bool same(const Var& y) const;
    bool same(const VarArgArray<Var>& y) const;
  };

}

template<class Var>
std::ostream& operator<<(std::ostream& os, const Gecode::VarArray<Var>& x);

template<class View>
std::ostream& operator<<(std::ostream& os, const Gecode::ViewArray<View>& x);

template<class T>
std::ostream& operator<<(std::ostream& os, const Gecode::ArgArrayBase<T>& x);


namespace Gecode {
  template <class A>
  class ArrayTraits {};

  /*
   * Implementation
   *
   */

  /*
   * Variable arrays
   *
   */

  template <class Var>
  forceinline
  VarArray<Var>::VarArray(void) : used(0), n(0), x(NULL) {}

  template <class Var>
  forceinline
  VarArray<Var>::VarArray(Space* home, int n0)
    : used(n0), n(n0) {
    x = (n>0) ? static_cast<Var*>(home->alloc(sizeof(Var)*n)) : NULL;
  }

  template <class Var>
  forceinline
  VarArray<Var>::VarArray(const VarArray<Var>& a) {
    used = a.used; n = a.n; x = a.x;
  }

  template <class Var>
  forceinline
  VarArray<Var>::~VarArray(void) {
    if (used != n) {
      // Array was allocated on the heap instead of the space
      Memory::free(x);
    }
  }

  template <class Var>
  forceinline const VarArray<Var>&
  VarArray<Var>::operator=(const VarArray<Var>& a) {
    used = a.used; n = a.n; x = a.x;
    return *this;
  }

  template <class Var>
  forceinline int
  VarArray<Var>::size(void) const {
    return used;
  }

  template <class Var>
  forceinline void
  VarArray<Var>::resize(Space* home, int m) {
    int newsize;
    if (m<used) {
      newsize = m;
    } else if (m<n) {
      used = m; n = m;
      return;
    } else {
      newsize = std::max(m, (3*n)/2);
    }
    Var* oldx = x;
    x = static_cast<Var*>(Memory::malloc(sizeof(Var)*newsize));
    for (int i=used; i--;)
      new (&x[i]) Var(oldx[i]);
    if (used != n)
      Memory::free(oldx);
    else
      home->reuse(oldx, n);
    n = newsize; used = m;
  }

  template <class Var>
  forceinline Var&
  VarArray<Var>::operator[](int i) {
    assert((i >= 0) && (i < size()));
    return x[i];
  }

  template <class Var>
  forceinline const Var&
  VarArray<Var>::operator[](int i) const {
    assert((i >= 0) && (i < size()));
    return x[i];
  }

  template <class Var>
  forceinline void
  VarArray<Var>::add(Space* home, const Var& v) {
    resize(home, used+1);
    new (&(*this)[used-1]) Var(v);
  }

  template <class Var>
  forceinline void
  VarArray<Var>::update(Space* home, bool share, VarArray<Var>& a) {
    n = a.used;
    used = n;
    if (n > 0) {
      x = static_cast<Var*>(home->alloc(sizeof(Var)*n));
      for (int i = n; i--; )
        x[i].update(home, share, a.x[i]);
    } else {
      x = NULL;
    }
  }

  template <class Var>
  void*
  VarArray<Var>::operator new(size_t) {
    return NULL;
  }

  template <class Var>
  void
  VarArray<Var>::operator delete(void*,size_t) {
  }

  /*
   * View arrays
   *
   */

  template <class View>
  forceinline
  ViewArray<View>::ViewArray(void) : n(0), x(NULL) {}

  template <class View>
  forceinline
  ViewArray<View>::ViewArray(Space* home, int n0)
    : n(n0) {
    x = (n>0) ? static_cast<View*>(home->alloc(sizeof(View)*n)) : NULL;
  }

  template <class View>
  ViewArray<View>::ViewArray(Space* home, const ViewArray<View>& a)
    : n(a.size()) {
    if (n>0) {
      x = static_cast<View*>(home->alloc(sizeof(View)*n));
      for (int i = n; i--; )
        x[i] = a[i];
    } else {
      x = NULL;
    }
  }

  template <class View>
  ViewArray<View>::ViewArray(Space* home, const Reflection::VarMap& vars,
                             Reflection::Arg* spec) {
    if (spec == NULL) {
      x = NULL;
      n = 0;
      return;
    }
    Reflection::ArrayArg* a = spec->toArray();
    n = a->size();
    x = n>0 ? static_cast<View*>(home->alloc(sizeof(View)*n)) : NULL;
    for (int i=n; i--;)
      x[i] = View(home, vars, (*a)[i]);
  }

  template <class View>
  forceinline
  ViewArray<View>::ViewArray(const ViewArray<View>& a)
    : n(a.n), x(a.x) {}

  template <class View>
  forceinline const ViewArray<View>&
  ViewArray<View>::operator=(const ViewArray<View>& a) {
    n = a.n; x = a.x;
    return *this;
  }

  template <class View>
  forceinline int
  ViewArray<View>::size(void) const {
    return n;
  }

  template <class View>
  forceinline void
  ViewArray<View>::size(int n0) {
    n = n0;
  }

  template <class View>
  forceinline View&
  ViewArray<View>::operator[](int i) {
    assert((i >= 0) && (i < size()));
    return x[i];
  }

  template <class View>
  forceinline const View&
  ViewArray<View>::operator[](int i) const {
    assert((i >= 0) && (i < size()));
    return x[i];
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_fst(int i) {
    // move x[0] to x[i]
    assert(x[i].assigned());
    x[i]=x[0]; x++; n--;
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_lst(int i) {
    // move x[n-1] to x[i]
    assert(x[i].assigned());
    n--; x[i]=x[n];
  }

  template <class View>
  forceinline void
  ViewArray<View>::drop_fst(int i) {
    // Drop elements from 0..i-1
    assert(i>=0);
    x += i; n -= i;
  }

  template <class View>
  forceinline void
  ViewArray<View>::drop_lst(int i) {
    // Drop elements from i+1..n-1
    assert(i<n);
    n = i+1;
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_fst(int i, Space* home, Propagator* p, PropCond pc) {
    // Move x[0] to x[i]
    x[i].cancel(home,p,pc);
    x[i]=x[0]; x++; n--;
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_lst(int i, Space* home, Propagator* p, PropCond pc) {
    // Move x[n-1] to x[i]
    x[i].cancel(home,p,pc);
    n--; x[i]=x[n];
  }

  template <class View>
  void
  ViewArray<View>::drop_fst(int i, Space* home, Propagator* p, PropCond pc) {
    // Drop elements from 0..i-1
    assert(i>=0);
    for (int j=i; j--; )
      x[j].cancel(home,p,pc);
    x += i; n -= i;
  }

  template <class View>
  void
  ViewArray<View>::drop_lst(int i, Space* home, Propagator* p, PropCond pc) {
    // Drop elements from i+1..n-1
    assert(i<n);
    for (int j=i+1; j<n; j++)
      x[j].cancel(home,p,pc);
    n = i+1;
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_fst(int i, Space* home, Advisor* a) {
    // Move x[0] to x[i]
    x[i].cancel(home,a);
    x[i]=x[0]; x++; n--;
  }

  template <class View>
  forceinline void
  ViewArray<View>::move_lst(int i, Space* home, Advisor* a) {
    // Move x[n-1] to x[i]
    x[i].cancel(home,a);
    n--; x[i]=x[n];
  }

  template <class View>
  void
  ViewArray<View>::drop_fst(int i, Space* home, Advisor* a) {
    // Drop elements from 0..i-1
    assert(i>=0);
    for (int j=i; j--; )
      x[j].cancel(home,a);
    x += i; n -= i;
  }

  template <class View>
  void
  ViewArray<View>::drop_lst(int i, Space* home, Advisor* a) {
    // Drop elements from i+1..n-1
    assert(i<n);
    for (int j=i+1; j<n; j++)
      x[j].cancel(home,a);
    n = i+1;
  }

  template <class View>
  void
  ViewArray<View>::update(Space* home, bool share, ViewArray<View>& y) {
    n = y.n;
    if (n > 0) {
      x = static_cast<View*>(home->alloc(sizeof(View)*n));
      for (int i = n; i--; )
        x[i].update(home, share, y.x[i]);
    } else {
      x = NULL;
    }
  }

  template <class View>
  void
  ViewArray<View>::subscribe(Space* home, Propagator* p, PropCond pc, 
                             bool process) {
    for (int i = n; i--; )
      x[i].subscribe(home,p,pc,process);
  }

  template <class View>
  void
  ViewArray<View>::cancel(Space* home, Propagator* p, PropCond pc) {
    for (int i = n; i--; )
      x[i].cancel(home,p,pc);
  }

  template <class View>
  void
  ViewArray<View>::subscribe(Space* home, Advisor* a) {
    for (int i = n; i--; )
      x[i].subscribe(home,a);
  }

  template <class View>
  void
  ViewArray<View>::cancel(Space* home, Advisor* a) {
    for (int i = n; i--; )
      x[i].cancel(home,a);
  }

  template <class View>
  forceinline bool
  __before(const View& x, const View& y) {
    return before(x,y);
  }

  template <class View>
  forceinline bool
  ViewArray<View>::ViewLess::operator()(const View& a, const View& b) {
    return __before(a,b);
  }

  template <class View>
  void
  ViewArray<View>::sort(View* y, int m) {
    ViewLess vl;
    Support::quicksort<View,ViewLess>(y,m,vl);
  }

  template <class View>
  forceinline bool
  __same(const View& x, const View& y) {
    return same(x,y);
  }
  template <class View>
  forceinline bool
  __shared(const View& x, const View& y) {
    return shared(x,y);
  }

  template <class View>
  bool
  ViewArray<View>::same(void) const {
    if (n < 2)
      return false;
    GECODE_AUTOARRAY(View,y,n);
    for (int i = n; i--; )
      y[i] = x[i];
    sort(y,n);
    for (int i = n-1; i--; )
      if (!y[i].assigned() && __same(y[i+1],y[i]))
        return true;
    return false;
  }

  template <class View>
  bool
  ViewArray<View>::same(const View& y) const {
    if (y.assigned())
      return false;
    for (int i = n; i--; )
      if (__same(x[i],y))
        return true;
    return false;
  }

  template <class View>
  void
  ViewArray<View>::unique(void) {
    if (n < 2)
      return;
    sort(x,n);
    int j = 0;
    for (int i = 1; i<n; i++)
      if (!__same(x[j],x[i]))
        x[++j] = x[i];
    n = j+1;
  }

  template <class View>
  bool
  ViewArray<View>::shared(void) const {
    if (n < 2)
      return false;
    GECODE_AUTOARRAY(View,y,n);
    for (int i = n; i--; )
      y[i] = x[i];
    sort(y,n);
    for (int i = n-1; i--; )
      if (!y[i].assigned() && __shared(y[i+1],y[i]))
        return true;
    return false;
  }

  template <class View>
  bool
  ViewArray<View>::shared(const View& y) const {
    if (y.assigned())
      return false;
    for (int i = n; i--; )
      if (__shared(x[i],y))
        return true;
    return false;
  }

  template <class View>
  Reflection::Arg*
  ViewArray<View>::spec(const Space* home, Reflection::VarMap& m) const {
    Reflection::ArrayArg* s = Reflection::Arg::newArray(n);
    for (int i = 0; i<n; i++)
      (*s)[i] = x[i].spec(home, m);
    return s;
  }

  template <class View>
  void*
  ViewArray<View>::operator new(size_t) {
    return NULL;
  }

  template <class View>
  void
  ViewArray<View>::operator delete(void*,size_t) {
  }


  /*
   * Argument arrays: base class
   *
   */

  template <class T>
  forceinline T*
  ArgArrayBase<T>::allocate(int n) {
    return (n > onstack_size) ?
      Memory::bmalloc<T>(static_cast<size_t>(n)) : &onstack[0];
  }

  template <class T>
  forceinline
  ArgArrayBase<T>::ArgArrayBase(int n0)
    : n(n0), a(allocate(n0)) {
    for (int i=n; i--;)
      new (&a[i]) T();
  }

  template <class T>
  inline
  ArgArrayBase<T>::ArgArrayBase(const ArgArrayBase<T>& aa)
    : n(aa.n), a(allocate(aa.n)) {
    for (int i = n; i--; )
      new (&a[i]) T(aa.a[i]);
  }

  template <class T>
  forceinline
  ArgArrayBase<T>::~ArgArrayBase(void) {
    for (int i=n; i--;)
      a[i].~T();
    if (n > onstack_size)
      Memory::free(a);
  }

  template <class T>
  forceinline const ArgArrayBase<T>&
  ArgArrayBase<T>::operator=(const ArgArrayBase<T>& aa) {
    if (&aa != this) {
      if (n > onstack_size)
        Memory::free(a);
      n = aa.n;
      a = allocate(aa.n);
      for (int i = n; i--; )
        a[i] = aa.a[i];
    }
    return *this;
  }

  template <class T>
  forceinline int
  ArgArrayBase<T>::size(void) const {
    return n;
  }

  template <class T>
  forceinline T&
  ArgArrayBase<T>::operator[](int i) {
    assert((i>=0) && (i < n));
    return a[i];
  }

  template <class T>
  forceinline const T&
  ArgArrayBase<T>::operator[](int i) const {
    assert((i>=0) && (i < n));
    return a[i];
  }


  /*
   * Argument arrays for primitive types
   *
   */

  template <class T>
  forceinline
  PrimArgArray<T>::PrimArgArray(int n)
    : ArgArrayBase<T>(n) {}

  template <class T>
  PrimArgArray<T>::PrimArgArray(int n, T a0, ...)
    : ArgArrayBase<T>(n) {
    va_list args;
    va_start(args, a0);
    a[0] = a0;
    for (int i = 1; i < n; i++)
      a[i] = va_arg(args,T);
    va_end(args);
  }

  template <class T>
  PrimArgArray<T>::PrimArgArray(int n, const T* a0)
    : ArgArrayBase<T>(n) {
    for (int i=n; i--; )
      a[i] = a0[i];
  }

  template <class T>
  forceinline
  PrimArgArray<T>::PrimArgArray(const PrimArgArray<T>& aa)
    : ArgArrayBase<T>(aa) {}



  /*
   * Argument arrays for variables
   *
   */

  template <class T>
  forceinline
  VarArgArray<T>::VarArgArray(int n)
    : ArgArrayBase<T>(n) {}

  template <class T>
  forceinline
  VarArgArray<T>::VarArgArray(const VarArgArray<T>& aa)
    : ArgArrayBase<T>(aa) {}

  template <class T>
  inline
  VarArgArray<T>::VarArgArray(const VarArray<T>& x)
    : ArgArrayBase<T>(x.size()) {
    for (int i = x.size(); i--; )
      a[i] = x[i];
  }

  template <class Var>
  forceinline bool
  VarArgArray<Var>::VarLess::operator()(const Var& a, const Var& b) {
    return a.var() < b.var();
  }

  template <class Var>
  bool
  VarArgArray<Var>::same(void) const {
    if (n < 2)
      return false;
    GECODE_AUTOARRAY(Var,y,n);
    for (int i = n; i--; )
      y[i] = a[i];
    VarLess vl;
    Support::quicksort<Var,VarLess>(y,n,vl);
    for (int i = n-1; i--; )
      if (!y[i].assigned() && (y[i+1].var() == y[i].var()))
        return true;
    return false;
  }

  template <class Var>
  bool
  VarArgArray<Var>::same(const VarArgArray<Var>& y) const {
    int m = n + y.n;
    if (m < 2)
      return false;
    GECODE_AUTOARRAY(Var,z,m);
    for (int i = n; i--; )
      z[i] = a[i];
    for (int i = y.n; i--; )
      z[i+n] = y.a[i];
    VarLess vl;
    Support::quicksort<Var,VarLess>(z,m,vl);
    for (int i = m-1; i--; )
      if (!z[i].assigned() && (z[i+1].var() == z[i].var()))
        return true;
    return false;
  }

  template <class Var>
  bool
  VarArgArray<Var>::same(const Var& y) const {
    if (y.assigned())
      return false;
    for (int i = n; i--; )
      if (a[i].var() == y.var())
        return true;
    return false;
  }






  /*
   * Interdependent code
   *
   */

  template <class Var>
  inline
  VarArray<Var>::VarArray(Space* home, const VarArgArray<Var>& a)
    : n(a.size()) {
    if (n>0) {
      x = static_cast<Var*>(home->alloc(sizeof(Var)*n));
      for (int i = n; i--; )
        x[i] = a[i];
    } else {
      x = NULL;
    }
  }

}


/*
 * Printing of arrays
 *
 */
template<class Var>
std::ostream& 
operator<<(std::ostream& os, const Gecode::VarArray<Var>& x) {
  os << '{';
  if (x.size() > 0) {
    os << x[0];
    for (int i=1; i<x.size(); i++)
      os << ", " << x[i];
  }
  return os << '}';
}

template<class View>
std::ostream& 
operator<<(std::ostream& os, const Gecode::ViewArray<View>& x) {
  os << '{';
  if (x.size() > 0) {
    os << x[0];
    for (int i=1; i<x.size(); i++)
      os << ", " << x[i];
  }
  return os << '}';
}

template<class T>
std::ostream& 
operator<<(std::ostream& os, const Gecode::ArgArrayBase<T>& x) {
  os << '{';
  if (x.size() > 0) {
    os << x[0];
    for (int i=1; i<x.size(); i++)
      os << ", " << x[i];
  }
  return os << '}';
}

// STATISTICS: kernel-other