1 %feature("docstring") gum::DiscreteVariable 2 " 3 DiscreteVariable is the (abstract) base class for discrete random variables. 4 " 5 6 %feature("docstring") gum::DiscreteVariable::clone 7 " 8 Returns 9 ------- 10 pyAgrum.DiscreteVariable 11 a copy of the DiscreteVariable 12 " 13 14 %feature("docstring") gum::DiscreteVariable::domain 15 " 16 Returns 17 ------- 18 str 19 the domain of the variable 20 " 21 22 %feature("docstring") gum::DiscreteVariable::domainSize 23 " 24 Returns 25 ------- 26 int 27 the number of modalities in the variable domain 28 " 29 30 %feature("docstring") gum::DiscreteVariable::empty 31 " 32 Returns 33 ------- 34 bool 35 True if the domain size < 2 36 " 37 38 %feature("docstring") gum::DiscreteVariable::index 39 " 40 Parameters 41 ---------- 42 label : str 43 a label 44 45 Returns 46 ------- 47 int 48 the indice of the label 49 " 50 51 %feature("docstring") gum::DiscreteVariable::label 52 " 53 Parameters 54 ---------- 55 i : int 56 the index of the label we wish to return 57 58 Returns 59 ------- 60 str 61 the indice-th label 62 63 Raises 64 ------ 65 pyAgrum.OutOfBound 66 If the variable does not contain the label 67 " 68 69 %feature("docstring") gum::DiscreteVariable::labels 70 " 71 Returns 72 ------- 73 tuple 74 a tuple containing the labels 75 " 76 77 %feature("docstring") gum::DiscreteVariable::numerical 78 " 79 Parameters 80 ---------- 81 indice : int 82 an index 83 84 Returns 85 ------- 86 float 87 the numerical representation of the indice-th value 88 " 89 90 %feature("docstring") gum::DiscreteVariable::toDiscretizedVar 91 " 92 Returns 93 ------- 94 pyAgrum.DiscretizedVariable 95 the discretized variable 96 97 Raises 98 ------ 99 pyAgrum.RuntimeError 100 If the variable is not a DiscretizedVariable 101 " 102 103 %feature("docstring") gum::DiscreteVariable::toLabelizedVar 104 " 105 Returns 106 ------- 107 pyAgrum.LabelizedVariable 108 the labelized variable 109 110 Raises 111 ------ 112 pyAgrum.RuntimeError 113 If the variable is not a LabelizedVariable 114 " 115 116 %feature("docstring") gum::DiscreteVariable::toRangeVar 117 " 118 Returns 119 ------- 120 pyAgrum.RangeVariable 121 the range variable 122 123 Raises 124 ------ 125 pyAgrum.RuntimeError 126 If the variable is not a RangeVariable 127 " 128 129 %feature("docstring") gum::DiscreteVariable::toStringWithDescription 130 " 131 Returns 132 ------- 133 str 134 a description of the variable 135 " 136 137 %feature("docstring") gum::DiscreteVariable::varType 138 " 139 returns the type of variable 140 141 Returns 142 ------- 143 int : 144 the type of the variable, 0: DiscretizedVariable, 1: LabelizedVariable, 2: RangeVariable 145 " 146