edgecontainer.h 2.16 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/*
 *            Copyright 2009-2018 The VOTCA Development Team
 *                       (http://www.votca.org)
 *
 *      Licensed under the Apache License, Version 2.0 (the "License")
 *
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *              http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef _VOTCA_TOOLS_EDGECONTAINER_H
#define _VOTCA_TOOLS_EDGECONTAINER_H

#include <vector>
#include <unordered_map>
#include <map>
#include <set>
#include <votca/tools/edge.h>

namespace votca {
namespace tools {

/**
 *   \brief EdgeContainer is responsible for operations on groups of edges
 *
 *   Such operations have to deal with finding edges attached to a vertex
 *   finding neighboring vertices etc.
 */
class EdgeContainer {
 protected:
  std::unordered_map<int,std::set<int>> adj_list_; 
 public:
  /// Constructors can take no arguments a single Edge or a vector of edges
  EdgeContainer() {};
  EdgeContainer(Edge ed);
  EdgeContainer(std::vector<Edge> eds);

  /// Get the value of the max degree
  int getMaxDegree();
  /// Contains vector of all vertices with degree
  std::vector<int> getVerticesDegree(int degree);
  /// Determine the degree of the vertex/number of edges attached
  int getDegree(int vert);
  /// Check if the edge exists returns true or false
  bool edgeExist(Edge ed);
  /// Check if the vertex exists returns true or false
  bool vertexExist(int vert);
  /// Add an edge to the container
  void addEdge(Edge ed);
  /// Get all the edges in vector form
  std::vector<Edge> getEdges();
  /// Get all the vertices in vector form
  std::vector<int> getVertices();
  /// Get the vertices neighboring vert
  std::vector<int> getNeighVertices(int vert);
  /// Get the edges neighboring vert
  std::vector<Edge> getNeighEdges(int vert);
 
};
}
}

#endif  // _VOTCA_TOOLS_EDGECONTAINER_H