Chris@87: from __future__ import division, absolute_import, print_function
Chris@87: 
Chris@87: from numpy.testing import *
Chris@87: from numpy.core import *
Chris@87: from numpy import matrix, asmatrix, bmat
Chris@87: from numpy.matrixlib.defmatrix import matrix_power
Chris@87: from numpy.matrixlib import mat
Chris@87: import numpy as np
Chris@87: import collections
Chris@87: 
Chris@87: class TestCtor(TestCase):
Chris@87:     def test_basic(self):
Chris@87:         A = array([[1, 2], [3, 4]])
Chris@87:         mA = matrix(A)
Chris@87:         assert_(all(mA.A == A))
Chris@87: 
Chris@87:         B = bmat("A,A;A,A")
Chris@87:         C = bmat([[A, A], [A, A]])
Chris@87:         D = array([[1, 2, 1, 2],
Chris@87:                    [3, 4, 3, 4],
Chris@87:                    [1, 2, 1, 2],
Chris@87:                    [3, 4, 3, 4]])
Chris@87:         assert_(all(B.A == D))
Chris@87:         assert_(all(C.A == D))
Chris@87: 
Chris@87:         E = array([[5, 6], [7, 8]])
Chris@87:         AEresult = matrix([[1, 2, 5, 6], [3, 4, 7, 8]])
Chris@87:         assert_(all(bmat([A, E]) == AEresult))
Chris@87: 
Chris@87:         vec = arange(5)
Chris@87:         mvec = matrix(vec)
Chris@87:         assert_(mvec.shape == (1, 5))
Chris@87: 
Chris@87:     def test_exceptions(self):
Chris@87:         # Check for TypeError when called with invalid string data.
Chris@87:         assert_raises(TypeError, matrix, "invalid")
Chris@87: 
Chris@87:     def test_bmat_nondefault_str(self):
Chris@87:         A = array([[1, 2], [3, 4]])
Chris@87:         B = array([[5, 6], [7, 8]])
Chris@87:         Aresult = array([[1, 2, 1, 2],
Chris@87:                          [3, 4, 3, 4],
Chris@87:                          [1, 2, 1, 2],
Chris@87:                          [3, 4, 3, 4]])
Chris@87:         Bresult = array([[5, 6, 5, 6],
Chris@87:                          [7, 8, 7, 8],
Chris@87:                          [5, 6, 5, 6],
Chris@87:                          [7, 8, 7, 8]])
Chris@87:         mixresult = array([[1, 2, 5, 6],
Chris@87:                            [3, 4, 7, 8],
Chris@87:                            [5, 6, 1, 2],
Chris@87:                            [7, 8, 3, 4]])
Chris@87:         assert_(all(bmat("A,A;A,A") == Aresult))
Chris@87:         assert_(all(bmat("A,A;A,A", ldict={'A':B}) == Aresult))
Chris@87:         assert_raises(TypeError, bmat, "A,A;A,A", gdict={'A':B})
Chris@87:         assert_(all(bmat("A,A;A,A", ldict={'A':A}, gdict={'A':B}) == Aresult))
Chris@87:         b2 = bmat("A,B;C,D", ldict={'A':A,'B':B}, gdict={'C':B,'D':A})
Chris@87:         assert_(all(b2 == mixresult))
Chris@87: 
Chris@87: 
Chris@87: class TestProperties(TestCase):
Chris@87:     def test_sum(self):
Chris@87:         """Test whether matrix.sum(axis=1) preserves orientation.
Chris@87:         Fails in NumPy <= 0.9.6.2127.
Chris@87:         """
Chris@87:         M = matrix([[1, 2, 0, 0],
Chris@87:                    [3, 4, 0, 0],
Chris@87:                    [1, 2, 1, 2],
Chris@87:                    [3, 4, 3, 4]])
Chris@87:         sum0 = matrix([8, 12, 4, 6])
Chris@87:         sum1 = matrix([3, 7, 6, 14]).T
Chris@87:         sumall = 30
Chris@87:         assert_array_equal(sum0, M.sum(axis=0))
Chris@87:         assert_array_equal(sum1, M.sum(axis=1))
Chris@87:         assert_equal(sumall, M.sum())
Chris@87: 
Chris@87:         assert_array_equal(sum0, np.sum(M, axis=0))
Chris@87:         assert_array_equal(sum1, np.sum(M, axis=1))
Chris@87:         assert_equal(sumall, np.sum(M))
Chris@87: 
Chris@87: 
Chris@87:     def test_prod(self):
Chris@87:         x = matrix([[1, 2, 3], [4, 5, 6]])
Chris@87:         assert_equal(x.prod(), 720)
Chris@87:         assert_equal(x.prod(0), matrix([[4, 10, 18]]))
Chris@87:         assert_equal(x.prod(1), matrix([[6], [120]]))
Chris@87: 
Chris@87:         assert_equal(np.prod(x), 720)
Chris@87:         assert_equal(np.prod(x, axis=0), matrix([[4, 10, 18]]))
Chris@87:         assert_equal(np.prod(x, axis=1), matrix([[6], [120]]))
Chris@87: 
Chris@87:         y = matrix([0, 1, 3])
Chris@87:         assert_(y.prod() == 0)
Chris@87: 
Chris@87:     def test_max(self):
Chris@87:         x = matrix([[1, 2, 3], [4, 5, 6]])
Chris@87:         assert_equal(x.max(), 6)
Chris@87:         assert_equal(x.max(0), matrix([[4, 5, 6]]))
Chris@87:         assert_equal(x.max(1), matrix([[3], [6]]))
Chris@87: 
Chris@87:         assert_equal(np.max(x), 6)
Chris@87:         assert_equal(np.max(x, axis=0), matrix([[4, 5, 6]]))
Chris@87:         assert_equal(np.max(x, axis=1), matrix([[3], [6]]))
Chris@87: 
Chris@87:     def test_min(self):
Chris@87:         x = matrix([[1, 2, 3], [4, 5, 6]])
Chris@87:         assert_equal(x.min(), 1)
Chris@87:         assert_equal(x.min(0), matrix([[1, 2, 3]]))
Chris@87:         assert_equal(x.min(1), matrix([[1], [4]]))
Chris@87: 
Chris@87:         assert_equal(np.min(x), 1)
Chris@87:         assert_equal(np.min(x, axis=0), matrix([[1, 2, 3]]))
Chris@87:         assert_equal(np.min(x, axis=1), matrix([[1], [4]]))
Chris@87: 
Chris@87:     def test_ptp(self):
Chris@87:         x = np.arange(4).reshape((2, 2))
Chris@87:         assert_(x.ptp() == 3)
Chris@87:         assert_(all(x.ptp(0) == array([2, 2])))
Chris@87:         assert_(all(x.ptp(1) == array([1, 1])))
Chris@87: 
Chris@87:     def test_var(self):
Chris@87:         x = np.arange(9).reshape((3, 3))
Chris@87:         mx = x.view(np.matrix)
Chris@87:         assert_equal(x.var(ddof=0), mx.var(ddof=0))
Chris@87:         assert_equal(x.var(ddof=1), mx.var(ddof=1))
Chris@87: 
Chris@87:     def test_basic(self):
Chris@87:         import numpy.linalg as linalg
Chris@87: 
Chris@87:         A = array([[1., 2.],
Chris@87:                    [3., 4.]])
Chris@87:         mA = matrix(A)
Chris@87:         assert_(allclose(linalg.inv(A), mA.I))
Chris@87:         assert_(all(array(transpose(A) == mA.T)))
Chris@87:         assert_(all(array(transpose(A) == mA.H)))
Chris@87:         assert_(all(A == mA.A))
Chris@87: 
Chris@87:         B = A + 2j*A
Chris@87:         mB = matrix(B)
Chris@87:         assert_(allclose(linalg.inv(B), mB.I))
Chris@87:         assert_(all(array(transpose(B) == mB.T)))
Chris@87:         assert_(all(array(conjugate(transpose(B)) == mB.H)))
Chris@87: 
Chris@87:     def test_pinv(self):
Chris@87:         x = matrix(arange(6).reshape(2, 3))
Chris@87:         xpinv = matrix([[-0.77777778,  0.27777778],
Chris@87:                         [-0.11111111,  0.11111111],
Chris@87:                         [ 0.55555556, -0.05555556]])
Chris@87:         assert_almost_equal(x.I, xpinv)
Chris@87: 
Chris@87:     def test_comparisons(self):
Chris@87:         A = arange(100).reshape(10, 10)
Chris@87:         mA = matrix(A)
Chris@87:         mB = matrix(A) + 0.1
Chris@87:         assert_(all(mB == A+0.1))
Chris@87:         assert_(all(mB == matrix(A+0.1)))
Chris@87:         assert_(not any(mB == matrix(A-0.1)))
Chris@87:         assert_(all(mA < mB))
Chris@87:         assert_(all(mA <= mB))
Chris@87:         assert_(all(mA <= mA))
Chris@87:         assert_(not any(mA < mA))
Chris@87: 
Chris@87:         assert_(not any(mB < mA))
Chris@87:         assert_(all(mB >= mA))
Chris@87:         assert_(all(mB >= mB))
Chris@87:         assert_(not any(mB > mB))
Chris@87: 
Chris@87:         assert_(all(mA == mA))
Chris@87:         assert_(not any(mA == mB))
Chris@87:         assert_(all(mB != mA))
Chris@87: 
Chris@87:         assert_(not all(abs(mA) > 0))
Chris@87:         assert_(all(abs(mB > 0)))
Chris@87: 
Chris@87:     def test_asmatrix(self):
Chris@87:         A = arange(100).reshape(10, 10)
Chris@87:         mA = asmatrix(A)
Chris@87:         A[0, 0] = -10
Chris@87:         assert_(A[0, 0] == mA[0, 0])
Chris@87: 
Chris@87:     def test_noaxis(self):
Chris@87:         A = matrix([[1, 0], [0, 1]])
Chris@87:         assert_(A.sum() == matrix(2))
Chris@87:         assert_(A.mean() == matrix(0.5))
Chris@87: 
Chris@87:     def test_repr(self):
Chris@87:         A = matrix([[1, 0], [0, 1]])
Chris@87:         assert_(repr(A) == "matrix([[1, 0],\n        [0, 1]])")
Chris@87: 
Chris@87: class TestCasting(TestCase):
Chris@87:     def test_basic(self):
Chris@87:         A = arange(100).reshape(10, 10)
Chris@87:         mA = matrix(A)
Chris@87: 
Chris@87:         mB = mA.copy()
Chris@87:         O = ones((10, 10), float64) * 0.1
Chris@87:         mB = mB + O
Chris@87:         assert_(mB.dtype.type == float64)
Chris@87:         assert_(all(mA != mB))
Chris@87:         assert_(all(mB == mA+0.1))
Chris@87: 
Chris@87:         mC = mA.copy()
Chris@87:         O = ones((10, 10), complex128)
Chris@87:         mC = mC * O
Chris@87:         assert_(mC.dtype.type == complex128)
Chris@87:         assert_(all(mA != mB))
Chris@87: 
Chris@87: 
Chris@87: class TestAlgebra(TestCase):
Chris@87:     def test_basic(self):
Chris@87:         import numpy.linalg as linalg
Chris@87: 
Chris@87:         A = array([[1., 2.],
Chris@87:                    [3., 4.]])
Chris@87:         mA = matrix(A)
Chris@87: 
Chris@87:         B = identity(2)
Chris@87:         for i in range(6):
Chris@87:             assert_(allclose((mA ** i).A, B))
Chris@87:             B = dot(B, A)
Chris@87: 
Chris@87:         Ainv = linalg.inv(A)
Chris@87:         B = identity(2)
Chris@87:         for i in range(6):
Chris@87:             assert_(allclose((mA ** -i).A, B))
Chris@87:             B = dot(B, Ainv)
Chris@87: 
Chris@87:         assert_(allclose((mA * mA).A, dot(A, A)))
Chris@87:         assert_(allclose((mA + mA).A, (A + A)))
Chris@87:         assert_(allclose((3*mA).A, (3*A)))
Chris@87: 
Chris@87:         mA2 = matrix(A)
Chris@87:         mA2 *= 3
Chris@87:         assert_(allclose(mA2.A, 3*A))
Chris@87: 
Chris@87:     def test_pow(self):
Chris@87:         """Test raising a matrix to an integer power works as expected."""
Chris@87:         m = matrix("1. 2.; 3. 4.")
Chris@87:         m2 = m.copy()
Chris@87:         m2 **= 2
Chris@87:         mi = m.copy()
Chris@87:         mi **= -1
Chris@87:         m4 = m2.copy()
Chris@87:         m4 **= 2
Chris@87:         assert_array_almost_equal(m2, m**2)
Chris@87:         assert_array_almost_equal(m4, np.dot(m2, m2))
Chris@87:         assert_array_almost_equal(np.dot(mi, m), np.eye(2))
Chris@87: 
Chris@87:     def test_notimplemented(self):
Chris@87:         '''Check that 'not implemented' operations produce a failure.'''
Chris@87:         A = matrix([[1., 2.],
Chris@87:                     [3., 4.]])
Chris@87: 
Chris@87:         # __rpow__
Chris@87:         try:
Chris@87:             1.0**A
Chris@87:         except TypeError:
Chris@87:             pass
Chris@87:         else:
Chris@87:             self.fail("matrix.__rpow__ doesn't raise a TypeError")
Chris@87: 
Chris@87:         # __mul__ with something not a list, ndarray, tuple, or scalar
Chris@87:         try:
Chris@87:             A*object()
Chris@87:         except TypeError:
Chris@87:             pass
Chris@87:         else:
Chris@87:             self.fail("matrix.__mul__ with non-numeric object doesn't raise"
Chris@87:                       "a TypeError")
Chris@87: 
Chris@87: class TestMatrixReturn(TestCase):
Chris@87:     def test_instance_methods(self):
Chris@87:         a = matrix([1.0], dtype='f8')
Chris@87:         methodargs = {
Chris@87:             'astype': ('intc',),
Chris@87:             'clip': (0.0, 1.0),
Chris@87:             'compress': ([1],),
Chris@87:             'repeat': (1,),
Chris@87:             'reshape': (1,),
Chris@87:             'swapaxes': (0, 0),
Chris@87:             'dot': np.array([1.0]),
Chris@87:             }
Chris@87:         excluded_methods = [
Chris@87:             'argmin', 'choose', 'dump', 'dumps', 'fill', 'getfield',
Chris@87:             'getA', 'getA1', 'item', 'nonzero', 'put', 'putmask', 'resize',
Chris@87:             'searchsorted', 'setflags', 'setfield', 'sort',
Chris@87:             'partition', 'argpartition',
Chris@87:             'take', 'tofile', 'tolist', 'tostring', 'tobytes', 'all', 'any',
Chris@87:             'sum', 'argmax', 'argmin', 'min', 'max', 'mean', 'var', 'ptp',
Chris@87:             'prod', 'std', 'ctypes', 'itemset', 'setasflat'
Chris@87:             ]
Chris@87:         for attrib in dir(a):
Chris@87:             if attrib.startswith('_') or attrib in excluded_methods:
Chris@87:                 continue
Chris@87:             f = getattr(a, attrib)
Chris@87:             if isinstance(f, collections.Callable):
Chris@87:                 # reset contents of a
Chris@87:                 a.astype('f8')
Chris@87:                 a.fill(1.0)
Chris@87:                 if attrib in methodargs:
Chris@87:                     args = methodargs[attrib]
Chris@87:                 else:
Chris@87:                     args = ()
Chris@87:                 b = f(*args)
Chris@87:                 assert_(type(b) is matrix, "%s" % attrib)
Chris@87:         assert_(type(a.real) is matrix)
Chris@87:         assert_(type(a.imag) is matrix)
Chris@87:         c, d = matrix([0.0]).nonzero()
Chris@87:         assert_(type(c) is matrix)
Chris@87:         assert_(type(d) is matrix)
Chris@87: 
Chris@87: 
Chris@87: class TestIndexing(TestCase):
Chris@87:     def test_basic(self):
Chris@87:         x = asmatrix(zeros((3, 2), float))
Chris@87:         y = zeros((3, 1), float)
Chris@87:         y[:, 0] = [0.8, 0.2, 0.3]
Chris@87:         x[:, 1] = y>0.5
Chris@87:         assert_equal(x, [[0, 1], [0, 0], [0, 0]])
Chris@87: 
Chris@87: 
Chris@87: class TestNewScalarIndexing(TestCase):
Chris@87:     def setUp(self):
Chris@87:         self.a = matrix([[1, 2], [3, 4]])
Chris@87: 
Chris@87:     def test_dimesions(self):
Chris@87:         a = self.a
Chris@87:         x = a[0]
Chris@87:         assert_equal(x.ndim, 2)
Chris@87: 
Chris@87:     def test_array_from_matrix_list(self):
Chris@87:         a = self.a
Chris@87:         x = array([a, a])
Chris@87:         assert_equal(x.shape, [2, 2, 2])
Chris@87: 
Chris@87:     def test_array_to_list(self):
Chris@87:         a = self.a
Chris@87:         assert_equal(a.tolist(), [[1, 2], [3, 4]])
Chris@87: 
Chris@87:     def test_fancy_indexing(self):
Chris@87:         a = self.a
Chris@87:         x = a[1, [0, 1, 0]]
Chris@87:         assert_(isinstance(x, matrix))
Chris@87:         assert_equal(x, matrix([[3,  4,  3]]))
Chris@87:         x = a[[1, 0]]
Chris@87:         assert_(isinstance(x, matrix))
Chris@87:         assert_equal(x, matrix([[3,  4], [1, 2]]))
Chris@87:         x = a[[[1], [0]], [[1, 0], [0, 1]]]
Chris@87:         assert_(isinstance(x, matrix))
Chris@87:         assert_equal(x, matrix([[4,  3], [1,  2]]))
Chris@87: 
Chris@87:     def test_matrix_element(self):
Chris@87:         x = matrix([[1, 2, 3], [4, 5, 6]])
Chris@87:         assert_equal(x[0][0], matrix([[1, 2, 3]]))
Chris@87:         assert_equal(x[0][0].shape, (1, 3))
Chris@87:         assert_equal(x[0].shape, (1, 3))
Chris@87:         assert_equal(x[:, 0].shape, (2, 1))
Chris@87: 
Chris@87:         x = matrix(0)
Chris@87:         assert_equal(x[0, 0], 0)
Chris@87:         assert_equal(x[0], 0)
Chris@87:         assert_equal(x[:, 0].shape, x.shape)
Chris@87: 
Chris@87:     def test_scalar_indexing(self):
Chris@87:         x = asmatrix(zeros((3, 2), float))
Chris@87:         assert_equal(x[0, 0], x[0][0])
Chris@87: 
Chris@87:     def test_row_column_indexing(self):
Chris@87:         x = asmatrix(np.eye(2))
Chris@87:         assert_array_equal(x[0,:], [[1, 0]])
Chris@87:         assert_array_equal(x[1,:], [[0, 1]])
Chris@87:         assert_array_equal(x[:, 0], [[1], [0]])
Chris@87:         assert_array_equal(x[:, 1], [[0], [1]])
Chris@87: 
Chris@87:     def test_boolean_indexing(self):
Chris@87:         A = arange(6)
Chris@87:         A.shape = (3, 2)
Chris@87:         x = asmatrix(A)
Chris@87:         assert_array_equal(x[:, array([True, False])], x[:, 0])
Chris@87:         assert_array_equal(x[array([True, False, False]),:], x[0,:])
Chris@87: 
Chris@87:     def test_list_indexing(self):
Chris@87:         A = arange(6)
Chris@87:         A.shape = (3, 2)
Chris@87:         x = asmatrix(A)
Chris@87:         assert_array_equal(x[:, [1, 0]], x[:, ::-1])
Chris@87:         assert_array_equal(x[[2, 1, 0],:], x[::-1,:])
Chris@87: 
Chris@87: class TestPower(TestCase):
Chris@87:     def test_returntype(self):
Chris@87:         a = array([[0, 1], [0, 0]])
Chris@87:         assert_(type(matrix_power(a, 2)) is ndarray)
Chris@87:         a = mat(a)
Chris@87:         assert_(type(matrix_power(a, 2)) is matrix)
Chris@87: 
Chris@87:     def test_list(self):
Chris@87:         assert_array_equal(matrix_power([[0, 1], [0, 0]], 2), [[0, 0], [0, 0]])
Chris@87: 
Chris@87: if __name__ == "__main__":
Chris@87:     run_module_suite()