Vertex.h

/*
 *   Repast for High Performance Computing (Repast HPC)
 *
 *   Copyright (c) 2010 Argonne National Laboratory
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with
 *   or without modification, are permitted provided that the following
 *   conditions are met:
 *
 *     Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *     Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *     Neither the name of the Argonne National Laboratory nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  Vertex.h
 *
 *  Created on: Oct 13, 2010
 *      Author: nick
 */
 
#ifndef VERTEX_H_
#define VERTEX_H_
 
#include "AgentId.h"
 
#include <boost/unordered_map.hpp>
#include <boost/smart_ptr.hpp>
 
namespace repast {
 
template<typename V, typename E>
class Vertex;
 
template<typename V, typename E>
struct HashVertex {
        std::size_t operator()(Vertex<V, E>* vertex) const {
                return vertex->item()->getId().hashcode();
        }
};
 
template<typename V, typename E>
struct NodeGetter: public std::unary_function<
                typename boost::unordered_map<AgentId, Vertex<V, E>*, HashId>::value_type, V*> {
        V* operator()(const typename boost::unordered_map<AgentId, Vertex<V, E>*, HashId>::value_type& value) const {
                return value.second->ptr.get();
        }
};
 
template<typename V, typename E>
class Vertex {
 
public:
        typedef boost::unordered_map<Vertex<V, E>*, boost::shared_ptr<E>, HashVertex<V, E> > AdjListMap;
        typedef typename AdjListMap::iterator AdjListMapIterator;
 
        enum EdgeType {
                INCOMING, OUTGOING
        };
 
        Vertex(boost::shared_ptr<V> item);
        virtual ~Vertex() {
        }
 
        virtual boost::shared_ptr<E> removeEdge(Vertex* other, EdgeType type) = 0;
 
        virtual boost::shared_ptr<E> findEdge(Vertex* other, EdgeType type) = 0;
 
        virtual void addEdge(Vertex<V, E>* other, boost::shared_ptr<E> edge, EdgeType type) = 0;
 
        virtual void successors(std::vector<V*>& out) = 0;
 
        virtual void predecessors(std::vector<V*>& out) = 0;
 
        virtual void adjacent(std::vector<V*>& out) = 0;
 
        virtual void edges(EdgeType type, std::vector<boost::shared_ptr<E> >& out) = 0;
 
        virtual int inDegree() = 0;
 
        virtual int outDegree() = 0;
 
        boost::shared_ptr<V> item() const {
                return ptr;
        }
 
protected:
        friend struct NodeGetter<V, E> ;
        boost::shared_ptr<V> ptr;
        boost::shared_ptr<E> removeEdge(Vertex<V, E>* other, AdjListMap* adjMap);
        void getItems(AdjListMap *adjMap, std::vector<V*>& out);
        void edges(AdjListMap *adjMap, std::vector<boost::shared_ptr<E> >& out);
};
 
template<typename V, typename E>
Vertex<V, E>::Vertex(boost::shared_ptr<V> item) :
        ptr(item) {
}
 
template<typename V, typename E>
boost::shared_ptr<E> Vertex<V, E>::removeEdge(Vertex<V, E>* other, AdjListMap* adjMap) {
  boost::shared_ptr<E> ret;
  AdjListMapIterator iter = adjMap->find(other);
  if (iter != adjMap->end()) {
    ret = iter->second;
    adjMap->erase(iter);
  }
  return ret;
}
 
template<typename V, typename E>
void Vertex<V, E>::getItems(AdjListMap *adjMap, std::vector<V*>& out) {
  const AdjListMapIterator iterEnd = adjMap->end();
  for (AdjListMapIterator iter = adjMap->begin(); iter != iterEnd; ++iter) {
    out.push_back(iter->first->item().get());
  }
}
 
template<typename V, typename E>
void Vertex<V, E>::edges(AdjListMap *adjMap, std::vector<boost::shared_ptr<E> >& out){
  const AdjListMapIterator mapEnd = adjMap->end();
  for (AdjListMapIterator iter = adjMap->begin(); iter != mapEnd; ++iter) {
    out.push_back(iter->second);
  }
}
 
}
 
#endif /* VERTEX_H_ */