aboutsummaryrefslogtreecommitdiff
path: root/tests/unit/computations/test_slink.py
blob: da17ac3a5b956c31fbcca0287f511c0009dab9f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
"""Module contains tests for slink"""
import unittest
from unittest import TestCase

from gn3.computations.slink import slink
from gn3.computations.slink import nearest
from gn3.computations.slink import LengthError
from gn3.computations.slink import MirrorError

class TestSlink(TestCase):
    """Class for testing slink functions"""

    def test_nearest_expects_list_of_lists(self):
        # This might be better handled with type-hints and mypy
        for item in [9, "some string", 5.432,
                     [1,2,3], ["test", 7.4]]:
            with self.subTest(item=item):
                with self.assertRaises(ValueError, msg="Expected list or tuple"):
                    nearest(item, 1, 1)

    def test_nearest_does_not_allow_empty_lists(self):
        for lst in [[],
                    [[],[]],
                    [[],[],[]],
                    [[0, 1, 2],[],[1, 2, 0]]]:
            with self.subTest(lst=lst):
                with self.assertRaises(ValueError):
                    nearest(lst, 1, 1)

    def test_nearest_expects_exception_if_all_child_lists_are_not_of_equal_length_to_length_of_parent_list(self):
        for lst in [[[0,1]],
                    [[0,1,2],[3,4,5]],
                    [[0,1,2,3],[4,5,6],[7,8,9,0]],
                    [[0,1,2,3,4],[5,6,7,8,9],[1,2,3,4,5],[2,3],[3,4,5,6,7]]]:
            with self.subTest(lst=lst):
                with self.assertRaises(LengthError):
                    nearest(lst, 1, 1)

    def test_nearest_expects_exception_if_distance_of_child_from_itself_is_not_zero(self):
        for lst in [[[1]],
                    [[1,2],[3,4]],
                    [1,0,0],[0,0,5],[0,3,4],
                    [0,0,0,0],[0,0,3,3],[0,1,2,3],[0,3,2,0]]:
            with self.subTest(lst=lst):
                with self.assertRaises(ValueError):
                    nearest(lst, 1, 1)

    def test_nearest_expects_exception_if_distance_from_child_a_to_child_b_is_not_distance_from_child_b_to_child_a(self):
        for lst in [[[0,1],[2,0]],
                    [[0,1,2],[1,0,3],[9,7,0]],
                    [[0,1,2,3],[7,0,2,3],[2,3,0,1],[8,9,5,0]]]:
            with self.subTest(lst=lst):
                with self.assertRaises(MirrorError):
                    nearest(lst, 1, 1)

    def test_nearest_expects_zero_or_positive_distances(self):
        # Based on:
        # https://github.com/genenetwork/genenetwork1/blob/master/web/webqtl/heatmap/slink.py#L87-L89
        for lst in [[[0,-1,2,3],[-1,0,3,4],[2,3,0,5],[3,4,5,0]],
                    [[0,1,-2,3],[1,0,3,4],[-2,3,0,5],[3,4,5,0]],
                    [[0,1,2,3],[1,0,-3,4],[2,-3,0,5],[3,4,5,0]],
                    [[0,1,2,-3],[1,0,3,4],[2,3,0,5],[-3,4,5,0]],
                    [[0,1,2,3],[1,0,3,-4],[2,3,0,5],[3,-4,5,0]],
                    [[0,1,2,3],[1,0,3,4],[2,3,0,-5],[3,4,-5,0]]]:
            with self.subTest(lst=lst):
                with self.assertRaises(ValueError, msg="Distances should be positive."):
                    nearest(lst, 1, 1)

    def test_nearest_returns_shortest_distance_given_coordinates_to_both_group_members(self):
        # This test is named wrong - at least I think it is, from the expected results
        # This tests distance when both `i`, and `j` are integers
        # We still need to add tests for when (either one/both) (is/are) not (an) integer(s)
        # https://github.com/genenetwork/genenetwork1/blob/master/web/webqtl/heatmap/slink.py#L39-L40
        for lst, i, j, expected in [[[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     0,0,0],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     0,1,9],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     0,2,3],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     0,3,6],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     0,4,11],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     1,0,9],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     1,1,0],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     1,2,7],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     1,3,5],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     1,4,10],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     2,0,3],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     2,1,7],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     2,2,0],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     2,3,9],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     2,4,2],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     3,0,6],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     3,1,5],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     3,2,9],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     3,3,0],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     3,4,8],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     4,0,11],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     4,1,10],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     4,2,2],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     4,3,8],
                                    [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                                     4,4,0],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     0,0,0],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     0,1,9],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     0,2,5.5],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     0,3,6],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     0,4,11],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     1,0,9],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     1,1,0],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     1,2,7],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     1,3,5],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     1,4,10],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     2,0,5.5],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     2,1,7],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     2,2,0],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     2,3,9],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     2,4,2],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     3,0,6],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     3,1,5],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     3,2,9],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     3,3,0],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     3,4,3],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     4,0,11],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     4,1,10],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     4,2,2],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     4,3,3],
                                    [[[0,9,5.5,6,11],[9,0,7,5,10],[5.5,7,0,9,2],[6,5,9,0,3],[11,10,2,3,0]],
                                     4,4,0]]:
            with self.subTest(lst=lst):
                self.assertEqual(nearest(lst, i, j), expected)

    def test_given_a_list_or_tuple_of_members_distances_and_a_coordinate_find_closest_member_to_member_at_coordinate(self):
        for md, ml, mc, ed in [
                [[[0,9,3],[9,0,7],[3,7,0]],(0,2,3),1,7],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],[0,1,2,3,4],3,0],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],[0,1,2,4],3,5],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],[0,2,4],3,6],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],[2,4],3,9]]:
            with self.subTest(
                    members_distances=md, members_list=ml, member_coordinate=mc,
                    expected_distance=ed):
                self.assertEqual(nearest(md, ml, mc), ed)
                self.assertEqual(nearest(md, mc, ml), ed)

    def test_given_2_lists_or_tuples_of_members_distances_nearest_returns_shortest_distance(self):
        for md, ml, mc, ed in [
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                 [0,1,2,3,4],[0,1,2,3,4],0],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                 [0,1],[3,4],6],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                 [0,1],[2,3,4],3],
                [[[0,9,3,6,11],[9,0,7,5,10],[3,7,0,9,2],[6,5,9,0,8],[11,10,2,8,0]],
                 [0,2],[3,4],6]]:
            with self.subTest(
                    members_distances=md, members_list=ml, member_coordinate=mc,
                    expected_distance=ed):
                self.assertEqual(nearest(md, ml, mc), ed)
                self.assertEqual(nearest(md, mc, ml), ed)

    def test_slink_wrong_data_returns_empty_list(self):
        for data in [1, "test", [], 2.945, nearest, [0]]:
            with self.subTest(data=data):
                self.assertEqual(slink(data), [])