Commit c7a6cb1b authored by VIGNET Pierre's avatar VIGNET Pierre

[lib] CLUnfolder: Fix typos

parent 4b04022f
...@@ -221,7 +221,12 @@ class CLUnfolder(object): ...@@ -221,7 +221,12 @@ class CLUnfolder(object):
def __init__(self, dynamic_system, debug=False): def __init__(self, dynamic_system, debug=False):
""" """
:param dynamic_system: Describe a dynamic system in clause form. :param dynamic_system: Describe a dynamic system in clause form.
:key debug: (Optional) Used to activate debug mode in the Unfolder.
i.e. `__var_list` attribute will be ordered, and initializations of
the unfolder will be reproductible.
Default: False.
:type dynamic_system: <CLDynSys> :type dynamic_system: <CLDynSys>
:type debug: <boolean>
""" """
self.dynamic_system = dynamic_system # symbolic clause dynamic system self.dynamic_system = dynamic_system # symbolic clause dynamic system
...@@ -379,15 +384,18 @@ class CLUnfolder(object): ...@@ -379,15 +384,18 @@ class CLUnfolder(object):
"""Reset the unfolder before a new query """Reset the unfolder before a new query
Reset only properties and dimacs clauses from the current query; Reset only properties and dimacs clauses from the current query;
AND __precomputed_variant_constraints. AND `__precomputed_variant_constraints`.
=> __initial_constraints, __final_constraints, __invariant_constraints, `__initial_constraints`, `__final_constraints`, `__invariant_constraints`,
__variant_constraints and __dynamic_constraints ARE NOT reset here `__variant_constraints` and `__dynamic_constraints` ARE NOT reset here
(see init_forward_unfolding()) (see :meth:`init_forward_unfolding`).
This function is called from the constructor and during This function is called from the constructor and during
MCLAnalyser.sq_is_satisfiable() and MCLAnalyser.sq_solutions() :meth:`MCLAnalyser.sq_is_satisfiable()
following the call of init_with_query(). <cadbiom.models.clause_constraints.mcl.MCLAnalyser.MCLAnalyser.sq_is_satisfiable>`
and :meth:`MCLAnalyser.sq_is_satisfiable()
<cadbiom.models.clause_constraints.mcl.MCLAnalyser.MCLAnalyser.sq_solutions>`
following the call of :meth:`init_with_query`.
""" """
# Properties to be checked # Properties to be checked
self.__initial_property = None # logical formula - literal boolean expression self.__initial_property = None # logical formula - literal boolean expression
...@@ -1222,7 +1230,7 @@ class CLUnfolder(object): ...@@ -1222,7 +1230,7 @@ class CLUnfolder(object):
.. note:: Compilation of properties in text format (logical formulas) .. note:: Compilation of properties in text format (logical formulas)
to numeric format is expensive when they must be parsed at each query. to numeric format is expensive when they must be parsed at each query.
:key no_frontier_init: (optional) boolean to force all variables of :key no_frontier_init: (Optional) Boolean to force all variables of
places/entities that are not frontiers to be disabled before each places/entities that are not frontiers to be disabled before each
search with a clause with their negative values. search with a clause with their negative values.
default: True default: True
...@@ -1458,8 +1466,7 @@ class CLUnfolder(object): ...@@ -1458,8 +1466,7 @@ class CLUnfolder(object):
self.__aux_list = [] # idem self.__aux_list = [] # idem
# Init properties to generate all variable num codes # Init properties to generate all variable num codes
## Similar code with init_backward_unfolding, move this into a function ## TODO: Similar code with init_backward_unfolding, move this into a function
## => could help to recall init state of a query
self.__init_initial_constraint_0() self.__init_initial_constraint_0()
self.__init_final_constraint_0() self.__init_final_constraint_0()
self.__init_invariant_constraint_0() self.__init_invariant_constraint_0()
......
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