1 %feature("docstring") gum::IBayesNet 2 " 3 Abstract class used by BayesNet. 4 " 5 6 %feature("docstring") gum::IBayesNet::dim 7 " 8 Returns the dimension (the number of free parameters) in this BayesNet. 9 10 Returns 11 ------- 12 int 13 the dimension of the BayesNet 14 " 15 16 %feature("docstring") gum::IBayesNet::jointProbability 17 " 18 Parameters 19 ---------- 20 i : pyAgrum.instantiation 21 an instantiation of the variables 22 23 Returns 24 ------- 25 double 26 a parameter of the joint probability for the BayesNet 27 28 Warnings 29 -------- 30 a variable not present in the instantiation is assumed to be instantiated to 0 31 " 32 33 %feature("docstring") gum::IBayesNet::log2JointProbability 34 " 35 Parameters 36 ---------- 37 i : pyAgrum.instantiation 38 an instantiation of the variables 39 40 Returns 41 ------- 42 double 43 a parameter of the log joint probability for the BayesNet 44 45 Warnings 46 -------- 47 a variable not present in the instantiation is assumed to be instantiated to 0 48 " 49 50 %feature("docstring") gum::IBayesNet::maxNonOneParam 51 " 52 Returns 53 ------- 54 double 55 The biggest value (not equal to 1) in the CPTs of the BayesNet 56 " 57 58 %feature("docstring") gum::IBayesNet::maxParam 59 " 60 Returns 61 ------- 62 double 63 the biggest value in the CPTs of the BayesNet 64 " 65 66 %feature("docstring") gum::IBayesNet::maxVarDomainSize 67 " 68 Returns 69 ------- 70 int 71 the biggest domain size among the variables of the BayesNet 72 " 73 74 %feature("docstring") gum::IBayesNet::minNonZeroParam 75 " 76 Returns 77 ------- 78 double 79 the smallest value (not equal to 0) in the CPTs of the IBayesNet 80 " 81 82 %feature("docstring") gum::IBayesNet::minParam 83 " 84 Returns 85 ------- 86 double 87 the smallest value in the CPTs of the IBayesNet 88 " 89 90 %feature("docstring") gum::IBayesNet::toDot 91 " 92 Returns 93 ------- 94 str 95 a friendly display of the graph in DOT format 96 " 97 98 %feature("docstring") gum::IBayesNet::arcs 99 " 100 Returns 101 ------- 102 list 103 The lisf of arcs in the IBayesNet 104 " 105 106 %feature("docstring") gum::IBayesNet::children 107 " 108 Parameters 109 ---------- 110 id : int 111 the id of the parent 112 113 Returns 114 ------- 115 Set 116 the set of all the children 117 " 118 119 %feature("docstring") gum::IBayesNet::cpt 120 " 121 Returns the CPT of a variable. 122 123 Parameters 124 ---------- 125 VarId : int 126 A variable's id in the pyAgrum.IBayesNet. 127 name : str 128 A variable's name in the pyAgrum.IBayesNet. 129 130 Returns 131 ------- 132 pyAgrum.Potential 133 The variable's CPT. 134 135 Raises 136 ------ 137 pyAgrum.NotFound 138 If no variable's id matches varId. 139 " 140 141 %feature("docstring") gum::IBayesNet::parents 142 " 143 Parameters 144 ---------- 145 id : 146 The id of the child node 147 148 Returns 149 ------- 150 Set 151 the set of the parents ids. 152 " 153 154 %feature("docstring") gum::IBayesNet::ids 155 " 156 .. note:: Deprecated in pyAgrum>0.13.0 157 Please use nodes() instead 158 " 159 160 %feature("docstring") gum::IBayesNet::nodes 161 " 162 Returns 163 ------- 164 set 165 the set of ids 166 " 167 168 %feature("docstring") gum::IBayesNet::names 169 " 170 Returns 171 ------- 172 list 173 The names of the graph variables 174 " 175 176 %feature("docstring") gum::IBayesNet::minimalCondSet 177 " 178 Returns, given one or many targets and a list of variables, the minimal set of those needed to calculate the target/targets. 179 180 Parameters 181 ---------- 182 target : int 183 The id of the target 184 targets : list 185 The ids of the targets 186 list : list 187 The list of available variables 188 189 Returns 190 ------- 191 Set 192 The minimal set of variables 193 " 194