JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / test / jalview / util / ComparisonTest.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
3  * Copyright (C) 2015 The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.util;
22
23 import static org.testng.AssertJUnit.assertEquals;
24 import static org.testng.AssertJUnit.assertFalse;
25 import static org.testng.AssertJUnit.assertTrue;
26
27 import jalview.datamodel.Sequence;
28 import jalview.datamodel.SequenceI;
29
30 import org.testng.annotations.Test;
31
32 public class ComparisonTest
33 {
34
35   @Test(groups = { "Functional" })
36   public void testIsGap()
37   {
38     assertTrue(Comparison.isGap('-'));
39     assertTrue(Comparison.isGap('.'));
40     assertTrue(Comparison.isGap(' '));
41     assertFalse(Comparison.isGap('X'));
42     assertFalse(Comparison.isGap('x'));
43     assertFalse(Comparison.isGap('*'));
44     assertFalse(Comparison.isGap('G'));
45   }
46
47   /**
48    * Test for isNucleotide is that sequences in a dataset are more than 85%
49    * AGCTU. Test is not case-sensitive and ignores gaps.
50    */
51   @Test(groups = { "Functional" })
52   public void testIsNucleotide()
53   {
54     SequenceI seq = new Sequence("eightypercent", "agctuAGCPV");
55     assertFalse(Comparison.isNucleotide(new SequenceI[] { seq }));
56     assertFalse(Comparison.isNucleotide(new SequenceI[][] { new SequenceI[]
57     { seq } }));
58
59     seq = new Sequence("eightyfivepercent", "agctuAGCPVagctuAGCUV");
60     assertFalse(Comparison.isNucleotide(new SequenceI[] { seq }));
61
62     seq = new Sequence("nineypercent", "agctuAGCgVagctuAGCUV");
63     assertTrue(Comparison.isNucleotide(new SequenceI[] { seq }));
64
65     seq = new Sequence("eightyfivepercentgapped",
66             "--agc--tuA--GCPV-a---gct-uA-GC---UV");
67     assertFalse(Comparison.isNucleotide(new SequenceI[] { seq }));
68
69     seq = new Sequence("nineypercentgapped",
70             "ag--ct-u-A---GC---g----Vag--c---tuAGCUV");
71     assertTrue(Comparison.isNucleotide(new SequenceI[] { seq }));
72
73     seq = new Sequence("allgap", "---------");
74     assertFalse(Comparison.isNucleotide(new SequenceI[] { seq }));
75
76     seq = new Sequence("DNA", "ACTugGCCAG");
77     SequenceI seq2 = new Sequence("Protein", "FLIMVSPTYW");
78     /*
79      * 90% DNA:
80      */
81     assertTrue(Comparison.isNucleotide(new SequenceI[] { seq, seq, seq,
82         seq, seq, seq, seq, seq, seq, seq2 }));
83     assertTrue(Comparison.isNucleotide(new SequenceI[][] {
84         new SequenceI[] { seq }, new SequenceI[] { seq, seq, seq },
85         new SequenceI[] { seq, seq, seq, seq, seq, seq2 } }));
86     /*
87      * 80% DNA:
88      */
89     assertFalse(Comparison.isNucleotide(new SequenceI[] { seq, seq, seq,
90         seq, seq, seq, seq, seq, seq2, seq2 }));
91     assertFalse(Comparison.isNucleotide(new SequenceI[][] { new SequenceI[]
92     { seq }, new SequenceI[] { seq, seq, seq },
93         new SequenceI[] { seq, seq, seq, seq, seq2, seq2, null } }));
94
95     seq = new Sequence("ProteinThatLooksLikeDNA", "WYATGCCTGAgtcgt");
96     // 12/14 = 85.7%
97     assertTrue(Comparison.isNucleotide(new SequenceI[] { seq }));
98
99     assertFalse(Comparison.isNucleotide((SequenceI[]) null));
100     assertFalse(Comparison.isNucleotide((SequenceI[][]) null));
101   }
102
103   /**
104    * Test percentage identity calculation for two sequences.
105    */
106   @Test(groups = { "Functional" })
107   public void testPID_matchGaps()
108   {
109     String seq1 = "ABCDEF";
110     String seq2 = "abcdef";
111     assertEquals("identical", 100f, Comparison.PID(seq1, seq2), 0.001f);
112
113     // comparison range defaults to length of first sequence
114     seq2 = "abcdefghijklmnopqrstuvwxyz";
115     assertEquals("identical", 100f, Comparison.PID(seq1, seq2), 0.001f);
116
117     seq2 = "a---bcdef";
118   }
119 }