Add warning in widening documentation
authorVivien Maisonneuve <v.maisonneuve@gmail.com>
Tue, 19 Aug 2014 13:26:43 +0000 (15:26 +0200)
committerVivien Maisonneuve <v.maisonneuve@gmail.com>
Tue, 19 Aug 2014 13:26:43 +0000 (15:26 +0200)
doc/reference.rst
linpy/polyhedra.py

index 4e71658..18e69c0 100644 (file)
@@ -282,6 +282,8 @@ This space can be unbounded.
 
         Compute the *standard widening* of two polyhedra, à la Halbwachs.
 
 
         Compute the *standard widening* of two polyhedra, à la Halbwachs.
 
+        In its current implementation, this method is slow and should not be used on large polyhedra.
+
 
 .. data:: Empty
 
 
 .. data:: Empty
 
index 8426d32..9fdf6e7 100644 (file)
@@ -173,6 +173,9 @@ class Polyhedron(Domain):
     def widen(self, other):
         """
         Compute the standard widening of two polyhedra, à la Halbwachs.
     def widen(self, other):
         """
         Compute the standard widening of two polyhedra, à la Halbwachs.
+
+        In its current implementation, this method is slow and should not be
+        used on large polyhedra.
         """
         if not isinstance(other, Polyhedron):
             raise ValueError('argument must be a Polyhedron instance')
         """
         if not isinstance(other, Polyhedron):
             raise ValueError('argument must be a Polyhedron instance')