2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.datamodel;
23 import jalview.util.Comparison;
25 import java.util.ArrayList;
26 import java.util.BitSet;
27 import java.util.Iterator;
28 import java.util.List;
29 import java.util.NoSuchElementException;
30 import java.util.Vector;
31 import java.util.concurrent.locks.ReentrantReadWriteLock;
33 public class HiddenColumns
35 private static final int HASH_MULTIPLIER = 31;
37 private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock();
40 * list of hidden column [start, end] ranges; the list is maintained in
41 * ascending start column order
43 private ArrayList<int[]> hiddenColumns;
48 public HiddenColumns()
57 public HiddenColumns(HiddenColumns copy)
61 LOCK.writeLock().lock();
64 if (copy.hiddenColumns != null)
66 hiddenColumns = copy.copyHiddenRegionsToArrayList(0);
71 LOCK.writeLock().unlock();
76 * Copy constructor within bounds and with offset. Copies hidden column
77 * regions fully contained between start and end, and offsets positions by
81 * HiddenColumns instance to copy from
83 * lower bound to copy from
85 * upper bound to copy to
87 * offset to subtract from each region boundary position
90 public HiddenColumns(HiddenColumns copy, int start, int end, int offset)
94 LOCK.writeLock().lock();
97 hiddenColumns = new ArrayList<>();
98 Iterator<int[]> it = copy.getBoundedIterator(start, end);
101 int[] region = it.next();
102 // still need to check boundaries because iterator returns
103 // all overlapping regions and we need contained regions
104 if (region[0] >= start && region[1] <= end)
108 { region[0] - offset, region[1] - offset });
114 LOCK.writeLock().unlock();
119 * Output regions data as a string. String is in the format:
120 * reg0[0]<between>reg0[1]<delimiter>reg1[0]<between>reg1[1] ... regn[1]
123 * string to delimit regions
124 * @param betweenstring
125 * to put between start and end region values
126 * @return regions formatted according to delimiter and between strings
128 public String regionsToString(String delimiter, String between)
132 LOCK.readLock().lock();
133 StringBuilder regionBuilder = new StringBuilder();
134 if (hiddenColumns != null)
136 for (int[] range : hiddenColumns)
138 regionBuilder.append(delimiter).append(range[0]).append(between)
142 regionBuilder.deleteCharAt(0);
144 return regionBuilder.toString();
147 LOCK.readLock().unlock();
152 * Find the number of hidden columns
154 * @return number of hidden columns
160 LOCK.readLock().lock();
162 if (hasHiddenColumns())
164 for (int[] range : hiddenColumns)
166 size += range[1] - range[0] + 1;
172 LOCK.readLock().unlock();
177 * Get the number of distinct hidden regions
179 * @return number of regions
181 public int getNumberOfRegions()
185 LOCK.readLock().lock();
187 if (hasHiddenColumns())
189 num = hiddenColumns.size();
194 LOCK.readLock().unlock();
199 public boolean equals(Object obj)
203 LOCK.readLock().lock();
205 if (!(obj instanceof HiddenColumns))
209 HiddenColumns that = (HiddenColumns) obj;
212 * check hidden columns are either both null, or match
214 if (this.hiddenColumns == null)
216 return (that.hiddenColumns == null);
218 if (that.hiddenColumns == null
219 || that.hiddenColumns.size() != this.hiddenColumns.size())
224 for (int[] thisRange : hiddenColumns)
226 int[] thatRange = that.hiddenColumns.get(i++);
227 if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
235 LOCK.readLock().unlock();
240 * Return absolute column index for a visible column index
243 * int column index in alignment view (count from zero)
244 * @return alignment column index for column
246 public int adjustForHiddenColumns(int column)
250 LOCK.readLock().lock();
252 if (hiddenColumns != null)
254 for (int i = 0; i < hiddenColumns.size(); i++)
256 int[] region = hiddenColumns.get(i);
257 if (result >= region[0])
259 result += region[1] - region[0] + 1;
266 LOCK.readLock().unlock();
271 * Use this method to find out where a column will appear in the visible
272 * alignment when hidden columns exist. If the column is not visible, then the
273 * left-most visible column will always be returned.
275 * @param hiddenColumn
276 * the column index in the full alignment including hidden columns
277 * @return the position of the column in the visible alignment
279 public int findColumnPosition(int hiddenColumn)
283 LOCK.readLock().lock();
284 int result = hiddenColumn;
285 if (hiddenColumns != null)
291 region = hiddenColumns.get(index++);
292 if (hiddenColumn > region[1])
294 result -= region[1] + 1 - region[0];
296 } while ((hiddenColumn > region[1])
297 && (index < hiddenColumns.size()));
299 if (hiddenColumn >= region[0] && hiddenColumn <= region[1])
301 // Here the hidden column is within a region, so
302 // we want to return the position of region[0]-1, adjusted for any
303 // earlier hidden columns.
304 // Calculate the difference between the actual hidden col position
305 // and region[0]-1, and then subtract from result to convert result
307 // the adjusted hiddenColumn value to the adjusted region[0]-1 value
309 // However, if the region begins at 0 we cannot return region[0]-1
317 return result - (hiddenColumn - region[0] + 1);
321 return result; // return the shifted position after removing hidden
325 LOCK.readLock().unlock();
330 * Find the visible column which is a given visible number of columns to the
331 * left of another visible column. i.e. for a startColumn x, the column which
332 * is distance 1 away will be column x-1.
334 * @param visibleDistance
335 * the number of visible columns to offset by
337 * the column to start from
338 * @return the position of the column in the visible alignment
340 public int subtractVisibleColumns(int visibleDistance, int startColumn)
345 LOCK.readLock().lock();
346 int distance = visibleDistance;
348 // in case startColumn is in a hidden region, move it to the left
349 int start = adjustForHiddenColumns(findColumnPosition(startColumn));
351 // get index of hidden region to left of start
352 int index = getHiddenIndexLeft(start);
355 // no hidden regions to left of startColumn
356 return start - distance;
359 // walk backwards through the alignment subtracting the counts of visible
360 // columns from distance
363 int nextstart = start;
365 while ((index > -1) && (distance - gap > 0))
367 // subtract the gap to right of region from distance
371 // calculate the next gap
372 region = hiddenColumns.get(index);
373 gap = start - region[1];
375 // set start to just to left of current region
376 nextstart = region[0] - 1;
380 if (distance - gap > 0)
382 // fell out of loop because there are no more hidden regions
384 return nextstart - distance;
386 return start - distance;
389 LOCK.readLock().unlock();
397 * This method returns the rightmost limit of a region of an alignment with
398 * hidden columns. In otherwords, the next hidden column.
403 public int getHiddenBoundaryRight(int alPos)
407 LOCK.readLock().lock();
408 if (hiddenColumns != null)
413 int[] region = hiddenColumns.get(index);
414 if (alPos < region[0])
420 } while (index < hiddenColumns.size());
426 LOCK.readLock().unlock();
432 * This method returns the leftmost limit of a region of an alignment with
433 * hidden columns. In otherwords, the previous hidden column.
438 public int getHiddenBoundaryLeft(int alPos)
442 LOCK.readLock().lock();
444 if (hiddenColumns != null)
446 int index = hiddenColumns.size() - 1;
449 int[] region = hiddenColumns.get(index);
450 if (alPos > region[1])
456 } while (index > -1);
462 LOCK.readLock().unlock();
467 * This method returns the index of the hidden region to the left of a column
468 * position. If the column is in a hidden region it returns the index of the
469 * region to the left. If there is no hidden region to the left it returns -1.
474 private int getHiddenIndexLeft(int pos)
479 LOCK.readLock().lock();
480 if (hiddenColumns != null)
482 int index = hiddenColumns.size() - 1;
485 int[] region = hiddenColumns.get(index);
492 } while (index > -1);
498 LOCK.readLock().unlock();
504 * Adds the specified column range to the hidden columns
509 public void hideColumns(int start, int end)
511 boolean wasAlreadyLocked = false;
514 // check if the write lock was already locked by this thread,
515 // as this method can be called internally in loops within HiddenColumns
516 if (!LOCK.isWriteLockedByCurrentThread())
518 LOCK.writeLock().lock();
522 wasAlreadyLocked = true;
525 if (hiddenColumns == null)
527 hiddenColumns = new ArrayList<>();
531 * traverse existing hidden ranges and insert / amend / append as
534 for (int i = 0; i < hiddenColumns.size(); i++)
536 int[] region = hiddenColumns.get(i);
538 if (end < region[0] - 1)
541 * insert discontiguous preceding range
543 hiddenColumns.add(i, new int[] { start, end });
547 if (end <= region[1])
550 * new range overlaps existing, or is contiguous preceding it - adjust
553 region[0] = Math.min(region[0], start);
557 if (start <= region[1] + 1)
560 * new range overlaps existing, or is contiguous following it - adjust
561 * start and end columns
563 region[0] = Math.min(region[0], start);
564 region[1] = Math.max(region[1], end);
567 * also update or remove any subsequent ranges
568 * that are overlapped
570 while (i < hiddenColumns.size() - 1)
572 int[] nextRegion = hiddenColumns.get(i + 1);
573 if (nextRegion[0] > end + 1)
576 * gap to next hidden range - no more to update
580 region[1] = Math.max(nextRegion[1], end);
581 hiddenColumns.remove(i + 1);
588 * remaining case is that the new range follows everything else
590 hiddenColumns.add(new int[] { start, end });
593 if (!wasAlreadyLocked)
595 LOCK.writeLock().unlock();
600 public boolean isVisible(int column)
604 LOCK.readLock().lock();
606 if (hiddenColumns != null)
608 for (int[] region : hiddenColumns)
610 if (column >= region[0] && column <= region[1])
620 LOCK.readLock().unlock();
624 private ArrayList<int[]> copyHiddenRegionsToArrayList(int startIndex)
627 if (hiddenColumns != null)
629 size = hiddenColumns.size();
631 ArrayList<int[]> copy = new ArrayList<>(size);
633 for (int i = startIndex, j = size; i < j; i++)
637 rh = hiddenColumns.get(i);
640 cp = new int[rh.length];
641 System.arraycopy(rh, 0, cp, 0, rh.length);
649 public String[] getVisibleSequenceStrings(int start, int end,
654 LOCK.readLock().lock();
655 int iSize = seqs.length;
656 String[] selections = new String[iSize];
657 if (hiddenColumns != null && hiddenColumns.size() > 0)
659 for (int i = 0; i < iSize; i++)
661 StringBuffer visibleSeq = new StringBuffer();
663 int blockStart = start;
666 Iterator<int[]> regions = new BoundedHiddenColsIterator(start,
668 while (regions.hasNext())
670 int[] region = regions.next();
671 blockStart = Math.min(blockStart, region[1] + 1);
672 blockEnd = Math.min(blockEnd, region[0]);
674 visibleSeq.append(seqs[i].getSequence(blockStart, blockEnd));
676 blockStart = region[1] + 1;
680 if (end > blockStart)
682 visibleSeq.append(seqs[i].getSequence(blockStart, end));
685 selections[i] = visibleSeq.toString();
690 for (int i = 0; i < iSize; i++)
692 selections[i] = seqs[i].getSequenceAsString(start, end);
699 LOCK.readLock().unlock();
704 * Locate the first and last position visible for this sequence. if seq isn't
705 * visible then return the position of the left and right of the hidden
706 * boundary region, and the corresponding alignment column indices for the
707 * extent of the sequence
710 * @return int[] { visible start, visible end, first seqpos, last seqpos,
711 * alignment index for seq start, alignment index for seq end }
713 public int[] locateVisibleBoundsOfSequence(SequenceI seq)
717 LOCK.readLock().lock();
718 int fpos = seq.getStart();
719 int lpos = seq.getEnd();
722 if (hiddenColumns == null || hiddenColumns.size() == 0)
724 int ifpos = seq.findIndex(fpos) - 1;
725 int ilpos = seq.findIndex(lpos) - 1;
726 return new int[] { ifpos, ifpos, ilpos };
729 // Simply walk along the sequence whilst watching for hidden column
731 Iterator<int[]> regions = iterator();
733 int hideStart = seq.getLength();
739 boolean foundStart = false;
740 for (int p = 0, pLen = seq.getLength(); spos <= seq.getEnd()
743 if (!Comparison.isGap(seq.getCharAt(p)))
745 // keep track of first/last column
746 // containing sequence data regardless of visibility
752 // update hidden region start/end
753 while (hideEnd < p && regions.hasNext())
755 int[] region = regions.next();
757 visNext += region[0] - visPrev;
758 hideStart = region[0];
763 hideStart = seq.getLength();
765 // update visible boundary for sequence
776 // look for next sequence position
782 return new int[] { findColumnPosition(start), firstP, lastP };
784 // otherwise, sequence was completely hidden
785 return new int[] { visPrev, firstP, lastP };
788 LOCK.readLock().unlock();
793 * delete any columns in alignmentAnnotation that are hidden (including
794 * sequence associated annotation).
796 * @param alignmentAnnotation
798 public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
800 makeVisibleAnnotation(0, alignmentAnnotation.annotations.length,
801 alignmentAnnotation);
805 * delete any columns in alignmentAnnotation that are hidden (including
806 * sequence associated annotation).
809 * remove any annotation to the right of this column
811 * remove any annotation to the left of this column
812 * @param alignmentAnnotation
813 * the annotation to operate on
815 public void makeVisibleAnnotation(int start, int end,
816 AlignmentAnnotation alignmentAnnotation)
820 LOCK.readLock().lock();
822 int startFrom = start;
825 if (alignmentAnnotation.annotations != null)
827 if (hiddenColumns != null && hiddenColumns.size() > 0)
829 removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation);
833 alignmentAnnotation.restrict(startFrom, endAt);
838 LOCK.readLock().unlock();
842 private void removeHiddenAnnotation(int start, int end,
843 AlignmentAnnotation alignmentAnnotation)
845 // mangle the alignmentAnnotation annotation array
846 Vector<Annotation[]> annels = new Vector<>();
847 Annotation[] els = null;
848 int blockStart = start;
852 Iterator<int[]> regions = new BoundedHiddenColsIterator(start, end,
854 while (regions.hasNext())
856 int[] region = regions.next();
857 blockStart = Math.min(blockStart, region[1] + 1);
858 blockEnd = Math.min(blockEnd, region[0]);
860 els = new Annotation[blockEnd - blockStart];
861 annels.addElement(els);
862 System.arraycopy(alignmentAnnotation.annotations, blockStart, els, 0,
866 blockStart = region[1] + 1;
870 if (end > blockStart)
872 els = new Annotation[end - blockStart + 1];
873 annels.addElement(els);
875 + blockStart) <= alignmentAnnotation.annotations.length)
877 // copy just the visible segment of the annotation row
878 System.arraycopy(alignmentAnnotation.annotations, blockStart, els,
883 // copy to the end of the annotation row
884 System.arraycopy(alignmentAnnotation.annotations, blockStart, els,
885 0, (alignmentAnnotation.annotations.length - blockStart));
892 alignmentAnnotation.annotations = new Annotation[w];
895 for (Annotation[] chnk : annels)
897 System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
906 * @return true if there are columns hidden
908 public boolean hasHiddenColumns()
912 LOCK.readLock().lock();
913 return hiddenColumns != null && hiddenColumns.size() > 0;
916 LOCK.readLock().unlock();
922 * @return true if there are more than one set of columns hidden
924 public boolean hasManyHiddenColumns()
928 LOCK.readLock().lock();
929 return hiddenColumns != null && hiddenColumns.size() > 1;
932 LOCK.readLock().unlock();
937 * mark the columns corresponding to gap characters as hidden in the column
942 public void hideInsertionsFor(SequenceI sr)
946 LOCK.writeLock().lock();
947 List<int[]> inserts = sr.getInsertions();
948 for (int[] r : inserts)
950 hideColumns(r[0], r[1]);
954 LOCK.writeLock().unlock();
959 * Unhides, and adds to the selection list, all hidden columns
961 public void revealAllHiddenColumns(ColumnSelection sel)
965 LOCK.writeLock().lock();
966 if (hiddenColumns != null)
968 for (int i = 0; i < hiddenColumns.size(); i++)
970 int[] region = hiddenColumns.get(i);
971 for (int j = region[0]; j < region[1] + 1; j++)
978 hiddenColumns = null;
981 LOCK.writeLock().unlock();
986 * Reveals, and marks as selected, the hidden column range with the given
991 public void revealHiddenColumns(int start, ColumnSelection sel)
995 LOCK.writeLock().lock();
996 for (int i = 0; i < hiddenColumns.size(); i++)
998 int[] region = hiddenColumns.get(i);
999 if (start == region[0])
1001 for (int j = region[0]; j < region[1] + 1; j++)
1006 hiddenColumns.remove(region);
1010 if (hiddenColumns.size() == 0)
1012 hiddenColumns = null;
1016 LOCK.writeLock().unlock();
1021 * Add gaps into the sequences aligned to profileseq under the given
1026 * - alignment to have gaps inserted into it
1028 * - alignment view where sequence corresponding to profileseq is
1030 * @return new HiddenColumns for new alignment view, with insertions into
1031 * profileseq marked as hidden.
1033 public static HiddenColumns propagateInsertions(SequenceI profileseq,
1034 AlignmentI al, AlignmentView input)
1038 char gc = al.getGapCharacter();
1039 Object[] alandhidden = input.getAlignmentAndHiddenColumns(gc);
1040 HiddenColumns nview = (HiddenColumns) alandhidden[1];
1041 SequenceI origseq = ((SequenceI[]) alandhidden[0])[profsqpos];
1042 nview.propagateInsertions(profileseq, al, origseq);
1049 * - sequence in al which corresponds to origseq
1051 * - alignment which is to have gaps inserted into it
1053 * - sequence corresponding to profileseq which defines gap map for
1056 private void propagateInsertions(SequenceI profileseq, AlignmentI al,
1061 LOCK.writeLock().lock();
1063 char gc = al.getGapCharacter();
1065 // take the set of hidden columns, and the set of gaps in origseq,
1066 // and remove all the hidden gaps from hiddenColumns
1068 // first get the gaps as a Bitset
1069 BitSet gaps = origseq.gapBitset();
1071 // now calculate hidden ^ not(gap)
1072 BitSet hidden = new BitSet();
1073 markHiddenRegions(hidden);
1074 hidden.andNot(gaps);
1075 hiddenColumns = null;
1076 this.hideMarkedBits(hidden);
1078 // for each sequence in the alignment, except the profile sequence,
1079 // insert gaps corresponding to each hidden region
1080 // but where each hidden column region is shifted backwards by the number
1082 // preceding visible gaps
1083 // update hidden columns at the same time
1084 Iterator<int[]> regions = iterator();
1085 ArrayList<int[]> newhidden = new ArrayList<>();
1087 int numGapsBefore = 0;
1088 int gapPosition = 0;
1089 while (regions.hasNext())
1091 // get region coordinates accounting for gaps
1092 // we can rely on gaps not being *in* hidden regions because we already
1094 int[] region = regions.next();
1095 while (gapPosition < region[0])
1098 if (gaps.get(gapPosition))
1104 int left = region[0] - numGapsBefore;
1105 int right = region[1] - numGapsBefore;
1106 newhidden.add(new int[] { left, right });
1108 // make a string with number of gaps = length of hidden region
1109 StringBuffer sb = new StringBuffer();
1110 for (int s = 0; s < right - left + 1; s++)
1114 padGaps(sb, left, profileseq, al);
1117 hiddenColumns = newhidden;
1120 LOCK.writeLock().unlock();
1125 * Pad gaps in all sequences in alignment except profileseq
1128 * gap string to insert
1130 * position to insert at
1132 * sequence not to pad
1134 * alignment to pad sequences in
1136 private void padGaps(StringBuffer sb, int pos, SequenceI profileseq,
1139 // loop over the sequences and pad with gaps where required
1140 for (int s = 0, ns = al.getHeight(); s < ns; s++)
1142 SequenceI sqobj = al.getSequenceAt(s);
1143 if (sqobj != profileseq)
1145 String sq = al.getSequenceAt(s).getSequenceAsString();
1146 if (sq.length() <= pos)
1149 int diff = pos - sq.length() - 1;
1154 while ((diff = pos - sq.length() - 1) > 0)
1156 if (diff >= sb.length())
1158 sq += sb.toString();
1162 char[] buf = new char[diff];
1163 sb.getChars(0, diff, buf, 0);
1164 sq += buf.toString();
1168 sq += sb.toString();
1172 al.getSequenceAt(s).setSequence(
1173 sq.substring(0, pos) + sb.toString() + sq.substring(pos));
1180 * Returns a hashCode built from hidden column ranges
1183 public int hashCode()
1187 LOCK.readLock().lock();
1189 if (hiddenColumns != null)
1191 for (int[] hidden : hiddenColumns)
1193 hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
1194 hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
1200 LOCK.readLock().unlock();
1205 * Hide columns corresponding to the marked bits
1208 * - columns map to bits starting from zero
1210 public void hideMarkedBits(BitSet inserts)
1214 LOCK.writeLock().lock();
1215 for (int firstSet = inserts
1216 .nextSetBit(0), lastSet = 0; firstSet >= 0; firstSet = inserts
1217 .nextSetBit(lastSet))
1219 lastSet = inserts.nextClearBit(firstSet);
1220 hideColumns(firstSet, lastSet - 1);
1224 LOCK.writeLock().unlock();
1231 * BitSet where hidden columns will be marked
1233 public void markHiddenRegions(BitSet inserts)
1237 LOCK.readLock().lock();
1238 if (hiddenColumns == null)
1242 for (int[] range : hiddenColumns)
1244 inserts.set(range[0], range[1] + 1);
1248 LOCK.readLock().unlock();
1253 * Calculate the visible start and end index of an alignment.
1256 * full alignment width
1257 * @return integer array where: int[0] = startIndex, and int[1] = endIndex
1259 public int[] getVisibleStartAndEndIndex(int width)
1263 LOCK.readLock().lock();
1264 int[] alignmentStartEnd = new int[] { 0, width - 1 };
1265 int startPos = alignmentStartEnd[0];
1266 int endPos = alignmentStartEnd[1];
1268 int[] lowestRange = new int[] { -1, -1 };
1269 int[] higestRange = new int[] { -1, -1 };
1271 if (hiddenColumns == null)
1273 return new int[] { startPos, endPos };
1276 for (int[] hiddenCol : hiddenColumns)
1278 lowestRange = (hiddenCol[0] <= startPos) ? hiddenCol : lowestRange;
1279 higestRange = (hiddenCol[1] >= endPos) ? hiddenCol : higestRange;
1282 if (lowestRange[0] == -1 && lowestRange[1] == -1)
1284 startPos = alignmentStartEnd[0];
1288 startPos = lowestRange[1] + 1;
1291 if (higestRange[0] == -1 && higestRange[1] == -1)
1293 endPos = alignmentStartEnd[1];
1297 endPos = higestRange[0] - 1;
1299 return new int[] { startPos, endPos };
1302 LOCK.readLock().unlock();
1308 * Finds the hidden region (if any) which starts or ends at res
1311 * visible residue position, unadjusted for hidden columns
1312 * @return region as [start,end] or null if no matching region is found
1314 public int[] getRegionWithEdgeAtRes(int res)
1318 LOCK.readLock().lock();
1319 int adjres = adjustForHiddenColumns(res);
1321 int[] reveal = null;
1322 if (hiddenColumns != null)
1324 for (int[] region : hiddenColumns)
1326 if (adjres + 1 == region[0] || adjres - 1 == region[1])
1336 LOCK.readLock().unlock();
1341 * Return an iterator over the hidden regions
1343 public Iterator<int[]> iterator()
1345 if (hiddenColumns != null)
1347 int last = hiddenColumns.get(hiddenColumns.size() - 1)[1];
1348 return new BoundedHiddenColsIterator(0, last, true);
1352 return new BoundedHiddenColsIterator(0, 0, true);
1357 * Return a bounded iterator over the hidden regions
1360 * position to start from (inclusive, absolute column position)
1362 * position to end at (inclusive, absolute column position)
1365 public Iterator<int[]> getBoundedIterator(int start, int end)
1367 return new BoundedHiddenColsIterator(start, end, true);
1371 * Return a bounded iterator over the *visible* start positions of hidden
1375 * position to start from (inclusive, visible column position)
1377 * position to end at (inclusive, visible column position)
1379 public Iterator<Integer> getBoundedStartIterator(int start, int end)
1381 return new BoundedStartRegionIterator(start, end, true);
1385 * Return an iterator over visible columns between the given start and end
1389 * first column (inclusive)
1391 * last column (inclusive)
1393 public Iterator<Integer> getVisibleColsIterator(int start, int end)
1395 return new VisibleColsIterator(start, end, true);
1399 * return an iterator over visible segments between the given start and end
1403 * (first column inclusive from 0)
1405 * (last column - not inclusive)
1407 public Iterator<int[]> getVisContigsIterator(int start, int end)
1409 return new VisibleContigsIterator(start, end, true);
1413 * An iterator which iterates over hidden column regions in a range.
1415 private class BoundedHiddenColsIterator implements Iterator<int[]>
1417 private int start; // start position to iterate from
1419 private int end; // end position to iterate to
1421 // current index in hiddenColumns
1422 private int currentPosition = 0;
1424 // current column in hiddenColumns
1425 private int[] currentRegion;
1427 // whether to make a local copy of hiddenColumns
1428 private final boolean useCopy;
1430 // local copy or reference to hiddenColumns
1431 private List<int[]> localHidden;
1434 * Construct an iterator over hiddenColums bounded at
1435 * [lowerBound,upperBound]
1438 * lower bound to iterate from
1440 * upper bound to iterate to
1441 * @param useCopyCols
1442 * whether to make a local copy of hiddenColumns for iteration (set
1443 * to true if calling from outwith the HiddenColumns class)
1445 BoundedHiddenColsIterator(int lowerBound, int upperBound,
1446 boolean useCopyCols)
1450 useCopy = useCopyCols;
1456 // assume that if useCopy is false the calling code has locked
1458 LOCK.readLock().lock();
1461 if (hiddenColumns != null)
1463 localHidden = new ArrayList<>();
1465 // iterate until a region overlaps with [start,end]
1467 while ((i < hiddenColumns.size())
1468 && (hiddenColumns.get(i)[1] < start))
1473 // iterate from start to end, adding each hidden region. Positions are
1474 // absolute, and all regions which *overlap* [start,end] are added.
1475 while (i < hiddenColumns.size()
1476 && (hiddenColumns.get(i)[0] <= end))
1480 rh = hiddenColumns.get(i);
1483 cp = new int[rh.length];
1484 System.arraycopy(rh, 0, cp, 0, rh.length);
1485 localHidden.add(cp);
1495 LOCK.readLock().unlock();
1501 public boolean hasNext()
1503 return (localHidden != null)
1504 && (currentPosition < localHidden.size());
1510 currentRegion = localHidden.get(currentPosition);
1512 return currentRegion;
1517 * An iterator which iterates over visible start positions of hidden column
1518 * regions in a range.
1520 private class BoundedStartRegionIterator implements Iterator<Integer>
1522 // start position to iterate from
1525 // end position to iterate to
1528 // current index in hiddenColumns
1529 private int currentPosition = 0;
1531 // local copy or reference to hiddenColumns
1532 private List<Integer> positions = null;
1535 * Construct an iterator over hiddenColums bounded at
1536 * [lowerBound,upperBound]
1539 * lower bound to iterate from
1541 * upper bound to iterate to
1542 * @param useCopyCols
1543 * whether to make a local copy of hiddenColumns for iteration (set
1544 * to true if calling from outwith the HiddenColumns class)
1546 BoundedStartRegionIterator(int lowerBound, int upperBound,
1556 // assume that if useCopy is false the calling code has locked
1558 LOCK.readLock().lock();
1561 if (hiddenColumns != null)
1563 positions = new ArrayList<>(hiddenColumns.size());
1565 // navigate to start, keeping count of hidden columns
1567 int hiddenSoFar = 0;
1568 while ((i < hiddenColumns.size())
1569 && (hiddenColumns.get(i)[0] < start + hiddenSoFar))
1571 int[] region = hiddenColumns.get(i);
1572 hiddenSoFar += region[1] - region[0] + 1;
1576 // iterate from start to end, adding start positions of each
1577 // hidden region. Positions are visible columns count, not absolute
1578 while (i < hiddenColumns.size()
1579 && (hiddenColumns.get(i)[0] <= end + hiddenSoFar))
1581 int[] region = hiddenColumns.get(i);
1582 positions.add(region[0] - hiddenSoFar);
1583 hiddenSoFar += region[1] - region[0] + 1;
1589 positions = new ArrayList<>();
1595 LOCK.readLock().unlock();
1601 public boolean hasNext()
1603 return (currentPosition < positions.size());
1607 * Get next hidden region start position
1609 * @return the start position in *visible* coordinates
1612 public Integer next()
1614 int result = positions.get(currentPosition);
1620 private class VisibleColsIterator implements Iterator<Integer>
1624 private int current;
1628 private List<int[]> localHidden = new ArrayList<>();
1630 private int lasthiddenregion;
1632 VisibleColsIterator(int firstcol, int lastcol, boolean useCopy)
1637 lasthiddenregion = -1;
1643 // assume that if useCopy is false the calling code has locked
1645 LOCK.readLock().lock();
1648 if (hiddenColumns != null)
1651 for (i = 0; i < hiddenColumns.size()
1652 && (current < hiddenColumns.get(i)[0]); ++i)
1654 if (current >= hiddenColumns.get(i)[0]
1655 && current <= hiddenColumns.get(i)[1])
1657 // current is hidden, move to right
1658 current = hiddenColumns.get(i)[1] + 1;
1663 lasthiddenregion = i - 1;
1665 for (i = hiddenColumns.size() - 1; i >= 0
1666 && (last > hiddenColumns.get(i)[1]); --i)
1668 if (last >= hiddenColumns.get(i)[0]
1669 && last <= hiddenColumns.get(i)[1])
1671 // last is hidden, move to left
1672 last = hiddenColumns.get(i)[0] - 1;
1676 // make a local copy of the bit we need
1677 i = lasthiddenregion + 1;
1678 while (i < hiddenColumns.size()
1679 && hiddenColumns.get(i)[0] <= last)
1681 int[] region = new int[] { hiddenColumns.get(i)[0],
1682 hiddenColumns.get(i)[1] };
1683 localHidden.add(region);
1686 lasthiddenregion = -1;
1692 LOCK.readLock().unlock();
1698 public boolean hasNext()
1700 return next <= last;
1704 public Integer next()
1708 throw new NoSuchElementException();
1711 if ((localHidden != null)
1712 && (lasthiddenregion + 1 < localHidden.size()))
1714 // still some more hidden regions
1715 if (next + 1 < localHidden.get(lasthiddenregion + 1)[0])
1717 // next+1 is still before the next hidden region
1720 else if ((next + 1 >= localHidden.get(lasthiddenregion + 1)[0])
1721 && (next + 1 <= localHidden.get(lasthiddenregion + 1)[1]))
1723 // next + 1 is in the next hidden region
1724 next = localHidden.get(lasthiddenregion + 1)[1] + 1;
1730 // finished with hidden regions, just increment normally
1737 public void remove()
1739 throw new UnsupportedOperationException();
1744 * An iterator which iterates over visible regions in a range.
1746 private class VisibleContigsIterator implements Iterator<int[]>
1748 private List<int[]> vcontigs = new ArrayList<>();
1750 private int currentPosition = 0;
1752 VisibleContigsIterator(int start, int end, boolean usecopy)
1758 LOCK.readLock().lock();
1761 if (hiddenColumns != null && hiddenColumns.size() > 0)
1767 for (int[] region : hiddenColumns)
1769 hideStart = region[0];
1770 hideEnd = region[1];
1772 // navigate to start
1773 if (hideEnd < vstart)
1777 if (hideStart > vstart)
1779 int[] contig = new int[] { vstart, hideStart - 1 };
1780 vcontigs.add(contig);
1782 vstart = hideEnd + 1;
1784 // exit if we're past the end
1793 int[] contig = new int[] { vstart, end - 1 };
1794 vcontigs.add(contig);
1799 int[] contig = new int[] { start, end - 1 };
1800 vcontigs.add(contig);
1806 LOCK.readLock().unlock();
1812 public boolean hasNext()
1814 return (currentPosition < vcontigs.size());
1820 int[] result = vcontigs.get(currentPosition);