File: ReachableSubGraphSelection.cpp

package info (click to toggle)
tulip 6.0.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 196,224 kB
  • sloc: cpp: 571,851; ansic: 13,983; python: 4,105; sh: 1,555; yacc: 522; xml: 484; makefile: 168; pascal: 148; lex: 55
file content (145 lines) | stat: -rw-r--r-- 4,737 bytes parent folder | download
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/**
 *
 * This file is part of Tulip (https://tulip.labri.fr)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 */

#include "ReachableSubGraphSelection.h"

#include <tulip/StringCollection.h>
#include <tulip/GraphTools.h>
#include <tulip/StableIterator.h>

using namespace tlp;

PLUGIN(ReachableSubGraphSelection)

static const char *paramHelp[] = {
    // edge direction
    "This parameter defines the navigation direction.",

    // selection
    "This property indicates the selected nodes used to walk in the graph.",

    // max distance
    "This parameter defines the maximum path length (number of edges) between a node already selected and a node that can be reached."};

static const char *directionValuesDescription =
    "output edges: <i>follow output edges (directed)</i><br>"
    "input edges : <i>follow input edges (reverse-directed)</i><br>"
    "all edges   : <i>all edges (undirected)</i>";

#define DIRECTION "output edges; input edges;all edges"
#define DIRECTION_OUTPUT 0
#define DIRECTION_INPUT 1
#define DIRECTION_ALL 2

ReachableSubGraphSelection::ReachableSubGraphSelection(const tlp::PluginContext *context)
    : BooleanAlgorithm(context) {
  addInParameter<StringCollection>("edge direction", paramHelp[0], DIRECTION, true,
                                   directionValuesDescription);
  addInParameter<BooleanProperty>("selection", paramHelp[1], "viewSelection");
  addInParameter<int>("max distance", paramHelp[2], "5");
  addOutParameter<unsigned int>("#edges selected", "The number of newly selected edges");
  addOutParameter<unsigned int>("#nodes selected", "The number of newly selected nodes");
}

///===========================================================
bool ReachableSubGraphSelection::run() {
  unsigned int maxDistance = 5;
  StringCollection edgeDirectionCollection(DIRECTION);
  edgeDirectionCollection.setCurrent(0);
  EDGE_TYPE edgeDirection = DIRECTED;
  BooleanProperty *startNodes = graph->getProperty<BooleanProperty>("viewSelection");

  if (dataSet != nullptr) {
    dataSet->get("max distance", maxDistance);

    // Get the edge orientation
    int direction = 0;
    if (dataSet->get("edge direction", edgeDirectionCollection))
      direction = edgeDirectionCollection.getCurrent();
    else
      // If the new parameter is not defined search for the very former one.
      dataSet->get("direction", direction);

    switch (direction) {
    case 0:
      edgeDirection = DIRECTED;
      break;

    case 1:
      edgeDirection = INV_DIRECTED;
      break;

    case 2:
      edgeDirection = UNDIRECTED;
    }

    dataSet->get("selection", startNodes);
  }

  unsigned num_nodes = 0, num_edges = 0;

  if (startNodes) {
    // as the input selection property and the result property can be the same one,
    // if needed, use a stable iterator to keep a copy of the input selected nodes as all values
    // of the result property are reset to false below
    // deletion is done by the for loop
    Iterator<node> *itN = (result == startNodes) ? stableIterator(startNodes->getNodesEqualTo(true))
                                                 : startNodes->getNodesEqualTo(true);

    tlp_hash_map<node, bool> reachables;

    result->setAllEdgeValue(false);
    result->setAllNodeValue(false);

    // iterate on startNodes add them and their reachables
    for (const node &current : itN) {
      reachables[current] = true;
      markReachableNodes(graph, current, reachables, maxDistance, edgeDirection);
    }

    // select nodes
    for (auto it : reachables) {
      result->setNodeValue(it.first, true);
      ++num_nodes;
    }

    // select corresponding edges
    auto ite = reachables.cend();
    for (const edge e : graph->edges()) {
      auto ends = graph->ends(e);

      if ((reachables.find(ends.first) != ite) && (reachables.find(ends.second) != ite)) {
        result->setEdgeValue(e, true);
        ++num_edges;
      }
    }

  } else {
    result->setAllEdgeValue(false);
    result->setAllNodeValue(false);
  }

  // output some useful information
  if (dataSet != nullptr) {
    dataSet->set("#edges selected", num_edges);
    dataSet->set("#nodes selected", num_nodes);
  }

  return true;
}