doc_CliqueGraph.i 2.63 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 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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
%feature("docstring") gum::CliqueGraph
"
CliqueGraph represents a Clique Graph.

Available constructors:
    ``CliqueGraph() -> CliqueGraph``

    ``CliqueGraph(src) -> CliqueGraph``

Parameters
----------
src : :class: CliqueGraph
  the CliqueGraph to copy
"

%feature("docstring") gum::CliqueGraph::addToClique
"
Change the set of nodes included into a given clique and returns the new set 

Parameters
----------
clique_id : int
	the id of the clique
node_id : int
	the id of the node

Warnings
--------
NotFound raised if clique_id does not exist

Warnings
--------
DuplicateElement raised if clique_id set already contains the ndoe
"

%feature("docstring") gum::CliqueGraph::clearEdges
"
Remove all edges and their separators 
"

%feature("docstring") gum::CliqueGraph::clique
"
Parameters
----------
idClique : int
	the id of the clique

Returns
-------
Set
	The set of nodes included in the clique

Warnings
--------
NotFound raised if the clique does not belong to the clique graph
"

%feature("docstring") gum::CliqueGraph::container
"
Parameters
----------
idNode : int
	the id of the node

Returns
-------
int
	the id of a clique containing the node

Warnings
--------
NotFound raised if no clique contains idNode	
"

%feature("docstring") gum::CliqueGraph::containerPath
"
Parameters
----------
node1 : int
	the id of one node
node2 : int
	the id of the other node

Returns
-------
List
	a path from a clique containing node1 to a clique containing node2

Warnings
--------
NotFound raised if such path cannot be found
"

%feature("docstring") gum::CliqueGraph::eraseFromClique
"
Remove a node from a clique

Parameters
----------
clique_id : int
	the id of the clique
node_id : int
	the id of the node

Warnings
--------
NotFound raised if clique_id does not exist
"

%feature("docstring") gum::CliqueGraph::hasRunningIntersection
"
Returns
-------
bool
	True if the running intersection property holds 
"

%feature("docstring") gum::CliqueGraph::isJoinTree
"
Returns
-------
bool
	True if the graph is a join tree 
"

%feature("docstring") gum::CliqueGraph::separator
"
Parameters
----------
edge : Edge
	the edge to be checked
clique1 : int 
	one extremity of the edge
clique : int 
	the other extremity of the edge

Returns
-------
Set
	the separator included in a given edge

Warnings
--------
NotFound raised if the edge does not belong to the clique graph
"

%feature("docstring") gum::CliqueGraph::setClique
"
changes the set of nodes included into a given clique

Parameters
----------
idClique : int
	the id of the clique
new_clique : Set
	the new set of nodes to be included in the clique

Warnings
--------
NotFound exception if idClique is not a clique of the graph
"