source: src/Graph/BoostGraphCreator.hpp@ b1f995

/*
 * BoostGraphCreator.hpp
 *
 *  Created on: May 17, 2017
 *      Author: heber
 */


#ifndef GRAPH_BOOSTGRAPHCREATOR_HPP_
#define GRAPH_BOOSTGRAPHCREATOR_HPP_

// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <vector>

#include <boost/function.hpp>
#include <boost/graph/adjacency_list.hpp>

class atom;
class bond;
class molecule;

/** This is a helper class that contains functions to create a boost::graph
 * from the present bond graph of molecules.
 */
struct BoostGraphCreator
{
public:
  //!> typedef for an undirected graph using boost::graph
  typedef boost::adjacency_list < boost::vecS, boost::vecS, boost::undirectedS,
      boost::no_property, boost::no_property > UndirectedGraph;
  //!> typedef for a map of graph node indices
  typedef boost::property_map < boost::adjacency_list <>, boost::vertex_index_t >::type index_map_t;
  //!> typedef for the  predicate to evaluate for adding the current edge or not
  typedef boost::function<bool (const bond &)> predicate_t;


  /** Creates the boost::graph using all atoms and bonds in the given \a _mol.
   *
   * \param _mol molecule whose bond graph to construct
   * \param _pred predicate to evaluate on adding each edge/bond
   */
  void createFromMolecule(
      const molecule &_mol,
      const predicate_t &_pred);

  /** Creates the boost::graph using all atoms and bonds in the given vector
   * of \a _atoms
   *
   * \param _atoms vector of _atoms whose bond graph to construct
   * \param _pred predicate to evaluate on adding each edge/bond
   */
  void createFromAtoms(
      const std::vector<atom *> &_atoms,
      const predicate_t &_pred);

  /** Getter for the created graph.
   *
   * \return graph
   */
  UndirectedGraph get() const
  { return graph; }

  /** Getter for the index map  of the created graph.
   *
   * \return indexmap
   */
  index_map_t getIndexMap() const {
    return boost::get(boost::vertex_index, graph);
  }

  /** Return the number of vertices contained in the created graph.
   *
   * \return number of vertices
   */
  size_t getNumVertices() const {
    return boost::num_vertices(graph);
  }

  /** Return the number of edges contained in the created graph.
   *
   * \return number of edges
   */
  size_t getNumEdges() const {
    return boost::num_edges(graph);
  }

private:
  /** General purpose function that contains the internal logic of walking the
   * bonds of a set of atoms given by \a _begin and \a _end iterators and
   * adding its edges to a graph based on the evaluation of a given predicate
   * \a _pred.
   *
   * \note We need \a _no_nodes because molecule::iterator does not work with
   * std::distance.
   *
   * \param _begin begin iterator
   * \param _end end iterator
   * \param _no_nodes number of nodes
   * \param _pred predicate
   */
  template <typename iterator>
  void createFromRange(
      const iterator &_begin,
      const iterator &_end,
      const size_t &_no_nodes,
      const predicate_t &_pred
      );

private:
  //!> internal graph that is created by creator functions
  UndirectedGraph graph;
};


#endif /* GRAPH_BOOSTGRAPHCREATOR_HPP_ */