File: AcyclicTest.sip

package info (click to toggle)
tulip 4.8.0dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 179,264 kB
  • ctags: 64,517
  • sloc: cpp: 600,444; ansic: 36,311; makefile: 22,136; python: 1,304; sh: 946; yacc: 522; xml: 337; pascal: 157; php: 66; lex: 55
file content (112 lines) | stat: -rw-r--r-- 3,823 bytes parent folder | download | duplicates (3)
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
/**
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * 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.
 *
 */

// +-------------------------------------------------------------------------+
// | Tulip Python Bindings                                                   |
// | inspired from bindings by the Booggie project development team         |
// | (http://booggie.org/)                                                   |
// +-------------------------------------------------------------------------+

namespace tlp {

class SelfLoops {
%TypeHeaderCode
#include <tulip/AcyclicTest.h>
%End

%Docstring
The tlp.SelfLoops class represents a self loop that has been replaced by two nodes and three edges.
The method :meth:`tlp.AcyclicTest.makeAcyclic` returns a list of this type.
 
It contains the following variables :

* old (:class:`tlp.edge`) : the self loop edge that has been replaced
* n1 (:class:`tlp.node`) : the first node added
* n2 (:class:`tlp.node`) : the second node added
* e1 (:class:`tlp.edge`) : the edge added between the node at the extremity of the loop and n1
* e2 (:class:`tlp.edge`) : the edge added between n1 and n2
* e3 (:class:`tlp.edge`) : the edge added between the node at the extremity of the loop and n2

%End

  public:
    SelfLoops(tlp::node n1, tlp::node n2, tlp::edge e1, tlp::edge e2, tlp::edge e3, tlp::edge old);
    
    tlp::node n1;
    tlp::node n2;
    tlp::edge e1;
    tlp::edge e2; 
    tlp::edge e3; 
    tlp::edge old;  
};

class AcyclicTest {
%TypeHeaderCode
#include <tulip/AcyclicTest.h>
%End
public:

  static bool isAcyclic(const tlp::Graph *graph);
%Docstring
tlp.AcyclicTest.isAcyclic(graph)

Returns :const:`True` if the graph is acyclic, :const:`False` if not.
The result is cached (ie. the next call with the same graph is done in O(1) time)

:param graph: the graph on which to perform the acyclic test
:type graph: :class:`tlp.Graph`
:rtype: boolean
%End

//===========================================================================================

   static void makeAcyclic(tlp::Graph* graph, std::vector<tlp::edge> &reversed /Out/, std::vector<tlp::SelfLoops> &selfLoops /Out/);
%Docstring
tlp.AcyclicTest.makeAcyclic(graph)

Makes the graph acyclic, by reversing edge direction (feedback arc set problem).
If there is self loops, a new node is added with two edges that points to it.
Returns a tuple containing whose first member is a list of reversed edges and second member is a list
of transformed self loops.

:param graph: the graph to make acyclic
:type graph: :class:`tlp.Graph`
:rtype: (list of :class:`tlp.edge`, list of :class:`tlp.SelfLoops`)
%End 

//=========================================================================================== 
 
   static bool acyclicTest(const tlp::Graph *graph, std::vector<tlp::edge> *obstructionEdges /Out/);
%Docstring
tlp.AcyclicTest.acyclicTest(graph)

Returns a tuple whose first member is a boolean indicating if the graph is acyclic or not
and second member is a list of edges that create cycle (when the graph is not acyclic). 

:param graph: the graph on which to perform the acyclic test
:type graph: :class:`tlp.Graph`
:rtype: (boolean, list of :class:`tlp.edge`)
%End
  
private : 

	AcyclicTest();
};

};