JAL-3761 debugged and working (but not tidied) locateInFrom2/To2
[jalview.git] / src / jalview / util / SetUtils.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ 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 java.util.Set;
24
25 public class SetUtils
26 {
27   /**
28    * Returns the count of things that are in one or other of two sets but not in
29    * both. The sets are not modified.
30    * 
31    * @param set1
32    * @param set2
33    * @return
34    */
35   public static int countDisjunction(Set<? extends Object> set1,
36           Set<? extends Object> set2)
37   {
38     if (set1 == null)
39     {
40       return set2 == null ? 0 : set2.size();
41     }
42     if (set2 == null)
43     {
44       return set1.size();
45     }
46
47     int size1 = set1.size();
48     int size2 = set2.size();
49     Set<? extends Object> smallerSet = size1 < size2 ? set1 : set2;
50     Set<? extends Object> largerSet = (smallerSet == set1 ? set2 : set1);
51     int inCommon = 0;
52     for (Object k : smallerSet)
53     {
54       if (largerSet.contains(k))
55       {
56         inCommon++;
57       }
58     }
59
60     int notInCommon = (size1 - inCommon) + (size2 - inCommon);
61     return notInCommon;
62   }
63 }