Commit 5628af63 by Gaspard Ducamp

[pyAgrum/doc] several functions unreferenced

parent db46407a
Pipeline #13793663 passed with stage
in 2 minutes 16 seconds
......@@ -45,27 +45,6 @@ bool
True if all the named node are the same and all the named arcs are the same
"
%feature("docstring") gum::DAGmodel::property
"
Warnings
--------
N'est plus référencée
"
%feature("docstring") gum::DAGmodel::propertyWithDefault
"
Warnings
--------
N'est plus référencée
"
%feature("docstring") gum::DAGmodel::setProperty
"
Warnings
--------
N'est plus référencée
"
%feature("docstring") gum::DAGmodel::size
"
Returns
......@@ -102,4 +81,25 @@ Returns
-------
pyAgrum.UndiGraph
The moral graph
"
%feature("docstring") gum::DAGmodel::property
"
Warnings
--------
Unreferenced function
"
%feature("docstring") gum::DAGmodel::propertyWithDefault
"
Warnings
--------
Unreferenced function
"
%feature("docstring") gum::DAGmodel::setProperty
"
Warnings
--------
Unreferenced function
"
\ No newline at end of file
......@@ -284,7 +284,7 @@ Parameters
----------
i : pyAgrum.Instantiation
The sequence of variables with which to reorder this Instantiation.
v : ?
v : list
The new order of variables for this Instantiation.
"
......
......@@ -56,25 +56,6 @@ Examples
>>> ## 'B'
"
%feature("docstring") gum::LabelizedVariable::addLabel
"
Add a label with a new index (we assume that we will NEVER remove a label).
Parameters
----------
aLabel : str
the label to be added to the labelized variable
Returns
-------
pyAgrum.LabelizedVariable
the labelized variable
Warnings
--------
DuplicateElement raised is raised if the variable already contains the label
"
%feature("docstring") gum::LabelizedVariable::changeLabel
"
Change the label at the specified index
......
......@@ -96,13 +96,6 @@ double
the entropy of the potential
"
%feature("docstring") gum::Potential::populate
"
Returns
-------
à Faire
"
%feature("docstring") gum::Potential::extract
"
create a new Potential extracted from self given a partial instantiation.
......@@ -173,6 +166,13 @@ Warnings
SizeError Raised if v size's does not matches the domain size.
"
%feature("docstring") gum::Potential::populate
"
Warnings
--------
See fillWith to fill the potential.
"
%feature("docstring") gum::Potential::get
"
Parameters
......@@ -552,4 +552,4 @@ Returns
Warnings
--------
NotFound raised if i does not reference a variable in this multidimensional matrix.
"
"
\ No newline at end of file
......@@ -7,8 +7,10 @@ Model
-----
.. autoclass:: pyAgrum.BayesNet
:exclude-members: setProperty, property, propertyWithDefault
.. autoclass:: pyAgrum.pyAgrum.BayesNet_double
:exclude-members: setProperty, property, propertyWithDefault
Inference
---------
......
......@@ -504,8 +504,8 @@ def process_docstring(app, what, name, obj, options, lines):
def process_signature(app, what, name, obj, options, signature, return_annotation):
signature = substitution4swigautodoc(signature)
return_annotation = substitution4swigautodoc(return_annotation)
#return_annotation = None
#return_annotation = substitution4swigautodoc(return_annotation)
return_annotation = None
return signature, return_annotation
......@@ -515,7 +515,9 @@ def skip(app, what, name, obj, skip, options):
'__swig_destroy__', '_s', # swig members
'clone', # special gum members
)
exclude = name in exclusions
if exclude:
return True
if skip:
......@@ -526,7 +528,7 @@ autodoc_default_flags = ['members',
#'private-members', 'special-members',
'inherited-members',
#'undoc-members',
#'show-inheritance'
#'show-inheritance',
]
def setup(app):
app.connect('autodoc-process-docstring', process_docstring)
......
......@@ -11,4 +11,5 @@ Potential
.. autoclass:: pyAgrum.Potential
.. autoclass:: pyAgrum.pyAgrum.Potential_double
\ No newline at end of file
.. autoclass:: pyAgrum.pyAgrum.Potential_double
:exclude-members: populate
\ No newline at end of file
Problèmes de type dans les signatures
-------------------------------------
Problèmes de type dans les signatures générées
----------------------------------------------
gum::Idx -> int
gum::Size -> int
......@@ -10,16 +10,10 @@ Problèmes d'exceptions
RangeVar.setMinVal(new_minval) (resp. setMaxVal(new_maxval)) ne renvoie pas d'erreur si new_minval>maxval (resp. new_maxval<minval)
Problèmes avec doc de :
-----------------------
addLabel
addTick
%ignore gum::Potential::populate
%ignore gum::DAGmodel::property;
%ignore gum::DAGmodel::propertyWithDefault;
%ignore gum::DAGmodel::setProperty;
Potential.add devrait envoyer une erreur lorsqu'on y passe une DiscretizedVariable sans tick.
Utiliser un ignore, en plus de ne pas documenter la fonction, fait qu'elle n'est pas implémentée, ce qui pose problème dans les jeux de test
Nouvelles fonctions
-------------------
FillWith = populate ? Si oui il faut changer les tests.
Supprimer property et setProperty ?
\ No newline at end of file
- gum::LabelizedVariable::addTicks
- gum::DiscretizedVariable::addLabels
\ No newline at end of file
......@@ -11,12 +11,44 @@
%feature("shadow") gum::LabelizedVariable::addLabel(const std::string aLabel) %{
def addLabel(self,*args):
"""
Add a label with a new index (we assume that we will NEVER remove a label).
Parameters
----------
aLabel : str
the label to be added to the labelized variable
Returns
-------
pyAgrum.LabelizedVariable
the labelized variable
Warnings
--------
DuplicateElement raised is raised if the variable already contains the label
"""
$action(self,*args)
return self
%}
%feature("shadow") gum::DiscretizedVariable<double>::addTick(const double& aTick) %{
def addTick(self,*args):
"""
Parameters
----------
aTick : double
the Tick to be added
Returns
-------
pyAgrum.DiscretizedVariable
the discretized variable
Warnings
--------
DefaultInLabel raised if the Tick is already defined
"""
$action(self,*args)
return self
%}
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment