graphvisitor.h

Go to the documentation of this file.

/*
 *            Copyright 2009-2020 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_GRAPHVISITOR_H
#define VOTCA_TOOLS_GRAPHVISITOR_H
 
// Standard includes
#include <set>
#include <vector>
 
// Local VOTCA includes
#include "edge.h"
#include "graphnode.h"
 
namespace votca {
namespace tools {
 
class Graph;
 
class GraphVisitor {
 protected:
  std::set<Index> explored_;
 
  Index startingVertex_ = 0;
 
  virtual void addEdges_(const Graph& graph, Index vertex) = 0;
  virtual Edge getEdge_() = 0;
 public:
  virtual void exploreNode(std::pair<Index, GraphNode>& vertex_and_node,
                           Graph& graph, Edge edge = DUMMY_EDGE);
 
  GraphVisitor() = default;
 
  std::vector<Index> getUnexploredVertex(const Edge edge) const;
 
  virtual bool queEmpty() const;
 
  void setStartingVertex(Index vertex) { startingVertex_ = vertex; }
  Index getStartingVertex() const { return startingVertex_; }
 
  void initialize(Graph& graph);
 
  virtual void exec(Graph& graph, Edge edge);
 
  Edge nextEdge(Graph graph);
 
  std::set<Index> getExploredVertices() const;
 
  bool vertexExplored(const Index vertex) const;
};
}  // namespace tools
}  // namespace votca
 
#endif  // VOTCA_TOOLS_GRAPHVISITOR_H