var-map.icc

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2007
 *
 *  Last modified:
 *     $Date: 2008-07-11 09:39:08 +0200 (Fri, 11 Jul 2008) $ by $Author: tack $
 *     $Revision: 7297 $
 *
 *  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 <sstream>

namespace Gecode { namespace Reflection {
  
  class VarMapIter;

  class GECODE_KERNEL_EXPORT VarMap {
    friend class VarMapIter;
  private:
    class VarMapObj;
    VarMapObj* vo;
    
  public:
    VarMap(void);
    VarMap(const VarMap&);
    VarMap& operator=(const VarMap&);
    GECODE_MSC_VIRTUAL ~VarMap(void);
    
    int size(void) const;
    
    int index(const VarImpBase* x) const;
    int index(const Support::Symbol& n) const;

    bool nameIsKnown(const Support::Symbol& n) const;

    bool hasName(const VarImpBase* x) const;
    bool hasName(int i) const;

    Support::Symbol name(const VarImpBase* x) const;
    Support::Symbol name(int i) const;

    VarImpBase* varImpBase(const Support::Symbol& n) const;
    VarImpBase* varImpBase(int i) const;
    Var var(const Support::Symbol& n) const;
    Var var(int i) const;

    VarSpec& spec(const VarImpBase* x) const;
    VarSpec& spec(int i) const;
    VarSpec& spec(const Support::Symbol& n) const;

    void name(VarImpBase* x, const Support::Symbol& n);

    int put(const VarImpBase* x, VarSpec* vs);

    void putMasterObject(void* obj);
    int getSharedIndex(void* obj) const;
    void* getSharedObject(int i) const;



    template <class Var> void
    put(const Space* home, const Var& v, const Support::Symbol& n,
        bool registerOnly = false);
    template <class Var> void
    putArray(const Space* home, const VarArgArray<Var>& v,
             const Support::Symbol& n, bool registerOnly = false);
    template <class Var> void
    putArray(const Space* home, const VarArray<Var>& v,
             const Support::Symbol& n,
             bool registerOnly = false);


  };
  
  class GECODE_KERNEL_EXPORT VarMapIter {
  private:
    VarMap* m;
    int i;
  public:
    VarMapIter(VarMap& m);
    bool operator()(void) const;
    VarSpec& spec(void) const;
    VarImpBase* varImpBase(void) const;
    Var var(void) const;
    void operator++(void);
  };

  template <> void
  inline
  VarMap::put(const Space* home, const Reflection::Var& x,
              const Support::Symbol& n, bool registerOnly) {
    if (! (n == ""))
      name(x.varImpBase(), n);
    if (!registerOnly) {
      Reflection::Arg* a = x.spec(home, *this);
      delete a;
    }
  }

  template <class V> void
  VarMap::put(const Space* home, const V& x, const Support::Symbol& n,
              bool registerOnly) {
    typename VarViewTraits<V>::View v(x);
    if (! (n == ""))
      name(v.var(), n);
    if (!registerOnly) {
      Reflection::Arg* a = v.spec(home, *this);
      delete a;
    }
  }

  template <class Var> void
  VarMap::putArray(const Space* home, const VarArgArray<Var>& x,
                   const Support::Symbol& n, bool registerOnly) {
    for (int i=0; i<x.size(); i++) {
      std::stringstream s;
      s << i;
      Support::Symbol nn = n.copy();
      nn += Support::Symbol(s.str().c_str(), true);
      put(home, x[i], nn, registerOnly);
    }
  }
  template <class Var> void
  VarMap::putArray(const Space* home, const VarArray<Var>& x,
                   const Support::Symbol& n, bool registerOnly) {
    for (int i=0; i<x.size(); i++) {
      std::stringstream s;
      s << i;
      Support::Symbol nn = n.copy();
      nn += Support::Symbol(s.str().c_str(), true);
      put(home, x[i], nn, registerOnly);
    }
  }

}}

// STATISTICS: kernel-other