test_eigen.py 27.4 KB
Newer Older
1
# -*- coding: utf-8 -*-
Dean Moldovan's avatar
Dean Moldovan committed
2
import pytest
3
from pybind11_tests import ConstructorStats
Dean Moldovan's avatar
Dean Moldovan committed
4

5
6
pytestmark = pytest.requires_eigen_and_numpy

Dean Moldovan's avatar
Dean Moldovan committed
7
with pytest.suppress(ImportError):
8
    from pybind11_tests import eigen as m
Dean Moldovan's avatar
Dean Moldovan committed
9
10
    import numpy as np

11
    ref = np.array([[ 0.,  3,  0,  0,  0, 11],
12
13
14
15
                    [22,  0,  0,  0, 17, 11],
                    [ 7,  5,  0,  1,  0, 11],
                    [ 0,  0,  0,  0,  0, 11],
                    [ 0,  0, 14,  0,  8, 11]])
Dean Moldovan's avatar
Dean Moldovan committed
16
17
18
19
20
21
22


def assert_equal_ref(mat):
    np.testing.assert_array_equal(mat, ref)


def assert_sparse_equal_ref(sparse_mat):
23
    assert_equal_ref(sparse_mat.toarray())
Dean Moldovan's avatar
Dean Moldovan committed
24
25
26


def test_fixed():
27
28
29
30
31
32
    assert_equal_ref(m.fixed_c())
    assert_equal_ref(m.fixed_r())
    assert_equal_ref(m.fixed_copy_r(m.fixed_r()))
    assert_equal_ref(m.fixed_copy_c(m.fixed_c()))
    assert_equal_ref(m.fixed_copy_r(m.fixed_c()))
    assert_equal_ref(m.fixed_copy_c(m.fixed_r()))
Dean Moldovan's avatar
Dean Moldovan committed
33
34
35


def test_dense():
36
37
38
39
40
41
    assert_equal_ref(m.dense_r())
    assert_equal_ref(m.dense_c())
    assert_equal_ref(m.dense_copy_r(m.dense_r()))
    assert_equal_ref(m.dense_copy_c(m.dense_c()))
    assert_equal_ref(m.dense_copy_r(m.dense_c()))
    assert_equal_ref(m.dense_copy_c(m.dense_r()))
42

Dean Moldovan's avatar
Dean Moldovan committed
43

44
def test_partially_fixed():
45
    ref2 = np.array([[0., 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11], [12, 13, 14, 15]])
46
47
48
49
50
    np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2), ref2)
    np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2), ref2)
    np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, 1]), ref2[:, [1]])
    np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2[0, :]), ref2[[0], :])
    np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)])
51
    np.testing.assert_array_equal(
52
        m.partial_copy_four_rm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :])
53

54
55
56
57
58
    np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2), ref2)
    np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2), ref2)
    np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, 1]), ref2[:, [1]])
    np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2[0, :]), ref2[[0], :])
    np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)])
59
    np.testing.assert_array_equal(
60
        m.partial_copy_four_cm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :])
61

62
    # TypeError should be raise for a shape mismatch
63
64
    functions = [m.partial_copy_four_rm_r, m.partial_copy_four_rm_c,
                 m.partial_copy_four_cm_r, m.partial_copy_four_cm_c]
65
66
67
68
69
70
71
    matrix_with_wrong_shape = [[1, 2],
                               [3, 4]]
    for f in functions:
        with pytest.raises(TypeError) as excinfo:
            f(matrix_with_wrong_shape)
        assert "incompatible function arguments" in str(excinfo.value)

72
73
74
75
76

def test_mutator_descriptors():
    zr = np.arange(30, dtype='float32').reshape(5, 6)  # row-major
    zc = zr.reshape(6, 5).transpose()  # column-major

77
78
79
80
    m.fixed_mutator_r(zr)
    m.fixed_mutator_c(zc)
    m.fixed_mutator_a(zr)
    m.fixed_mutator_a(zc)
81
    with pytest.raises(TypeError) as excinfo:
82
        m.fixed_mutator_r(zc)
83
84
    assert ('(arg0: numpy.ndarray[numpy.float32[5, 6],'
            ' flags.writeable, flags.c_contiguous]) -> None'
85
86
            in str(excinfo.value))
    with pytest.raises(TypeError) as excinfo:
87
        m.fixed_mutator_c(zr)
88
89
    assert ('(arg0: numpy.ndarray[numpy.float32[5, 6],'
            ' flags.writeable, flags.f_contiguous]) -> None'
90
91
            in str(excinfo.value))
    with pytest.raises(TypeError) as excinfo:
92
        m.fixed_mutator_a(np.array([[1, 2], [3, 4]], dtype='float32'))
93
    assert ('(arg0: numpy.ndarray[numpy.float32[5, 6], flags.writeable]) -> None'
94
95
96
            in str(excinfo.value))
    zr.flags.writeable = False
    with pytest.raises(TypeError):
97
        m.fixed_mutator_r(zr)
98
    with pytest.raises(TypeError):
99
        m.fixed_mutator_a(zr)
100

101

102
def test_cpp_casting():
103
104
    assert m.cpp_copy(m.fixed_r()) == 22.
    assert m.cpp_copy(m.fixed_c()) == 22.
105
    z = np.array([[5., 6], [7, 8]])
106
107
108
109
110
    assert m.cpp_copy(z) == 7.
    assert m.cpp_copy(m.get_cm_ref()) == 21.
    assert m.cpp_copy(m.get_rm_ref()) == 21.
    assert m.cpp_ref_c(m.get_cm_ref()) == 21.
    assert m.cpp_ref_r(m.get_rm_ref()) == 21.
111
    with pytest.raises(RuntimeError) as excinfo:
112
113
        # Can't reference m.fixed_c: it contains floats, m.cpp_ref_any wants doubles
        m.cpp_ref_any(m.fixed_c())
114
115
    assert 'Unable to cast Python instance' in str(excinfo.value)
    with pytest.raises(RuntimeError) as excinfo:
116
117
        # Can't reference m.fixed_r: it contains floats, m.cpp_ref_any wants doubles
        m.cpp_ref_any(m.fixed_r())
118
    assert 'Unable to cast Python instance' in str(excinfo.value)
119
    assert m.cpp_ref_any(m.ReturnTester.create()) == 1.
120

121
122
    assert m.cpp_ref_any(m.get_cm_ref()) == 21.
    assert m.cpp_ref_any(m.get_cm_ref()) == 21.
123
124
125
126
127


def test_pass_readonly_array():
    z = np.full((5, 6), 42.0)
    z.flags.writeable = False
128
129
130
131
    np.testing.assert_array_equal(z, m.fixed_copy_r(z))
    np.testing.assert_array_equal(m.fixed_r_const(), m.fixed_r())
    assert not m.fixed_r_const().flags.writeable
    np.testing.assert_array_equal(m.fixed_copy_r(m.fixed_r_const()), m.fixed_r_const())
132

Dean Moldovan's avatar
Dean Moldovan committed
133
134
135

def test_nonunit_stride_from_python():
    counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3))
136
137
    second_row = counting_mat[1, :]
    second_col = counting_mat[:, 1]
138
139
140
141
142
143
    np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col)
    np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col)
    np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col)
Dean Moldovan's avatar
Dean Moldovan committed
144
145
146

    counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3))
    slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]]
147
    for ref_mat in slices:
148
149
        np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat)
        np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat)
Dean Moldovan's avatar
Dean Moldovan committed
150

151
    # Mutator:
152
153
    m.double_threer(second_row)
    m.double_threec(second_col)
154
155
    np.testing.assert_array_equal(counting_mat, [[0., 2, 2], [6, 16, 10], [6, 14, 8]])

Dean Moldovan's avatar
Dean Moldovan committed
156

157
def test_negative_stride_from_python(msg):
158
159
160
    """Eigen doesn't support (as of yet) negative strides. When a function takes an Eigen matrix by
    copy or const reference, we can pass a numpy array that has negative strides.  Otherwise, an
    exception will be thrown as Eigen will not be able to map the numpy array."""
161
162
163
164
165

    counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3))
    counting_mat = counting_mat[::-1, ::-1]
    second_row = counting_mat[1, :]
    second_col = counting_mat[:, 1]
166
167
168
169
170
171
    np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row)
    np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col)
    np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col)
    np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col)
172
173
174
175

    counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3))
    counting_3d = counting_3d[::-1, ::-1, ::-1]
    slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]]
176
    for ref_mat in slices:
177
178
        np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat)
        np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat)
179
180
181

    # Mutator:
    with pytest.raises(TypeError) as excinfo:
182
        m.double_threer(second_row)
183
    assert msg(excinfo.value) == """
184
        double_threer(): incompatible function arguments. The following argument types are supported:
185
            1. (arg0: numpy.ndarray[numpy.float32[1, 3], flags.writeable]) -> None
186

187
        Invoked with: """ + repr(np.array([ 5.,  4.,  3.], dtype='float32'))  # noqa: E501 line too long
188
189

    with pytest.raises(TypeError) as excinfo:
190
        m.double_threec(second_col)
191
    assert msg(excinfo.value) == """
192
        double_threec(): incompatible function arguments. The following argument types are supported:
193
            1. (arg0: numpy.ndarray[numpy.float32[3, 1], flags.writeable]) -> None
194

195
        Invoked with: """ + repr(np.array([ 7.,  4.,  1.], dtype='float32'))  # noqa: E501 line too long
196
197


Dean Moldovan's avatar
Dean Moldovan committed
198
def test_nonunit_stride_to_python():
199
200
    assert np.all(m.diagonal(ref) == ref.diagonal())
    assert np.all(m.diagonal_1(ref) == ref.diagonal(1))
Dean Moldovan's avatar
Dean Moldovan committed
201
    for i in range(-5, 7):
202
        assert np.all(m.diagonal_n(ref, i) == ref.diagonal(i)), "m.diagonal_n({})".format(i)
Dean Moldovan's avatar
Dean Moldovan committed
203

204
205
206
    assert np.all(m.block(ref, 2, 1, 3, 3) == ref[2:5, 1:4])
    assert np.all(m.block(ref, 1, 4, 4, 2) == ref[1:, 4:])
    assert np.all(m.block(ref, 1, 4, 3, 2) == ref[1:4, 4:])
Dean Moldovan's avatar
Dean Moldovan committed
207
208
209


def test_eigen_ref_to_python():
210
    chols = [m.cholesky1, m.cholesky2, m.cholesky3, m.cholesky4]
Dean Moldovan's avatar
Dean Moldovan committed
211
    for i, chol in enumerate(chols, start=1):
212
        mymat = chol(np.array([[1., 2, 4], [2, 13, 23], [4, 23, 77]]))
Dean Moldovan's avatar
Dean Moldovan committed
213
214
215
        assert np.all(mymat == np.array([[1, 0, 0], [2, 3, 0], [4, 5, 6]])), "cholesky{}".format(i)


216
217
218
219
220
221
222
223
224
225
226
227
228
def assign_both(a1, a2, r, c, v):
    a1[r, c] = v
    a2[r, c] = v


def array_copy_but_one(a, r, c, v):
    z = np.array(a, copy=True)
    z[r, c] = v
    return z


def test_eigen_return_references():
    """Tests various ways of returning references and non-referencing copies"""
229

230
    master = np.ones((10, 10))
231
    a = m.ReturnTester()
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
    a_get1 = a.get()
    assert not a_get1.flags.owndata and a_get1.flags.writeable
    assign_both(a_get1, master, 3, 3, 5)
    a_get2 = a.get_ptr()
    assert not a_get2.flags.owndata and a_get2.flags.writeable
    assign_both(a_get1, master, 2, 3, 6)

    a_view1 = a.view()
    assert not a_view1.flags.owndata and not a_view1.flags.writeable
    with pytest.raises(ValueError):
        a_view1[2, 3] = 4
    a_view2 = a.view_ptr()
    assert not a_view2.flags.owndata and not a_view2.flags.writeable
    with pytest.raises(ValueError):
        a_view2[2, 3] = 4

    a_copy1 = a.copy_get()
    assert a_copy1.flags.owndata and a_copy1.flags.writeable
    np.testing.assert_array_equal(a_copy1, master)
    a_copy1[7, 7] = -44  # Shouldn't affect anything else
    c1want = array_copy_but_one(master, 7, 7, -44)
    a_copy2 = a.copy_view()
    assert a_copy2.flags.owndata and a_copy2.flags.writeable
    np.testing.assert_array_equal(a_copy2, master)
    a_copy2[4, 4] = -22  # Shouldn't affect anything else
    c2want = array_copy_but_one(master, 4, 4, -22)

    a_ref1 = a.ref()
    assert not a_ref1.flags.owndata and a_ref1.flags.writeable
    assign_both(a_ref1, master, 1, 1, 15)
    a_ref2 = a.ref_const()
    assert not a_ref2.flags.owndata and not a_ref2.flags.writeable
    with pytest.raises(ValueError):
        a_ref2[5, 5] = 33
    a_ref3 = a.ref_safe()
    assert not a_ref3.flags.owndata and a_ref3.flags.writeable
    assign_both(a_ref3, master, 0, 7, 99)
    a_ref4 = a.ref_const_safe()
    assert not a_ref4.flags.owndata and not a_ref4.flags.writeable
    with pytest.raises(ValueError):
        a_ref4[7, 0] = 987654321

    a_copy3 = a.copy_ref()
    assert a_copy3.flags.owndata and a_copy3.flags.writeable
    np.testing.assert_array_equal(a_copy3, master)
    a_copy3[8, 1] = 11
    c3want = array_copy_but_one(master, 8, 1, 11)
    a_copy4 = a.copy_ref_const()
    assert a_copy4.flags.owndata and a_copy4.flags.writeable
    np.testing.assert_array_equal(a_copy4, master)
    a_copy4[8, 4] = 88
    c4want = array_copy_but_one(master, 8, 4, 88)

    a_block1 = a.block(3, 3, 2, 2)
    assert not a_block1.flags.owndata and a_block1.flags.writeable
    a_block1[0, 0] = 55
    master[3, 3] = 55
    a_block2 = a.block_safe(2, 2, 3, 2)
    assert not a_block2.flags.owndata and a_block2.flags.writeable
    a_block2[2, 1] = -123
    master[4, 3] = -123
    a_block3 = a.block_const(6, 7, 4, 3)
    assert not a_block3.flags.owndata and not a_block3.flags.writeable
    with pytest.raises(ValueError):
        a_block3[2, 2] = -44444

    a_copy5 = a.copy_block(2, 2, 2, 3)
    assert a_copy5.flags.owndata and a_copy5.flags.writeable
    np.testing.assert_array_equal(a_copy5, master[2:4, 2:5])
    a_copy5[1, 1] = 777
    c5want = array_copy_but_one(master[2:4, 2:5], 1, 1, 777)

    a_corn1 = a.corners()
    assert not a_corn1.flags.owndata and a_corn1.flags.writeable
    a_corn1 *= 50
    a_corn1[1, 1] = 999
    master[0, 0] = 50
    master[0, 9] = 50
    master[9, 0] = 50
    master[9, 9] = 999
    a_corn2 = a.corners_const()
    assert not a_corn2.flags.owndata and not a_corn2.flags.writeable
    with pytest.raises(ValueError):
        a_corn2[1, 0] = 51

    # All of the changes made all the way along should be visible everywhere
    # now (except for the copies, of course)
    np.testing.assert_array_equal(a_get1, master)
    np.testing.assert_array_equal(a_get2, master)
    np.testing.assert_array_equal(a_view1, master)
    np.testing.assert_array_equal(a_view2, master)
    np.testing.assert_array_equal(a_ref1, master)
    np.testing.assert_array_equal(a_ref2, master)
    np.testing.assert_array_equal(a_ref3, master)
    np.testing.assert_array_equal(a_ref4, master)
    np.testing.assert_array_equal(a_block1, master[3:5, 3:5])
    np.testing.assert_array_equal(a_block2, master[2:5, 2:4])
    np.testing.assert_array_equal(a_block3, master[6:10, 7:10])
    np.testing.assert_array_equal(a_corn1, master[0::master.shape[0] - 1, 0::master.shape[1] - 1])
    np.testing.assert_array_equal(a_corn2, master[0::master.shape[0] - 1, 0::master.shape[1] - 1])

    np.testing.assert_array_equal(a_copy1, c1want)
    np.testing.assert_array_equal(a_copy2, c2want)
    np.testing.assert_array_equal(a_copy3, c3want)
    np.testing.assert_array_equal(a_copy4, c4want)
    np.testing.assert_array_equal(a_copy5, c5want)


def assert_keeps_alive(cl, method, *args):
    cstats = ConstructorStats.get(cl)
    start_with = cstats.alive()
    a = cl()
    assert cstats.alive() == start_with + 1
    z = method(a, *args)
    assert cstats.alive() == start_with + 1
    del a
    # Here's the keep alive in action:
    assert cstats.alive() == start_with + 1
    del z
    # Keep alive should have expired:
    assert cstats.alive() == start_with


def test_eigen_keepalive():
356
357
    a = m.ReturnTester()
    cstats = ConstructorStats.get(m.ReturnTester)
358
359
360
361
362
363
364
365
366
    assert cstats.alive() == 1
    unsafe = [a.ref(), a.ref_const(), a.block(1, 2, 3, 4)]
    copies = [a.copy_get(), a.copy_view(), a.copy_ref(), a.copy_ref_const(),
              a.copy_block(4, 3, 2, 1)]
    del a
    assert cstats.alive() == 0
    del unsafe
    del copies

367
368
369
370
    for meth in [m.ReturnTester.get, m.ReturnTester.get_ptr, m.ReturnTester.view,
                 m.ReturnTester.view_ptr, m.ReturnTester.ref_safe, m.ReturnTester.ref_const_safe,
                 m.ReturnTester.corners, m.ReturnTester.corners_const]:
        assert_keeps_alive(m.ReturnTester, meth)
371

372
373
    for meth in [m.ReturnTester.block_safe, m.ReturnTester.block_const]:
        assert_keeps_alive(m.ReturnTester, meth, 4, 3, 2, 1)
374
375
376


def test_eigen_ref_mutators():
377
378
    """Tests Eigen's ability to mutate numpy values"""

379
380
381
    orig = np.array([[1., 2, 3], [4, 5, 6], [7, 8, 9]])
    zr = np.array(orig)
    zc = np.array(orig, order='F')
382
    m.add_rm(zr, 1, 0, 100)
383
    assert np.all(zr == np.array([[1., 2, 3], [104, 5, 6], [7, 8, 9]]))
384
    m.add_cm(zc, 1, 0, 200)
385
386
    assert np.all(zc == np.array([[1., 2, 3], [204, 5, 6], [7, 8, 9]]))

387
    m.add_any(zr, 1, 0, 20)
388
    assert np.all(zr == np.array([[1., 2, 3], [124, 5, 6], [7, 8, 9]]))
389
    m.add_any(zc, 1, 0, 10)
390
391
392
393
    assert np.all(zc == np.array([[1., 2, 3], [214, 5, 6], [7, 8, 9]]))

    # Can't reference a col-major array with a row-major Ref, and vice versa:
    with pytest.raises(TypeError):
394
        m.add_rm(zc, 1, 0, 1)
395
    with pytest.raises(TypeError):
396
        m.add_cm(zr, 1, 0, 1)
397
398

    # Overloads:
399
400
    m.add1(zr, 1, 0, -100)
    m.add2(zr, 1, 0, -20)
401
    assert np.all(zr == orig)
402
403
    m.add1(zc, 1, 0, -200)
    m.add2(zc, 1, 0, -10)
404
405
406
407
408
409
410
411
412
413
414
    assert np.all(zc == orig)

    # a non-contiguous slice (this won't work on either the row- or
    # column-contiguous refs, but should work for the any)
    cornersr = zr[0::2, 0::2]
    cornersc = zc[0::2, 0::2]

    assert np.all(cornersr == np.array([[1., 3], [7, 9]]))
    assert np.all(cornersc == np.array([[1., 3], [7, 9]]))

    with pytest.raises(TypeError):
415
        m.add_rm(cornersr, 0, 1, 25)
416
    with pytest.raises(TypeError):
417
        m.add_cm(cornersr, 0, 1, 25)
418
    with pytest.raises(TypeError):
419
        m.add_rm(cornersc, 0, 1, 25)
420
    with pytest.raises(TypeError):
421
422
423
        m.add_cm(cornersc, 0, 1, 25)
    m.add_any(cornersr, 0, 1, 25)
    m.add_any(cornersc, 0, 1, 44)
424
425
426
427
428
429
430
    assert np.all(zr == np.array([[1., 2, 28], [4, 5, 6], [7, 8, 9]]))
    assert np.all(zc == np.array([[1., 2, 47], [4, 5, 6], [7, 8, 9]]))

    # You shouldn't be allowed to pass a non-writeable array to a mutating Eigen method:
    zro = zr[0:4, 0:4]
    zro.flags.writeable = False
    with pytest.raises(TypeError):
431
        m.add_rm(zro, 0, 0, 0)
432
    with pytest.raises(TypeError):
433
        m.add_any(zro, 0, 0, 0)
434
    with pytest.raises(TypeError):
435
        m.add1(zro, 0, 0, 0)
436
    with pytest.raises(TypeError):
437
        m.add2(zro, 0, 0, 0)
438
439
440
441

    # integer array shouldn't be passable to a double-matrix-accepting mutating func:
    zi = np.array([[1, 2], [3, 4]])
    with pytest.raises(TypeError):
442
        m.add_rm(zi)
443
444
445
446
447


def test_numpy_ref_mutators():
    """Tests numpy mutating Eigen matrices (for returned Eigen::Ref<...>s)"""

448
449
450
451
452
453
    m.reset_refs()  # In case another test already changed it

    zc = m.get_cm_ref()
    zcro = m.get_cm_const_ref()
    zr = m.get_rm_ref()
    zrro = m.get_rm_const_ref()
454
455
456
457
458
459
460
461
462
463
464
465
466

    assert [zc[1, 2], zcro[1, 2], zr[1, 2], zrro[1, 2]] == [23] * 4

    assert not zc.flags.owndata and zc.flags.writeable
    assert not zr.flags.owndata and zr.flags.writeable
    assert not zcro.flags.owndata and not zcro.flags.writeable
    assert not zrro.flags.owndata and not zrro.flags.writeable

    zc[1, 2] = 99
    expect = np.array([[11., 12, 13], [21, 22, 99], [31, 32, 33]])
    # We should have just changed zc, of course, but also zcro and the original eigen matrix
    assert np.all(zc == expect)
    assert np.all(zcro == expect)
467
    assert np.all(m.get_cm_ref() == expect)
468
469
470
471

    zr[1, 2] = 99
    assert np.all(zr == expect)
    assert np.all(zrro == expect)
472
    assert np.all(m.get_rm_ref() == expect)
473
474
475
476
477
478
479
480
481

    # Make sure the readonly ones are numpy-readonly:
    with pytest.raises(ValueError):
        zcro[1, 2] = 6
    with pytest.raises(ValueError):
        zrro[1, 2] = 6

    # We should be able to explicitly copy like this (and since we're copying,
    # the const should drop away)
482
    y1 = np.array(m.get_cm_const_ref())
483
484
485
486
487
488
489
490
491
492
493
494

    assert y1.flags.owndata and y1.flags.writeable
    # We should get copies of the eigen data, which was modified above:
    assert y1[1, 2] == 99
    y1[1, 2] += 12
    assert y1[1, 2] == 111
    assert zc[1, 2] == 99  # Make sure we aren't referencing the original


def test_both_ref_mutators():
    """Tests a complex chain of nested eigen/numpy references"""

495
496
497
    m.reset_refs()  # In case another test already changed it

    z = m.get_cm_ref()  # numpy -> eigen
498
    z[0, 2] -= 3
499
    z2 = m.incr_matrix(z, 1)  # numpy -> eigen -> numpy -> eigen
500
    z2[1, 1] += 6
501
    z3 = m.incr_matrix(z, 2)  # (numpy -> eigen)^3
502
    z3[2, 2] += -5
503
    z4 = m.incr_matrix(z, 3)  # (numpy -> eigen)^4
504
    z4[1, 1] -= 1
505
    z5 = m.incr_matrix(z, 4)  # (numpy -> eigen)^5
506
507
508
509
510
511
512
513
514
    z5[0, 0] = 0
    assert np.all(z == z2)
    assert np.all(z == z3)
    assert np.all(z == z4)
    assert np.all(z == z5)
    expect = np.array([[0., 22, 20], [31, 37, 33], [41, 42, 38]])
    assert np.all(z == expect)

    y = np.array(range(100), dtype='float64').reshape(10, 10)
515
516
517
518
519
    y2 = m.incr_matrix_any(y, 10)  # np -> eigen -> np
    y3 = m.incr_matrix_any(y2[0::2, 0::2], -33)  # np -> eigen -> np slice -> np -> eigen -> np
    y4 = m.even_rows(y3)  # numpy -> eigen slice -> (... y3)
    y5 = m.even_cols(y4)  # numpy -> eigen slice -> (... y4)
    y6 = m.incr_matrix_any(y5, 1000)  # numpy -> eigen -> (... y5)
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542

    # Apply same mutations using just numpy:
    yexpect = np.array(range(100), dtype='float64').reshape(10, 10)
    yexpect += 10
    yexpect[0::2, 0::2] -= 33
    yexpect[0::4, 0::4] += 1000
    assert np.all(y6 == yexpect[0::4, 0::4])
    assert np.all(y5 == yexpect[0::4, 0::4])
    assert np.all(y4 == yexpect[0::4, 0::2])
    assert np.all(y3 == yexpect[0::2, 0::2])
    assert np.all(y2 == yexpect)
    assert np.all(y == yexpect)


def test_nocopy_wrapper():
    # get_elem requires a column-contiguous matrix reference, but should be
    # callable with other types of matrix (via copying):
    int_matrix_colmajor = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]], order='F')
    dbl_matrix_colmajor = np.array(int_matrix_colmajor, dtype='double', order='F', copy=True)
    int_matrix_rowmajor = np.array(int_matrix_colmajor, order='C', copy=True)
    dbl_matrix_rowmajor = np.array(int_matrix_rowmajor, dtype='double', order='C', copy=True)

    # All should be callable via get_elem:
543
544
545
546
    assert m.get_elem(int_matrix_colmajor) == 8
    assert m.get_elem(dbl_matrix_colmajor) == 8
    assert m.get_elem(int_matrix_rowmajor) == 8
    assert m.get_elem(dbl_matrix_rowmajor) == 8
547

548
    # All but the second should fail with m.get_elem_nocopy:
549
    with pytest.raises(TypeError) as excinfo:
550
        m.get_elem_nocopy(int_matrix_colmajor)
551
552
    assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.f_contiguous' in str(excinfo.value))
553
    assert m.get_elem_nocopy(dbl_matrix_colmajor) == 8
554
    with pytest.raises(TypeError) as excinfo:
555
        m.get_elem_nocopy(int_matrix_rowmajor)
556
557
558
    assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.f_contiguous' in str(excinfo.value))
    with pytest.raises(TypeError) as excinfo:
559
        m.get_elem_nocopy(dbl_matrix_rowmajor)
560
561
562
563
564
    assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.f_contiguous' in str(excinfo.value))

    # For the row-major test, we take a long matrix in row-major, so only the third is allowed:
    with pytest.raises(TypeError) as excinfo:
565
        m.get_elem_rm_nocopy(int_matrix_colmajor)
566
567
568
    assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.c_contiguous' in str(excinfo.value))
    with pytest.raises(TypeError) as excinfo:
569
        m.get_elem_rm_nocopy(dbl_matrix_colmajor)
570
571
    assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.c_contiguous' in str(excinfo.value))
572
    assert m.get_elem_rm_nocopy(int_matrix_rowmajor) == 8
573
    with pytest.raises(TypeError) as excinfo:
574
        m.get_elem_rm_nocopy(dbl_matrix_rowmajor)
575
576
577
578
    assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and
            ', flags.c_contiguous' in str(excinfo.value))


579
580
581
582
583
584
585
586
def test_eigen_ref_life_support():
    """Ensure the lifetime of temporary arrays created by the `Ref` caster

    The `Ref` caster sometimes creates a copy which needs to stay alive. This needs to
    happen both for directs casts (just the array) or indirectly (e.g. list of arrays).
    """

    a = np.full(shape=10, fill_value=8, dtype=np.int8)
587
    assert m.get_elem_direct(a) == 8
588
589

    list_of_a = [a]
590
    assert m.get_elem_indirect(list_of_a) == 8
591
592


Dean Moldovan's avatar
Dean Moldovan committed
593
def test_special_matrix_objects():
594
    assert np.all(m.incr_diag(7) == np.diag([1., 2, 3, 4, 5, 6, 7]))
Dean Moldovan's avatar
Dean Moldovan committed
595

596
    asymm = np.array([[ 1.,  2,  3,  4],
Dean Moldovan's avatar
Dean Moldovan committed
597
598
599
600
601
602
603
604
605
606
                      [ 5,  6,  7,  8],
                      [ 9, 10, 11, 12],
                      [13, 14, 15, 16]])
    symm_lower = np.array(asymm)
    symm_upper = np.array(asymm)
    for i in range(4):
        for j in range(i + 1, 4):
            symm_lower[i, j] = symm_lower[j, i]
            symm_upper[j, i] = symm_upper[i, j]

607
608
    assert np.all(m.symmetric_lower(asymm) == symm_lower)
    assert np.all(m.symmetric_upper(asymm) == symm_upper)
Dean Moldovan's avatar
Dean Moldovan committed
609
610
611


def test_dense_signature(doc):
612
    assert doc(m.double_col) == """
613
        double_col(arg0: numpy.ndarray[numpy.float32[m, 1]]) -> numpy.ndarray[numpy.float32[m, 1]]
614
    """
615
    assert doc(m.double_row) == """
616
        double_row(arg0: numpy.ndarray[numpy.float32[1, n]]) -> numpy.ndarray[numpy.float32[1, n]]
617
    """
618
619
620
621
622
623
624
625
    assert doc(m.double_complex) == ("""
        double_complex(arg0: numpy.ndarray[numpy.complex64[m, 1]])"""
                                     """ -> numpy.ndarray[numpy.complex64[m, 1]]
    """)
    assert doc(m.double_mat_rm) == ("""
        double_mat_rm(arg0: numpy.ndarray[numpy.float32[m, n]])"""
                                    """ -> numpy.ndarray[numpy.float32[m, n]]
    """)
Dean Moldovan's avatar
Dean Moldovan committed
626
627


628
629
630
631
def test_named_arguments():
    a = np.array([[1.0, 2], [3, 4], [5, 6]])
    b = np.ones((2, 1))

632
633
634
    assert np.all(m.matrix_multiply(a, b) == np.array([[3.], [7], [11]]))
    assert np.all(m.matrix_multiply(A=a, B=b) == np.array([[3.], [7], [11]]))
    assert np.all(m.matrix_multiply(B=b, A=a) == np.array([[3.], [7], [11]]))
635
636

    with pytest.raises(ValueError) as excinfo:
637
        m.matrix_multiply(b, a)
638
639
640
    assert str(excinfo.value) == 'Nonconformable matrices!'

    with pytest.raises(ValueError) as excinfo:
641
        m.matrix_multiply(A=b, B=a)
642
643
644
    assert str(excinfo.value) == 'Nonconformable matrices!'

    with pytest.raises(ValueError) as excinfo:
645
        m.matrix_multiply(B=a, A=b)
646
647
648
    assert str(excinfo.value) == 'Nonconformable matrices!'


Dean Moldovan's avatar
Dean Moldovan committed
649
650
@pytest.requires_eigen_and_scipy
def test_sparse():
651
652
653
654
655
656
    assert_sparse_equal_ref(m.sparse_r())
    assert_sparse_equal_ref(m.sparse_c())
    assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_r()))
    assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_c()))
    assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_c()))
    assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_r()))
Dean Moldovan's avatar
Dean Moldovan committed
657
658
659
660


@pytest.requires_eigen_and_scipy
def test_sparse_signature(doc):
661
    assert doc(m.sparse_copy_r) == """
662
        sparse_copy_r(arg0: scipy.sparse.csr_matrix[numpy.float32]) -> scipy.sparse.csr_matrix[numpy.float32]
663
    """  # noqa: E501 line too long
664
    assert doc(m.sparse_copy_c) == """
665
        sparse_copy_c(arg0: scipy.sparse.csc_matrix[numpy.float32]) -> scipy.sparse.csc_matrix[numpy.float32]
666
    """  # noqa: E501 line too long
667
668
669


def test_issue738():
670
671
672
    """Ignore strides on a length-1 dimension (even if they would be incompatible length > 1)"""
    assert np.all(m.iss738_f1(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]]))
    assert np.all(m.iss738_f1(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]]))
673

674
675
    assert np.all(m.iss738_f2(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]]))
    assert np.all(m.iss738_f2(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]]))
676
677


678
679
680
681
682
683
684
685
686
def test_issue1105():
    """Issue 1105: 1xN or Nx1 input arrays weren't accepted for eigen
    compile-time row vectors or column vector"""
    assert m.iss1105_row(np.ones((1, 7)))
    assert m.iss1105_col(np.ones((7, 1)))

    # These should still fail (incompatible dimensions):
    with pytest.raises(TypeError) as excinfo:
        m.iss1105_row(np.ones((7, 1)))
687
    assert "incompatible function arguments" in str(excinfo.value)
688
689
    with pytest.raises(TypeError) as excinfo:
        m.iss1105_col(np.ones((1, 7)))
690
    assert "incompatible function arguments" in str(excinfo.value)
691
692


693
694
695
696
def test_custom_operator_new():
    """Using Eigen types as member variables requires a class-specific
    operator new with proper alignment"""

697
    o = m.CustomOperatorNew()
698
699
    np.testing.assert_allclose(o.a, 0.0)
    np.testing.assert_allclose(o.b.diagonal(), 1.0)