Added some docs
[linpy.git] / pypol / tests / test_linexprs.py
index a3e81b0..1966b2a 100644 (file)
@@ -4,44 +4,29 @@ import unittest
 from fractions import Fraction
 
 from ..linexprs import *
 from fractions import Fraction
 
 from ..linexprs import *
-
-
-try:
-    import sympy
-    def _requires_sympy(func):
-        @functools.wraps(func)
-        def wrapper(self):
-            return func(self)
-        return wrapper
-except ImportError:
-    def _requires_sympy(func):
-        @functools.wraps(func)
-        def wrapper(self):
-            raise unittest.SkipTest('SymPy is not available')
-        return wrapper
+from .libhelper import requires_sympy
 
 
 class TestExpression(unittest.TestCase):
 
     def setUp(self):
 
 
 class TestExpression(unittest.TestCase):
 
     def setUp(self):
-        self.x = Expression({'x': 1})
-        self.y = Expression({'y': 1})
-        self.z = Expression({'z': 1})
+        self.x = Symbol('x')
+        self.y = Symbol('y')
+        self.z = Symbol('z')
         self.zero = Expression(constant=0)
         self.one = Expression(constant=1)
         self.pi = Expression(constant=Fraction(22, 7))
         self.expr = self.x - 2*self.y + 3
 
     def test_new(self):
         self.zero = Expression(constant=0)
         self.one = Expression(constant=1)
         self.pi = Expression(constant=Fraction(22, 7))
         self.expr = self.x - 2*self.y + 3
 
     def test_new(self):
-        self.assertIsInstance(self.x, Symbol)
-        self.assertIsInstance(self.pi, Constant)
+        self.assertIsInstance(Expression(coefficients={self.x: 1}), Symbol)
+        self.assertIsInstance(Expression(constant=self.pi), Rational)
         self.assertNotIsInstance(self.x + self.pi, Symbol)
         self.assertNotIsInstance(self.x + self.pi, Symbol)
-        self.assertNotIsInstance(self.x + self.pi, Constant)
-        xx = Expression({'x': 2})
+        self.assertNotIsInstance(self.x + self.pi, Rational)
+        xx = Expression({self.x: 2})
         self.assertNotIsInstance(xx, Symbol)
         with self.assertRaises(TypeError):
             Expression('x + y', 2)
         self.assertNotIsInstance(xx, Symbol)
         with self.assertRaises(TypeError):
             Expression('x + y', 2)
-        self.assertEqual(Expression({'x': 2}), Expression({self.x: 2}))
         with self.assertRaises(TypeError):
             Expression({0: 2})
         with self.assertRaises(TypeError):
         with self.assertRaises(TypeError):
             Expression({0: 2})
         with self.assertRaises(TypeError):
@@ -52,27 +37,29 @@ class TestExpression(unittest.TestCase):
             Expression(constant='a')
 
     def test_coefficient(self):
             Expression(constant='a')
 
     def test_coefficient(self):
-        self.assertEqual(self.expr.coefficient('x'), 1)
-        self.assertEqual(self.expr.coefficient('y'), -2)
+        self.assertEqual(self.expr.coefficient(self.x), 1)
         self.assertEqual(self.expr.coefficient(self.y), -2)
         self.assertEqual(self.expr.coefficient(self.y), -2)
-        self.assertEqual(self.expr.coefficient('z'), 0)
+        self.assertEqual(self.expr.coefficient(self.z), 0)
+        with self.assertRaises(TypeError):
+            self.expr.coefficients('x')
         with self.assertRaises(TypeError):
             self.expr.coefficient(0)
         with self.assertRaises(TypeError):
             self.expr.coefficient(self.expr)
 
     def test_getitem(self):
         with self.assertRaises(TypeError):
             self.expr.coefficient(0)
         with self.assertRaises(TypeError):
             self.expr.coefficient(self.expr)
 
     def test_getitem(self):
-        self.assertEqual(self.expr['x'], 1)
-        self.assertEqual(self.expr['y'], -2)
+        self.assertEqual(self.expr[self.x], 1)
         self.assertEqual(self.expr[self.y], -2)
         self.assertEqual(self.expr[self.y], -2)
-        self.assertEqual(self.expr['z'], 0)
+        self.assertEqual(self.expr[self.z], 0)
+        with self.assertRaises(TypeError):
+            self.assertEqual(self.expr['x'], 1)
         with self.assertRaises(TypeError):
             self.expr[0]
         with self.assertRaises(TypeError):
             self.expr[self.expr]
 
     def test_coefficients(self):
         with self.assertRaises(TypeError):
             self.expr[0]
         with self.assertRaises(TypeError):
             self.expr[self.expr]
 
     def test_coefficients(self):
-        self.assertCountEqual(self.expr.coefficients(), [('x', 1), ('y', -2)])
+        self.assertListEqual(list(self.expr.coefficients()), [(self.x, 1), (self.y, -2)])
 
     def test_constant(self):
         self.assertEqual(self.x.constant, 0)
 
     def test_constant(self):
         self.assertEqual(self.x.constant, 0)
@@ -80,9 +67,9 @@ class TestExpression(unittest.TestCase):
         self.assertEqual(self.expr.constant, 3)
 
     def test_symbols(self):
         self.assertEqual(self.expr.constant, 3)
 
     def test_symbols(self):
-        self.assertCountEqual(self.x.symbols, ['x'])
-        self.assertCountEqual(self.pi.symbols, [])
-        self.assertCountEqual(self.expr.symbols, ['x', 'y'])
+        self.assertTupleEqual(self.x.symbols, (self.x,))
+        self.assertTupleEqual(self.pi.symbols, ())
+        self.assertTupleEqual(self.expr.symbols, (self.x, self.y))
 
     def test_dimension(self):
         self.assertEqual(self.x.dimension, 1)
 
     def test_dimension(self):
         self.assertEqual(self.x.dimension, 1)
@@ -100,7 +87,7 @@ class TestExpression(unittest.TestCase):
         self.assertFalse(self.expr.issymbol())
 
     def test_values(self):
         self.assertFalse(self.expr.issymbol())
 
     def test_values(self):
-        self.assertCountEqual(self.expr.values(), [1, -2, 3])
+        self.assertListEqual(list(self.expr.values()), [1, -2, 3])
 
     def test_bool(self):
         self.assertTrue(self.x)
 
     def test_bool(self):
         self.assertTrue(self.x)
@@ -130,32 +117,44 @@ class TestExpression(unittest.TestCase):
         self.assertEqual(self.expr * 0, 0)
         self.assertEqual(0 * self.expr, 0)
         self.assertEqual(self.expr * 2, 2*self.x - 4*self.y + 6)
         self.assertEqual(self.expr * 0, 0)
         self.assertEqual(0 * self.expr, 0)
         self.assertEqual(self.expr * 2, 2*self.x - 4*self.y + 6)
+        with self.assertRaises(TypeError):
+            self.x * self.x
 
     def test_truediv(self):
         with self.assertRaises(ZeroDivisionError):
             self.expr / 0
         self.assertEqual(self.expr / 2, self.x / 2 - self.y + Fraction(3, 2))
 
     def test_truediv(self):
         with self.assertRaises(ZeroDivisionError):
             self.expr / 0
         self.assertEqual(self.expr / 2, self.x / 2 - self.y + Fraction(3, 2))
+        with self.assertRaises(TypeError):
+            self.x / self.x
 
     def test_eq(self):
         self.assertEqual(self.expr, self.expr)
         self.assertNotEqual(self.x, self.y)
         self.assertEqual(self.zero, 0)
 
 
     def test_eq(self):
         self.assertEqual(self.expr, self.expr)
         self.assertNotEqual(self.x, self.y)
         self.assertEqual(self.zero, 0)
 
-    def test__toint(self):
-        self.assertEqual((self.x + self.y/2 + self.z/3)._toint(),
+    def test_scaleint(self):
+        self.assertEqual((self.x + self.y/2 + self.z/3).scaleint(),
                 6*self.x + 3*self.y + 2*self.z)
 
     def test_subs(self):
                 6*self.x + 3*self.y + 2*self.z)
 
     def test_subs(self):
-        self.assertEqual(self.x.subs('x', 3), 3)
-        self.assertEqual(self.x.subs('x', self.x), self.x)
-        self.assertEqual(self.x.subs('x', self.y), self.y)
-        self.assertEqual(self.x.subs('x', self.x + self.y), self.x + self.y)
-        self.assertEqual(self.x.subs('y', 3), self.x)
-        self.assertEqual(self.pi.subs('x', 3), self.pi)
-        self.assertEqual(self.expr.subs('x', -3), -2 * self.y)
-        self.assertEqual(self.expr.subs([('x', self.y), ('y', self.x)]), 3 - self.x)
-        self.assertEqual(self.expr.subs({'x': self.y, 'y': self.x}), 3 - self.x)
-        self.assertEqual(self.expr.subs({self.x: self.z, self.y: self.z}), -self.z + 3)
+        self.assertEqual(self.x.subs(self.x, 3), 3)
+        self.assertEqual(self.x.subs(self.x, self.x), self.x)
+        self.assertEqual(self.x.subs(self.x, self.y), self.y)
+        self.assertEqual(self.x.subs(self.x, self.x + self.y), self.x + self.y)
+        self.assertEqual(self.x.subs(self.y, 3), self.x)
+        self.assertEqual(self.pi.subs(self.x, 3), self.pi)
+        self.assertEqual(self.expr.subs(self.x, -3), -2 * self.y)
+        self.assertEqual(self.expr.subs([(self.x, self.y), (self.y, self.x)]), 3 - self.x)
+        self.assertEqual(self.expr.subs({self.x: self.z, self.y: self.z}), 3 - self.z)
+        self.assertEqual(self.expr.subs({self.x: self.z, self.y: self.z}), 3 - self.z)
+        with self.assertRaises(TypeError):
+            self.x.subs('x', 3)
+        with self.assertRaises(TypeError):
+            self.expr.subs([('x', self.z), ('y', self.z)])
+        with self.assertRaises(TypeError):
+            self.expr.subs({'x': self.z, 'y': self.z})
+        with self.assertRaises(TypeError):
+            self.expr.subs(self.x, 'x')
 
     def test_fromstring(self):
         self.assertEqual(Expression.fromstring('x'), self.x)
 
     def test_fromstring(self):
         self.assertEqual(Expression.fromstring('x'), self.x)
@@ -165,22 +164,16 @@ class TestExpression(unittest.TestCase):
         self.assertEqual(Expression.fromstring('x - (3-1)y + 3'), self.expr)
         self.assertEqual(Expression.fromstring('x - 2*y + 3'), self.expr)
 
         self.assertEqual(Expression.fromstring('x - (3-1)y + 3'), self.expr)
         self.assertEqual(Expression.fromstring('x - 2*y + 3'), self.expr)
 
-    def test_str(self):
+    def test_repr(self):
         self.assertEqual(str(Expression()), '0')
         self.assertEqual(str(self.x), 'x')
         self.assertEqual(str(-self.x), '-x')
         self.assertEqual(str(self.pi), '22/7')
         self.assertEqual(str(self.expr), 'x - 2*y + 3')
 
         self.assertEqual(str(Expression()), '0')
         self.assertEqual(str(self.x), 'x')
         self.assertEqual(str(-self.x), '-x')
         self.assertEqual(str(self.pi), '22/7')
         self.assertEqual(str(self.expr), 'x - 2*y + 3')
 
-    def test_repr(self):
-        self.assertEqual(repr(self.x), "Symbol('x')")
-        self.assertEqual(repr(self.one), 'Constant(1)')
-        self.assertEqual(repr(self.pi), 'Constant(22, 7)')
-        self.assertEqual(repr(self.x + self.one), "Expression('x + 1')")
-        self.assertEqual(repr(self.expr), "Expression('x - 2*y + 3')")
-
-    @_requires_sympy
+    @requires_sympy
     def test_fromsympy(self):
     def test_fromsympy(self):
+        import sympy
         sp_x, sp_y = sympy.symbols('x y')
         self.assertEqual(Expression.fromsympy(sp_x), self.x)
         self.assertEqual(Expression.fromsympy(sympy.Rational(22, 7)), self.pi)
         sp_x, sp_y = sympy.symbols('x y')
         self.assertEqual(Expression.fromsympy(sp_x), self.x)
         self.assertEqual(Expression.fromsympy(sympy.Rational(22, 7)), self.pi)
@@ -188,8 +181,9 @@ class TestExpression(unittest.TestCase):
         with self.assertRaises(ValueError):
             Expression.fromsympy(sp_x*sp_y)
 
         with self.assertRaises(ValueError):
             Expression.fromsympy(sp_x*sp_y)
 
-    @_requires_sympy
+    @requires_sympy
     def test_tosympy(self):
     def test_tosympy(self):
+        import sympy
         sp_x, sp_y = sympy.symbols('x y')
         self.assertEqual(self.x.tosympy(), sp_x)
         self.assertEqual(self.pi.tosympy(), sympy.Rational(22, 7))
         sp_x, sp_y = sympy.symbols('x y')
         self.assertEqual(self.x.tosympy(), sp_x)
         self.assertEqual(self.pi.tosympy(), sympy.Rational(22, 7))
@@ -204,7 +198,8 @@ class TestSymbol(unittest.TestCase):
 
     def test_new(self):
         self.assertEqual(Symbol(' x '), self.x)
 
     def test_new(self):
         self.assertEqual(Symbol(' x '), self.x)
-        self.assertEqual(Symbol(self.x), self.x)
+        with self.assertRaises(TypeError):
+            Symbol(self.x)
         with self.assertRaises(TypeError):
             Symbol(1)
 
         with self.assertRaises(TypeError):
             Symbol(1)
 
@@ -219,14 +214,12 @@ class TestSymbol(unittest.TestCase):
         with self.assertRaises(SyntaxError):
             Symbol.fromstring('1')
 
         with self.assertRaises(SyntaxError):
             Symbol.fromstring('1')
 
-    def test_str(self):
-        self.assertEqual(str(self.x), 'x')
-
     def test_repr(self):
     def test_repr(self):
-        self.assertEqual(repr(self.x), "Symbol('x')")
+        self.assertEqual(str(self.x), 'x')
 
 
-    @_requires_sympy
+    @requires_sympy
     def test_fromsympy(self):
     def test_fromsympy(self):
+        import sympy
         sp_x = sympy.Symbol('x')
         self.assertEqual(Symbol.fromsympy(sp_x), self.x)
         with self.assertRaises(TypeError):
         sp_x = sympy.Symbol('x')
         self.assertEqual(Symbol.fromsympy(sp_x), self.x)
         with self.assertRaises(TypeError):
@@ -236,24 +229,63 @@ class TestSymbol(unittest.TestCase):
         with self.assertRaises(TypeError):
             Symbol.fromsympy(sp_x*sp_x)
 
         with self.assertRaises(TypeError):
             Symbol.fromsympy(sp_x*sp_x)
 
-    def test_symbols(self):
-        self.assertListEqual(list(symbols('x y')), [self.x, self.y])
-        self.assertListEqual(list(symbols('x,y')), [self.x, self.y])
-        self.assertListEqual(list(symbols(['x', 'y'])), [self.x, self.y])
+
+class TestDummy(unittest.TestCase):
+
+    def setUp(self):
+        self.x = Dummy('x')
+
+    def test_new(self):
+        self.assertEqual(self.x.name, 'x')
+        self.assertTrue(Dummy().name.startswith('Dummy'))
+
+    def test_eq(self):
+        self.assertEqual(self.x, self.x)
+        self.assertNotEqual(self.x, Symbol('x'))
+        self.assertNotEqual(Symbol('x'), self.x)
+        self.assertNotEqual(self.x, Dummy('x'))
+        self.assertNotEqual(Dummy(), Dummy())
+
+    def test_repr(self):
+        self.assertEqual(repr(self.x), '_x')
+        dummy1 = Dummy()
+        dummy2 = Dummy()
+        self.assertTrue(repr(dummy1).startswith('_Dummy_'))
+        self.assertNotEqual(repr(dummy1), repr(dummy2))
+
+
+class TestSymbols(unittest.TestCase):
+
+    def setUp(self):
+        self.x = Symbol('x')
+        self.y = Symbol('y')
+
+    def test(self):
+        self.assertTupleEqual(symbols('x y'), (self.x, self.y))
+        self.assertTupleEqual(symbols('x,y'), (self.x, self.y))
+        self.assertTupleEqual(symbols(['x', 'y']), (self.x, self.y))
+        with self.assertRaises(TypeError):
+            symbols(1)
+        with self.assertRaises(TypeError):
+            symbols(['a', 1])
 
 
 
 
-class TestConstant(unittest.TestCase):
+class TestRational(unittest.TestCase):
 
     def setUp(self):
 
     def setUp(self):
-        self.zero = Constant(0)
-        self.one = Constant(1)
-        self.pi = Constant(Fraction(22, 7))
+        self.zero = Rational(0)
+        self.one = Rational(1)
+        self.pi = Rational(22, 7)
 
     def test_new(self):
 
     def test_new(self):
-        self.assertEqual(Constant(), self.zero)
-        self.assertEqual(Constant(1), self.one)
-        self.assertEqual(Constant(self.pi), self.pi)
-        self.assertEqual(Constant('22/7'), self.pi)
+        self.assertEqual(Rational(), self.zero)
+        self.assertEqual(Rational(1), self.one)
+        self.assertEqual(Rational(self.pi), self.pi)
+        self.assertEqual(Rational('22/7'), self.pi)
+
+    def test_hash(self):
+        self.assertEqual(hash(self.one), hash(1))
+        self.assertEqual(hash(self.pi), hash(Fraction(22, 7)))
 
     def test_isconstant(self):
         self.assertTrue(self.zero.isconstant())
 
     def test_isconstant(self):
         self.assertTrue(self.zero.isconstant())
@@ -262,20 +294,14 @@ class TestConstant(unittest.TestCase):
         self.assertFalse(self.zero)
         self.assertTrue(self.pi)
 
         self.assertFalse(self.zero)
         self.assertTrue(self.pi)
 
-    def test_fromstring(self):
-        self.assertEqual(Constant.fromstring('22/7'), self.pi)
-        with self.assertRaises(ValueError):
-            Constant.fromstring('a')
-        with self.assertRaises(TypeError):
-            Constant.fromstring(1)
-
     def test_repr(self):
     def test_repr(self):
-        self.assertEqual(repr(self.zero), 'Constant(0)')
-        self.assertEqual(repr(self.one), 'Constant(1)')
-        self.assertEqual(repr(self.pi), 'Constant(22, 7)')
+        self.assertEqual(repr(self.zero), '0')
+        self.assertEqual(repr(self.one), '1')
+        self.assertEqual(repr(self.pi), '22/7')
 
 
-    @_requires_sympy
+    @requires_sympy
     def test_fromsympy(self):
     def test_fromsympy(self):
-        self.assertEqual(Constant.fromsympy(sympy.Rational(22, 7)), self.pi)
+        import sympy
+        self.assertEqual(Rational.fromsympy(sympy.Rational(22, 7)), self.pi)
         with self.assertRaises(TypeError):
         with self.assertRaises(TypeError):
-            Constant.fromsympy(sympy.Symbol('x'))
+            Rational.fromsympy(sympy.Symbol('x'))