diff --git a/library/cadbiom/models/clause_constraints/mcl/CLUnfolder.py b/library/cadbiom/models/clause_constraints/mcl/CLUnfolder.py index 05004549ad403e7207e6f456ec150cc2d44aed66..7a35ecc08ff1515dbd607781f61cedcdce55bf33 100644 --- a/library/cadbiom/models/clause_constraints/mcl/CLUnfolder.py +++ b/library/cadbiom/models/clause_constraints/mcl/CLUnfolder.py @@ -221,7 +221,12 @@ class CLUnfolder(object): def __init__(self, dynamic_system, debug=False): """ :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: + :type debug: """ self.dynamic_system = dynamic_system # symbolic clause dynamic system @@ -379,15 +384,18 @@ class CLUnfolder(object): """Reset the unfolder before a new 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, - __variant_constraints and __dynamic_constraints ARE NOT reset here - (see init_forward_unfolding()) + `__initial_constraints`, `__final_constraints`, `__invariant_constraints`, + `__variant_constraints` and `__dynamic_constraints` ARE NOT reset here + (see :meth:`init_forward_unfolding`). This function is called from the constructor and during - MCLAnalyser.sq_is_satisfiable() and MCLAnalyser.sq_solutions() - following the call of init_with_query(). + :meth:`MCLAnalyser.sq_is_satisfiable() + ` + and :meth:`MCLAnalyser.sq_is_satisfiable() + ` + following the call of :meth:`init_with_query`. """ # Properties to be checked self.__initial_property = None # logical formula - literal boolean expression @@ -1222,7 +1230,7 @@ class CLUnfolder(object): .. note:: Compilation of properties in text format (logical formulas) 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 search with a clause with their negative values. default: True @@ -1458,8 +1466,7 @@ class CLUnfolder(object): self.__aux_list = [] # idem # Init properties to generate all variable num codes - ## Similar code with init_backward_unfolding, move this into a function - ## => could help to recall init state of a query + ## TODO: Similar code with init_backward_unfolding, move this into a function self.__init_initial_constraint_0() self.__init_final_constraint_0() self.__init_invariant_constraint_0()