1 %feature("docstring") gum::CliqueGraph 2 " 3 CliqueGraph represents a Clique Graph. 4 5 CliqueGraph() -> CliqueGraph 6 default constructor 7 8 CliqueGraph(src) -> CliqueGraph 9 Parameter 10 * **src** (*pyAgrum.CliqueGraph*) -- the CliqueGraph to copy 11 " 12 13 %feature("docstring") gum::CliqueGraph::addToClique 14 " 15 Change the set of nodes included into a given clique and returns the new set 16 17 Parameters 18 ---------- 19 clique_id : int 20 the id of the clique 21 node_id : int 22 the id of the node 23 24 Raises 25 ------ 26 pyAgrum.NotFound 27 If clique_id does not exist 28 pyAgrum.DuplicateElement 29 If clique_id set already contains the ndoe 30 " 31 32 %feature("docstring") gum::CliqueGraph::clearEdges 33 " 34 Remove all edges and their separators 35 " 36 37 %feature("docstring") gum::CliqueGraph::clique 38 " 39 Parameters 40 ---------- 41 idClique : int 42 the id of the clique 43 44 Returns 45 ------- 46 Set 47 The set of nodes included in the clique 48 49 Raises 50 ------ 51 pyAgrum.NotFound 52 If the clique does not belong to the clique graph 53 " 54 55 %feature("docstring") gum::CliqueGraph::separator 56 " 57 Parameters 58 ---------- 59 clique1 : int 60 one extremity of the edge 61 clique : int 62 the other extremity of the edge 63 64 Returns 65 ------- 66 Set 67 the separator included in a given edge 68 69 Raises 70 ------ 71 pyAgrum.NotFound 72 If the edge does not belong to the clique graph 73 " 74 75 %feature("docstring") gum::CliqueGraph::container 76 " 77 Parameters 78 ---------- 79 idNode : int 80 the id of the node 81 82 Returns 83 ------- 84 int 85 the id of a clique containing the node 86 87 Raises 88 ------ 89 pyAgrum.NotFound 90 If no clique contains idNode 91 " 92 93 %feature("docstring") gum::CliqueGraph::containerPath 94 " 95 Parameters 96 ---------- 97 node1 : int 98 the id of one node 99 node2 : int 100 the id of the other node 101 102 Returns 103 ------- 104 List 105 a path from a clique containing node1 to a clique containing node2 106 107 Raises 108 ------ 109 pyAgrum.NotFound 110 If such path cannot be found 111 " 112 113 %feature("docstring") gum::CliqueGraph::eraseFromClique 114 " 115 Remove a node from a clique 116 117 Parameters 118 ---------- 119 clique_id : int 120 the id of the clique 121 node_id : int 122 the id of the node 123 124 Raises 125 ------ 126 pyAgrum.NotFound 127 If clique_id does not exist 128 " 129 130 %feature("docstring") gum::CliqueGraph::hasRunningIntersection 131 " 132 Returns 133 ------- 134 bool 135 True if the running intersection property holds 136 " 137 138 %feature("docstring") gum::CliqueGraph::isJoinTree 139 " 140 Returns 141 ------- 142 bool 143 True if the graph is a join tree 144 " 145 146 %feature("docstring") gum::CliqueGraph::separator 147 " 148 Parameters 149 ---------- 150 edge : pyAgrum.Edge 151 the edge to be checked 152 clique1 : int 153 one extremity of the edge 154 clique : int 155 the other extremity of the edge 156 157 Returns 158 ------- 159 Set 160 the separator included in a given edge 161 162 Raises 163 ------ 164 pyAgrum.NotFound 165 If the edge does not belong to the clique graph 166 " 167 168 %feature("docstring") gum::CliqueGraph::setClique 169 " 170 changes the set of nodes included into a given clique 171 172 Parameters 173 ---------- 174 idClique : int 175 the id of the clique 176 new_clique : Set 177 the new set of nodes to be included in the clique 178 179 Raises 180 ------ 181 pyAgrum.NotFound 182 If idClique is not a clique of the graph 183 " 184