Attention une mise à jour du service Gitlab va être effectuée le mardi 14 décembre entre 13h30 et 14h00. Cette mise à jour va générer une interruption du service dont nous ne maîtrisons pas complètement la durée mais qui ne devrait pas excéder quelques minutes.

Commit e87c5451 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

[lib] MCLSolutions: Fix doc; add module doc

parent 19e69b7b
...@@ -39,8 +39,19 @@ ...@@ -39,8 +39,19 @@
## ##
## Contributor(s): Geoffroy Andrieux - IRISA/IRSET ## Contributor(s): Geoffroy Andrieux - IRISA/IRSET
## ##
""" """Classes used to store solver answers.
Various solution representations
RawSolution:
Contain a solution got from SAT solver with all variable parameters
from the unfolder.
DimacsFrontierSol:
A numerical representation of *frontier values and timings* from a raw solution.
FrontierSolution:
Provides is a wrapper for a symbolic
representation (human readable) of activated frontiers defined in
RawSolution and DimacsFrontierSol objects.
""" """
# Standard imports # Standard imports
from __future__ import print_function from __future__ import print_function
...@@ -406,11 +417,11 @@ class RawSolution(object): ...@@ -406,11 +417,11 @@ class RawSolution(object):
class FrontierSolution(object): class FrontierSolution(object):
"""Class for symbolic frontier and timings representation (built from a raw solution) """Class for symbolic (human readable) frontiers and timings representation
The class FrontierSolution provides objects wrapping a symbolic The class FrontierSolution provides is a wrapper for a symbolic
representation (human readable) of activated frontiers for RawSolution and representation (human readable) of activated frontiers defined in
DimacsFrontierSol objects. RawSolution and DimacsFrontierSol objects.
Attributes: Attributes:
- The main attributes are activated_frontier which is a set of - The main attributes are activated_frontier which is a set of
...@@ -612,7 +623,7 @@ class FrontierSolution(object): ...@@ -612,7 +623,7 @@ class FrontierSolution(object):
class DimacsFrontierSol(object): class DimacsFrontierSol(object):
"""Class for solution frontier and timings representation """Class for solution frontier and timings representation
DimacsFrontierSol is a numeric representation of *frontier values and timings* DimacsFrontierSol is a numerical representation of *frontier values and timings*
from a raw solution. from a raw solution.
Attributes: Attributes:
......
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