1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2025.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.numerics.clustering;
39
40 import ffx.utilities.FFXTest;
41 import org.junit.Test;
42
43 import static org.junit.Assert.*;
44
45 public class DistanceMapTest extends FFXTest {
46 DistanceMap map = new DistanceMap();
47 ClusterPair ab = new ClusterPair(new Cluster("a"), new Cluster("b"), 1.0);
48 ClusterPair bc = new ClusterPair(new Cluster("b"), new Cluster("c"), 2.0);
49 ClusterPair ca = new ClusterPair(new Cluster("c"), new Cluster("a"), 3.0);
50
51 @Test
52 public void testMapWorksWithSameDistance() throws Exception {
53 this.map.add(ab);
54 this.map.add(ab); //add the same link twice. This seems to be an error case
55 assertEquals(1,this.map.list().size());
56 ClusterPair remove = this.map.removeFirst();
57 assertNotNull(remove);
58 assertEquals(0,this.map.list().size()); //still exists in the map(even though removeFirst will return null now)
59 ClusterPair remove2 = this.map.removeFirst();
60 assertNull(remove2);
61 }
62 @Test
63 public void testMapRemovalFront() throws Exception {
64 this.map.add(ca);
65 this.map.add(bc);
66 this.map.add(ab);
67
68 ClusterPair removeFirst = this.map.removeFirst();
69 assertEquals(ab, removeFirst);
70 }
71 @Test
72 public void testMapRemovalByObjectPollLoop() throws Exception {
73 this.map.add(ca);
74 this.map.add(bc);
75 this.map.add(ab);
76
77 assertTrue(this.map.remove(ab)); //Doesn't actually remove from prioQueue
78 ClusterPair removeFirst = this.map.removeFirst();
79 assertEquals(bc, removeFirst); //removeFirst should now skip the ab
80 }
81 @Test
82 public void testMapRemovalByObjectPollLoopHandlesAllEmpty() throws Exception {
83 this.map.add(ca);
84 this.map.add(bc);
85 this.map.add(ab);
86
87 assertTrue(this.map.remove(ab)); //Doesn't actually remove from prioQueue
88 assertTrue(this.map.remove(bc)); //Doesn't actually remove from prioQueue
89 assertTrue(this.map.remove(ca)); //Doesn't actually remove from prioQueue
90 assertFalse(this.map.remove(ab)); //Doesn't actually remove from prioQueue
91 ClusterPair removeFirst = this.map.removeFirst();
92 assertNull(removeFirst); //removeFirst should now skip the ab
93 }
94 }