X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FHiddenColumns.java;h=fb1961eca932ae4bfbf359e2841fb392e67e0f09;hb=a3c835f0495ade5c3ae7968dd9727c03710d870b;hp=169b0a4e4dca973dd5da9abd0d5ef1204243758a;hpb=834dcc21a8a324b092285c1295df9392654d526b;p=jalview.git diff --git a/src/jalview/datamodel/HiddenColumns.java b/src/jalview/datamodel/HiddenColumns.java index 169b0a4..fb1961e 100644 --- a/src/jalview/datamodel/HiddenColumns.java +++ b/src/jalview/datamodel/HiddenColumns.java @@ -20,20 +20,19 @@ */ package jalview.datamodel; -import jalview.util.Comparison; -import jalview.util.ShiftList; - import java.util.ArrayList; import java.util.BitSet; -import java.util.Collections; +import java.util.Iterator; import java.util.List; -import java.util.Vector; +import java.util.NoSuchElementException; import java.util.concurrent.locks.ReentrantReadWriteLock; public class HiddenColumns { + private static final int HASH_MULTIPLIER = 31; + private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock(); - + /* * list of hidden column [start, end] ranges; the list is maintained in * ascending start column order @@ -61,7 +60,12 @@ public class HiddenColumns { if (copy.hiddenColumns != null) { - hiddenColumns = copy.copyHiddenRegionsToArrayList(); + hiddenColumns = new ArrayList<>(); + Iterator it = copy.iterator(); + while (it.hasNext()) + { + hiddenColumns.add(it.next()); + } } } } finally @@ -71,16 +75,46 @@ public class HiddenColumns } /** - * This method is used to return all the HiddenColumn regions and is intended - * to remain private. External callers which need a copy of the regions can - * call getHiddenColumnsCopyAsList. + * Copy constructor within bounds and with offset. Copies hidden column + * regions fully contained between start and end, and offsets positions by + * subtracting offset. + * + * @param copy + * HiddenColumns instance to copy from + * @param start + * lower bound to copy from + * @param end + * upper bound to copy to + * @param offset + * offset to subtract from each region boundary position * - * @return empty list or List of hidden column intervals */ - private List getHiddenRegions() + public HiddenColumns(HiddenColumns copy, int start, int end, int offset) { - return hiddenColumns == null ? Collections. emptyList() - : hiddenColumns; + try + { + LOCK.writeLock().lock(); + if (copy != null) + { + hiddenColumns = new ArrayList<>(); + Iterator it = copy.getBoundedIterator(start, end); + while (it.hasNext()) + { + int[] region = it.next(); + // still need to check boundaries because iterator returns + // all overlapping regions and we need contained regions + if (region[0] >= start && region[1] <= end) + { + hiddenColumns.add( + new int[] + { region[0] - offset, region[1] - offset }); + } + } + } + } finally + { + LOCK.writeLock().unlock(); + } } /** @@ -99,15 +133,16 @@ public class HiddenColumns { LOCK.readLock().lock(); StringBuilder regionBuilder = new StringBuilder(); - if (hiddenColumns != null) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - for (int[] range : hiddenColumns) - { - regionBuilder.append(delimiter).append(range[0]).append(between) + int[] range = it.next(); + regionBuilder.append(delimiter).append(range[0]).append(between) .append(range[1]); + if (!it.hasNext()) + { + regionBuilder.deleteCharAt(0); } - - regionBuilder.deleteCharAt(0); } return regionBuilder.toString(); } finally @@ -127,16 +162,37 @@ public class HiddenColumns { LOCK.readLock().lock(); int size = 0; - if (hasHiddenColumns()) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - for (int[] range : hiddenColumns) - { - size += range[1] - range[0] + 1; - } + int[] range = it.next(); + size += range[1] - range[0] + 1; } + return size; + } finally + { + LOCK.readLock().unlock(); } - finally + } + + /** + * Get the number of distinct hidden regions + * + * @return number of regions + */ + public int getNumberOfRegions() + { + try + { + LOCK.readLock().lock(); + int num = 0; + if (hasHiddenColumns()) + { + num = hiddenColumns.size(); + } + return num; + } finally { LOCK.readLock().unlock(); } @@ -167,10 +223,13 @@ public class HiddenColumns { return false; } - int i = 0; - for (int[] thisRange : hiddenColumns) + + Iterator it = new RegionsIterator(); + Iterator thatit = that.iterator(); + while (it.hasNext()) { - int[] thatRange = that.hiddenColumns.get(i++); + int[] thisRange = it.next(); + int[] thatRange = thatit.next(); if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1]) { return false; @@ -196,17 +255,17 @@ public class HiddenColumns { LOCK.readLock().lock(); int result = column; - if (hiddenColumns != null) + + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - for (int i = 0; i < hiddenColumns.size(); i++) + int[] region = it.next(); + if (result >= region[0]) { - int[] region = hiddenColumns.get(i); - if (result >= region[0]) - { - result += region[1] - region[0] + 1; - } + result += region[1] - region[0] + 1; } } + return result; } finally { @@ -229,29 +288,30 @@ public class HiddenColumns { LOCK.readLock().lock(); int result = hiddenColumn; + int[] region = null; if (hiddenColumns != null) { - int index = 0; - int[] region; - do + Iterator it = new RegionsIterator(0, + hiddenColumn); + while (it.hasNext()) { - region = hiddenColumns.get(index++); + region = it.next(); if (hiddenColumn > region[1]) { result -= region[1] + 1 - region[0]; } - } while ((hiddenColumn > region[1]) - && (index < hiddenColumns.size())); + } - if (hiddenColumn >= region[0] && hiddenColumn <= region[1]) + if (region != null && hiddenColumn >= region[0] + && hiddenColumn <= region[1]) { // Here the hidden column is within a region, so // we want to return the position of region[0]-1, adjusted for any // earlier hidden columns. // Calculate the difference between the actual hidden col position // and region[0]-1, and then subtract from result to convert result - // from - // the adjusted hiddenColumn value to the adjusted region[0]-1 value + // from the adjusted hiddenColumn value to the adjusted region[0]-1 + // value. // However, if the region begins at 0 we cannot return region[0]-1 // just return 0 @@ -288,102 +348,37 @@ public class HiddenColumns { try { - LOCK.readLock().lock(); - int distance = visibleDistance; - - // in case startColumn is in a hidden region, move it to the left - int start = adjustForHiddenColumns(findColumnPosition(startColumn)); - - // get index of hidden region to left of start - int index = getHiddenIndexLeft(start); - if (index == -1) - { - // no hidden regions to left of startColumn - return start - distance; - } - - // walk backwards through the alignment subtracting the counts of visible - // columns from distance - int[] region; - int gap = 0; - int nextstart = start; - - while ((index > -1) && (distance - gap > 0)) - { - // subtract the gap to right of region from distance - distance -= gap; - start = nextstart; + int distance = visibleDistance; - // calculate the next gap - region = hiddenColumns.get(index); - gap = start - region[1]; + // in case startColumn is in a hidden region, move it to the left + int start = adjustForHiddenColumns(findColumnPosition(startColumn)); - // set start to just to left of current region - nextstart = region[0] - 1; - index--; - } - - if (distance - gap > 0) - { - // fell out of loop because there are no more hidden regions - distance -= gap; - return nextstart - distance; - } - return start - distance; - } finally - { - LOCK.readLock().unlock(); - } - - } - - /** - * Use this method to determine the set of hiddenRegion start positions - * - * @return list of column number in visible view where hidden regions start - */ - public List findHiddenRegionPositions() - { - try - { - LOCK.readLock().lock(); - List positions = null; + Iterator it = new ReverseRegionsIterator(0, start); - if (hiddenColumns != null) + while (it.hasNext() && (distance > 0)) { - positions = new ArrayList<>(hiddenColumns.size()); + int[] region = it.next(); - positions.add(hiddenColumns.get(0)[0]); - for (int i = 1; i < hiddenColumns.size(); ++i) + if (start > region[1]) { - - int result = 0; - if (hiddenColumns != null) + // subtract the gap to right of region from distance + if (start - region[1] <= distance) { - int index = 0; - int gaps = 0; - do - { - int[] region = hiddenColumns.get(index); - gaps += region[1] + 1 - region[0]; - result = region[1] + 1; - index++; - } while (index <= i); - - result -= gaps; + distance -= start - region[1]; + start = region[0] - 1; + } + else + { + start = start - distance; + distance = 0; } - positions.add(result); } } - else - { - positions = new ArrayList<>(); - } - return positions; - } - finally + return start - distance; + + } finally { LOCK.readLock().unlock(); } @@ -393,8 +388,8 @@ public class HiddenColumns * This method returns the rightmost limit of a region of an alignment with * hidden columns. In otherwords, the next hidden column. * - * @param index - * int + * @param alPos + * the (visible) alignmentPosition to find the next hidden column for */ public int getHiddenBoundaryRight(int alPos) { @@ -403,33 +398,30 @@ public class HiddenColumns LOCK.readLock().lock(); if (hiddenColumns != null) { - int index = 0; - do + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - int[] region = hiddenColumns.get(index); + int[] region = it.next(); if (alPos < region[0]) { return region[0]; } - - index++; - } while (index < hiddenColumns.size()); + } } - return alPos; } finally { LOCK.readLock().unlock(); } - } /** * This method returns the leftmost limit of a region of an alignment with * hidden columns. In otherwords, the previous hidden column. * - * @param index - * int + * @param alPos + * the (visible) alignmentPosition to find the previous hidden column + * for */ public int getHiddenBoundaryLeft(int alPos) { @@ -437,70 +429,30 @@ public class HiddenColumns { LOCK.readLock().lock(); - if (hiddenColumns != null) - { - int index = hiddenColumns.size() - 1; - do + Iterator it = new ReverseRegionsIterator(0, alPos); + while (it.hasNext()) { - int[] region = hiddenColumns.get(index); + int[] region = it.next(); if (alPos > region[1]) { return region[1]; } + } - index--; - } while (index > -1); - } - - return alPos; - } finally - { - LOCK.readLock().unlock(); - } - } - - /** - * This method returns the index of the hidden region to the left of a column - * position. If the column is in a hidden region it returns the index of the - * region to the left. If there is no hidden region to the left it returns -1. - * - * @param pos - * int - */ - private int getHiddenIndexLeft(int pos) - { - try - { - - LOCK.readLock().lock(); - if (hiddenColumns != null) - { - int index = hiddenColumns.size() - 1; - do - { - int[] region = hiddenColumns.get(index); - if (pos > region[1]) - { - return index; - } - - index--; - } while (index > -1); - } - - return -1; + return alPos; } finally { LOCK.readLock().unlock(); } - } /** - * Adds the specified column range to the hidden columns + * Adds the specified column range to the hidden columns collection * * @param start + * start of range to add (absolute position in alignment) * @param end + * end of range to add (absolute position in alignment) */ public void hideColumns(int start, int end) { @@ -524,66 +476,25 @@ public class HiddenColumns } /* - * traverse existing hidden ranges and insert / amend / append as - * appropriate + * new range follows everything else; check first to avoid looping over whole hiddenColumns collection */ - for (int i = 0; i < hiddenColumns.size(); i++) + if (hiddenColumns.isEmpty() + || start > hiddenColumns.get(hiddenColumns.size() - 1)[1]) { - int[] region = hiddenColumns.get(i); - - if (end < region[0] - 1) - { - /* - * insert discontiguous preceding range - */ - hiddenColumns.add(i, new int[] { start, end }); - return; - } - - if (end <= region[1]) - { - /* - * new range overlaps existing, or is contiguous preceding it - adjust - * start column - */ - region[0] = Math.min(region[0], start); - return; - } - - if (start <= region[1] + 1) + hiddenColumns.add(new int[] { start, end }); + } + else + { + /* + * traverse existing hidden ranges and insert / amend / append as + * appropriate + */ + boolean added = false; + for (int i = 0; !added && i < hiddenColumns.size(); i++) { - /* - * new range overlaps existing, or is contiguous following it - adjust - * start and end columns - */ - region[0] = Math.min(region[0], start); - region[1] = Math.max(region[1], end); - - /* - * also update or remove any subsequent ranges - * that are overlapped - */ - while (i < hiddenColumns.size() - 1) - { - int[] nextRegion = hiddenColumns.get(i + 1); - if (nextRegion[0] > end + 1) - { - /* - * gap to next hidden range - no more to update - */ - break; - } - region[1] = Math.max(nextRegion[1], end); - hiddenColumns.remove(i + 1); - } - return; - } - } - - /* - * remaining case is that the new range follows everything else - */ - hiddenColumns.add(new int[] { start, end }); + added = insertRangeAtRegion(i, start, end); + } // for + } } finally { if (!wasAlreadyLocked) @@ -593,69 +504,83 @@ public class HiddenColumns } } - public boolean isVisible(int column) + private boolean insertRangeAtRegion(int i, int start, int end) { - try - { - LOCK.readLock().lock(); + boolean added = false; - if (hiddenColumns != null) + int[] region = hiddenColumns.get(i); + if (end < region[0] - 1) { - for (int[] region : hiddenColumns) - { - if (column >= region[0] && column <= region[1]) - { - return false; - } - } + /* + * insert discontiguous preceding range + */ + hiddenColumns.add(i, new int[] { start, end }); + added = true; } - - return true; - } finally + else if (end <= region[1]) { - LOCK.readLock().unlock(); + /* + * new range overlaps existing, or is contiguous preceding it - adjust + * start column + */ + region[0] = Math.min(region[0], start); + added = true; } - } - - private ArrayList copyHiddenRegionsToArrayList() - { - int size = 0; - if (hiddenColumns != null) + else if (start <= region[1] + 1) { - size = hiddenColumns.size(); - } - ArrayList copy = new ArrayList<>(size); + /* + * new range overlaps existing, or is contiguous following it - adjust + * start and end columns + */ + region[0] = Math.min(region[0], start); + region[1] = Math.max(region[1], end); - for (int i = 0, j = size; i < j; i++) - { - int[] rh; - int[] cp; - rh = hiddenColumns.get(i); - if (rh != null) + /* + * also update or remove any subsequent ranges + * that are overlapped + */ + while (i < hiddenColumns.size() - 1) { - cp = new int[rh.length]; - System.arraycopy(rh, 0, cp, 0, rh.length); - copy.add(cp); + int[] nextRegion = hiddenColumns.get(i + 1); + if (nextRegion[0] > end + 1) + { + /* + * gap to next hidden range - no more to update + */ + break; + } + region[1] = Math.max(nextRegion[1], end); + hiddenColumns.remove(i + 1); } + added = true; } - - return copy; + return added; } - + /** - * Returns a copy of the vector of hidden regions, as an ArrayList. Before - * using this method please consider if you really need access to the hidden - * regions - a new (or existing!) method on HiddenColumns might be more - * appropriate. + * Answers if a column in the alignment is visible * - * @return hidden regions as an ArrayList of [start,end] pairs + * @param column + * absolute position of column in the alignment + * @return true if column is visible */ - public ArrayList getHiddenColumnsCopy() + public boolean isVisible(int column) { try { LOCK.readLock().lock(); - return copyHiddenRegionsToArrayList(); + + Iterator it = new RegionsIterator(); + while (it.hasNext()) + { + int[] region = it.next(); + if (column >= region[0] && column <= region[1]) + { + return false; + } + } + + return true; } finally { LOCK.readLock().unlock(); @@ -663,337 +588,129 @@ public class HiddenColumns } /** - * propagate shift in alignment columns to column selection + * Get the visible sections of a set of sequences * * @param start - * beginning of edit - * @param left - * shift in edit (+ve for removal, or -ve for inserts) + * sequence position to start from + * @param end + * sequence position to end at + * @param seqs + * an array of sequences + * @return an array of strings encoding the visible parts of each sequence */ - public List compensateForEdit(int start, int change, - ColumnSelection sel) + public String[] getVisibleSequenceStrings(int start, int end, + SequenceI[] seqs) { try { - LOCK.writeLock().lock(); - List deletedHiddenColumns = null; - - if (hiddenColumns != null) + LOCK.readLock().lock(); + int iSize = seqs.length; + String[] selections = new String[iSize]; + if (hiddenColumns != null && hiddenColumns.size() > 0) { - deletedHiddenColumns = new ArrayList<>(); - int hSize = hiddenColumns.size(); - for (int i = 0; i < hSize; i++) + for (int i = 0; i < iSize; i++) { - int[] region = hiddenColumns.get(i); - if (region[0] > start && start + change > region[1]) - { - deletedHiddenColumns.add(region); - - hiddenColumns.remove(i); - i--; - hSize--; - continue; - } + StringBuffer visibleSeq = new StringBuffer(); - if (region[0] > start) - { - region[0] -= change; - region[1] -= change; - } + Iterator blocks = new VisibleContigsIterator(start, + end + 1, false); - if (region[0] < 0) + while (blocks.hasNext()) { - region[0] = 0; + int[] block = blocks.next(); + if (blocks.hasNext()) + { + visibleSeq + .append(seqs[i].getSequence(block[0], block[1] + 1)); + } + else + { + visibleSeq + .append(seqs[i].getSequence(block[0], block[1])); + } } + selections[i] = visibleSeq.toString(); + } + } + else + { + for (int i = 0; i < iSize; i++) + { + selections[i] = seqs[i].getSequenceAsString(start, end); } - - this.revealHiddenColumns(0, sel); } - return deletedHiddenColumns; + return selections; } finally { - LOCK.writeLock().unlock(); + LOCK.readLock().unlock(); } } /** - * propagate shift in alignment columns to column selection special version of - * compensateForEdit - allowing for edits within hidden regions + * Locate the first position visible for this sequence. If seq isn't visible + * then return the position of the left side of the hidden boundary region. * - * @param start - * beginning of edit - * @param left - * shift in edit (+ve for removal, or -ve for inserts) + * @param seq + * sequence to find position for + * @return visible start position */ - public void compensateForDelEdits(int start, int change) + public int locateVisibleStartOfSequence(SequenceI seq) { try { - LOCK.writeLock().lock(); - if (hiddenColumns != null) + LOCK.readLock().lock(); + int start = 0; + + if (hiddenColumns == null || hiddenColumns.size() == 0) { - for (int i = 0; i < hiddenColumns.size(); i++) - { - int[] region = hiddenColumns.get(i); - if (region[0] >= start) - { - region[0] -= change; - } - if (region[1] >= start) - { - region[1] -= change; - } - if (region[1] < region[0]) - { - hiddenColumns.remove(i--); - } + return seq.findIndex(seq.getStart()) - 1; + } - if (region[0] < 0) - { - region[0] = 0; - } - if (region[1] < 0) - { - region[1] = 0; - } - } - } - } - finally - { - LOCK.writeLock().unlock(); - } - } + // Simply walk along the sequence whilst watching for hidden column + // boundaries + Iterator regions = new RegionsIterator(); + int hideStart = seq.getLength(); + int hideEnd = -1; + int visPrev = 0; + int visNext = 0; + boolean foundStart = false; - /** - * return all visible segments between the given start and end boundaries - * - * @param start - * (first column inclusive from 0) - * @param end - * (last column - not inclusive) - * @return int[] {i_start, i_end, ..} where intervals lie in - * start<=i_start<=i_end 0) + // step through the non-gapped positions of the sequence + for (int i = seq.getStart(); i <= seq.getEnd() && (!foundStart); i++) { - List visiblecontigs = new ArrayList<>(); - List regions = getHiddenRegions(); + // get alignment position of this residue in the sequence + int p = seq.findIndex(i) - 1; - int vstart = start; - int[] region; - int hideStart; - int hideEnd; - - for (int j = 0; vstart < end && j < regions.size(); j++) + // update hidden region start/end + while (hideEnd < p && regions.hasNext()) { - region = regions.get(j); + int[] region = regions.next(); + visPrev = visNext; + visNext += region[0] - visPrev; hideStart = region[0]; hideEnd = region[1]; - - if (hideEnd < vstart) - { - continue; - } - if (hideStart > vstart) - { - visiblecontigs.add(new int[] { vstart, hideStart - 1 }); - } - vstart = hideEnd + 1; } - - if (vstart < end) - { - visiblecontigs.add(new int[] { vstart, end - 1 }); - } - int[] vcontigs = new int[visiblecontigs.size() * 2]; - for (int i = 0, j = visiblecontigs.size(); i < j; i++) - { - int[] vc = visiblecontigs.get(i); - visiblecontigs.set(i, null); - vcontigs[i * 2] = vc[0]; - vcontigs[i * 2 + 1] = vc[1]; - } - visiblecontigs.clear(); - return vcontigs; - } - else - { - return new int[] { start, end - 1 }; - } - } - finally - { - LOCK.readLock().unlock(); - } - } - - public String[] getVisibleSequenceStrings(int start, int end, - SequenceI[] seqs) - { - try - { - LOCK.readLock().lock(); - int iSize = seqs.length; - String[] selections = new String[iSize]; - if (hiddenColumns != null && hiddenColumns.size() > 0) - { - for (int i = 0; i < iSize; i++) + if (hideEnd < p) { - StringBuffer visibleSeq = new StringBuffer(); - List regions = getHiddenRegions(); - - int blockStart = start; - int blockEnd = end; - int[] region; - int hideStart; - int hideEnd; - - for (int j = 0; j < regions.size(); j++) - { - region = regions.get(j); - hideStart = region[0]; - hideEnd = region[1]; - - if (hideStart < start) - { - continue; - } - - blockStart = Math.min(blockStart, hideEnd + 1); - blockEnd = Math.min(blockEnd, hideStart); - - if (blockStart > blockEnd) - { - break; - } - - visibleSeq.append(seqs[i].getSequence(blockStart, blockEnd)); - - blockStart = hideEnd + 1; - blockEnd = end; - } - - if (end > blockStart) - { - visibleSeq.append(seqs[i].getSequence(blockStart, end)); - } - - selections[i] = visibleSeq.toString(); + hideStart = seq.getLength(); } - } - else - { - for (int i = 0; i < iSize; i++) + // update visible boundary for sequence + if (p < hideStart) { - selections[i] = seqs[i].getSequenceAsString(start, end); + start = p; + foundStart = true; } } - return selections; - } - finally - { - LOCK.readLock().unlock(); - } - } - - /** - * Locate the first and last position visible for this sequence. if seq isn't - * visible then return the position of the left and right of the hidden - * boundary region, and the corresponding alignment column indices for the - * extent of the sequence - * - * @param seq - * @return int[] { visible start, visible end, first seqpos, last seqpos, - * alignment index for seq start, alignment index for seq end } - */ - public int[] locateVisibleBoundsOfSequence(SequenceI seq) - { - try - { - LOCK.readLock().lock(); - int fpos = seq.getStart(); - int lpos = seq.getEnd(); - int start = 0; - - if (hiddenColumns == null || hiddenColumns.size() == 0) - { - int ifpos = seq.findIndex(fpos) - 1; - int ilpos = seq.findIndex(lpos) - 1; - return new int[] { ifpos, ilpos, fpos, lpos, ifpos, ilpos }; - } - - // Simply walk along the sequence whilst watching for hidden column - // boundaries - List regions = getHiddenRegions(); - int spos = fpos; - int lastvispos = -1; - int rcount = 0; - int hideStart = seq.getLength(); - int hideEnd = -1; - int visPrev = 0; - int visNext = 0; - int firstP = -1; - int lastP = -1; - boolean foundStart = false; - for (int p = 0, pLen = seq.getLength(); spos <= seq.getEnd() - && p < pLen; p++) - { - if (!Comparison.isGap(seq.getCharAt(p))) - { - // keep track of first/last column - // containing sequence data regardless of visibility - if (firstP == -1) - { - firstP = p; - } - lastP = p; - // update hidden region start/end - while (hideEnd < p && rcount < regions.size()) - { - int[] region = regions.get(rcount++); - visPrev = visNext; - visNext += region[0] - visPrev; - hideStart = region[0]; - hideEnd = region[1]; - } - if (hideEnd < p) - { - hideStart = seq.getLength(); - } - // update visible boundary for sequence - if (p < hideStart) - { - if (!foundStart) - { - fpos = spos; - start = p; - foundStart = true; - } - lastvispos = p; - lpos = spos; - } - // look for next sequence position - spos++; - } - } if (foundStart) { - return new int[] { findColumnPosition(start), - findColumnPosition(lastvispos), fpos, lpos, firstP, lastP }; + return findColumnPosition(start); } // otherwise, sequence was completely hidden - return new int[] { visPrev, visNext, 0, 0, firstP, lastP }; - } - finally + return visPrev; + } finally { LOCK.readLock().unlock(); } @@ -1007,7 +724,8 @@ public class HiddenColumns */ public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation) { - makeVisibleAnnotation(-1, -1, alignmentAnnotation); + makeVisibleAnnotation(0, alignmentAnnotation.annotations.length, + alignmentAnnotation); } /** @@ -1027,97 +745,83 @@ public class HiddenColumns try { LOCK.readLock().lock(); - if (alignmentAnnotation.annotations == null) - { - return; - } - if (start == end && end == -1) - { - start = 0; - end = alignmentAnnotation.annotations.length; - } - if (hiddenColumns != null && hiddenColumns.size() > 0) - { - // then mangle the alignmentAnnotation annotation array - Vector annels = new Vector<>(); - Annotation[] els = null; - List regions = getHiddenRegions(); - int blockStart = start; - int blockEnd = end; - int[] region; - int hideStart; - int hideEnd; - int w = 0; - - for (int j = 0; j < regions.size(); j++) - { - region = regions.get(j); - hideStart = region[0]; - hideEnd = region[1]; - - if (hideStart < start) - { - continue; - } - - blockStart = Math.min(blockStart, hideEnd + 1); - blockEnd = Math.min(blockEnd, hideStart); - - if (blockStart > blockEnd) - { - break; - } - annels.addElement(els = new Annotation[blockEnd - blockStart]); - System.arraycopy(alignmentAnnotation.annotations, blockStart, els, - 0, els.length); - w += els.length; - blockStart = hideEnd + 1; - blockEnd = end; - } + int startFrom = start; + int endAt = end; - if (end > blockStart) + if (alignmentAnnotation.annotations != null) + { + if (hiddenColumns != null && hiddenColumns.size() > 0) { - annels.addElement(els = new Annotation[end - blockStart + 1]); - if ((els.length - + blockStart) <= alignmentAnnotation.annotations.length) - { - // copy just the visible segment of the annotation row - System.arraycopy(alignmentAnnotation.annotations, blockStart, - els, 0, els.length); - } - else - { - // copy to the end of the annotation row - System.arraycopy(alignmentAnnotation.annotations, blockStart, - els, 0, - (alignmentAnnotation.annotations.length - blockStart)); - } - w += els.length; + removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation); } - if (w == 0) + else { - return; + alignmentAnnotation.restrict(startFrom, endAt); } + } + } finally + { + LOCK.readLock().unlock(); + } + } - alignmentAnnotation.annotations = new Annotation[w]; - w = 0; - - for (Annotation[] chnk : annels) - { - System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w, - chnk.length); - w += chnk.length; - } + private void removeHiddenAnnotation(int start, int end, + AlignmentAnnotation alignmentAnnotation) + { + // mangle the alignmentAnnotation annotation array + ArrayList annels = new ArrayList<>(); + Annotation[] els = null; + + int w = 0; + + Iterator blocks = new VisibleContigsIterator(start, end + 1, + false); + + int copylength; + int annotationLength; + while (blocks.hasNext()) + { + int[] block = blocks.next(); + annotationLength = block[1] - block[0] + 1; + + if (blocks.hasNext()) + { + // copy just the visible segment of the annotation row + copylength = annotationLength; } else { - alignmentAnnotation.restrict(start, end); + if (annotationLength + block[0] <= alignmentAnnotation.annotations.length) + { + // copy just the visible segment of the annotation row + copylength = annotationLength; + } + else + { + // copy to the end of the annotation row + copylength = alignmentAnnotation.annotations.length - block[0]; + } } + + els = new Annotation[annotationLength]; + annels.add(els); + System.arraycopy(alignmentAnnotation.annotations, block[0], els, 0, + copylength); + w += annotationLength; } - finally + + if (w != 0) { - LOCK.readLock().unlock(); + alignmentAnnotation.annotations = new Annotation[w]; + + w = 0; + for (Annotation[] chnk : annels) + { + System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w, + chnk.length); + w += chnk.length; + } } } @@ -1183,21 +887,18 @@ public class HiddenColumns try { LOCK.writeLock().lock(); - if (hiddenColumns != null) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - for (int i = 0; i < hiddenColumns.size(); i++) + int[] region = it.next(); + for (int j = region[0]; j < region[1] + 1; j++) { - int[] region = hiddenColumns.get(i); - for (int j = region[0]; j < region[1] + 1; j++) - { - sel.addElement(j); - } + sel.addElement(j); } } hiddenColumns = null; - } - finally + } finally { LOCK.writeLock().unlock(); } @@ -1214,9 +915,10 @@ public class HiddenColumns try { LOCK.writeLock().lock(); - for (int i = 0; i < hiddenColumns.size(); i++) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - int[] region = hiddenColumns.get(i); + int[] region = it.next(); if (start == region[0]) { for (int j = region[0]; j < region[1] + 1; j++) @@ -1227,138 +929,17 @@ public class HiddenColumns hiddenColumns.remove(region); break; } - } - if (hiddenColumns.size() == 0) - { - hiddenColumns = null; - } - } - finally - { - LOCK.writeLock().unlock(); - } - } - - /** - * removes intersection of position,length ranges in deletions from the - * start,end regions marked in intervals. - * - * @param shifts - * @param intervals - * @return - */ - private boolean pruneIntervalList(final List shifts, - ArrayList intervals) - { - boolean pruned = false; - int i = 0; - int j = intervals.size() - 1; - int s = 0; - int t = shifts.size() - 1; - int[] hr = intervals.get(i); - int[] sr = shifts.get(s); - while (i <= j && s <= t) - { - boolean trailinghn = hr[1] >= sr[0]; - if (!trailinghn) - { - if (i < j) - { - hr = intervals.get(++i); - } - else - { - i++; - } - continue; - } - int endshift = sr[0] + sr[1]; // deletion ranges - -ve means an insert - if (endshift < hr[0] || endshift < sr[0]) - { // leadinghc disjoint or not a deletion - if (s < t) - { - sr = shifts.get(++s); - } - else - { - s++; - } - continue; - } - boolean leadinghn = hr[0] >= sr[0]; - boolean leadinghc = hr[0] < endshift; - boolean trailinghc = hr[1] < endshift; - if (leadinghn) - { - if (trailinghc) - { // deleted hidden region. - intervals.remove(i); - pruned = true; - j--; - if (i <= j) - { - hr = intervals.get(i); - } - continue; - } - if (leadinghc) - { - hr[0] = endshift; // clip c terminal region - leadinghn = !leadinghn; - pruned = true; - } - } - if (!leadinghn) - { - if (trailinghc) - { - if (trailinghn) - { - hr[1] = sr[0] - 1; - pruned = true; - } - } - else + else if (start < region[0]) { - // sr contained in hr - if (s < t) - { - sr = shifts.get(++s); - } - else - { - s++; - } - continue; + break; // passed all possible matching regions } } - } - return pruned; // true if any interval was removed or modified by - // operations. - } - /** - * remove any hiddenColumns or selected columns and shift remaining based on a - * series of position, range deletions. - * - * @param deletions - */ - public void pruneDeletions(List shifts) - { - try - { - LOCK.writeLock().lock(); - // delete any intervals intersecting. - if (hiddenColumns != null) + if (hiddenColumns.size() == 0) { - pruneIntervalList(shifts, hiddenColumns); - if (hiddenColumns != null && hiddenColumns.size() == 0) - { - hiddenColumns = null; - } + hiddenColumns = null; } - } - finally + } finally { LOCK.writeLock().unlock(); } @@ -1403,154 +984,124 @@ public class HiddenColumns private void propagateInsertions(SequenceI profileseq, AlignmentI al, SequenceI origseq) { - char gc = al.getGapCharacter(); - // recover mapping between sequence's non-gap positions and positions - // mapping to view. - pruneDeletions(ShiftList.parseMap(origseq.gapMap())); - int[] viscontigs = getVisibleContigs(0, profileseq.getLength()); - int spos = 0; - int offset = 0; - - // add profile to visible contigs - for (int v = 0; v < viscontigs.length; v += 2) + try { - if (viscontigs[v] > spos) - { - StringBuffer sb = new StringBuffer(); - for (int s = 0, ns = viscontigs[v] - spos; s < ns; s++) - { - sb.append(gc); - } - for (int s = 0, ns = al.getHeight(); s < ns; s++) - { - SequenceI sqobj = al.getSequenceAt(s); - if (sqobj != profileseq) - { - String sq = al.getSequenceAt(s).getSequenceAsString(); - if (sq.length() <= spos + offset) - { - // pad sequence - int diff = spos + offset - sq.length() - 1; - if (diff > 0) - { - // pad gaps - sq = sq + sb; - while ((diff = spos + offset - sq.length() - 1) > 0) - { - // sq = sq - // + ((diff >= sb.length()) ? sb.toString() : sb - // .substring(0, diff)); - if (diff >= sb.length()) - { - sq += sb.toString(); - } - else - { - char[] buf = new char[diff]; - sb.getChars(0, diff, buf, 0); - sq += buf.toString(); - } - } - } - sq += sb.toString(); - } - else - { - al.getSequenceAt(s).setSequence( - sq.substring(0, spos + offset) + sb.toString() - + sq.substring(spos + offset)); - } - } - } - // offset+=sb.length(); - } - spos = viscontigs[v + 1] + 1; - } - if ((offset + spos) < profileseq.getLength()) - { - // pad the final region with gaps. - StringBuffer sb = new StringBuffer(); - for (int s = 0, ns = profileseq.getLength() - spos - offset; s < ns; s++) - { - sb.append(gc); - } - for (int s = 0, ns = al.getHeight(); s < ns; s++) + LOCK.writeLock().lock(); + + char gc = al.getGapCharacter(); + + // take the set of hidden columns, and the set of gaps in origseq, + // and remove all the hidden gaps from hiddenColumns + + // first get the gaps as a Bitset + BitSet gaps = origseq.gapBitset(); + + // now calculate hidden ^ not(gap) + BitSet hidden = new BitSet(); + markHiddenRegions(hidden); + hidden.andNot(gaps); + hiddenColumns = null; + this.hideMarkedBits(hidden); + + // for each sequence in the alignment, except the profile sequence, + // insert gaps corresponding to each hidden region + // but where each hidden column region is shifted backwards by the number + // of + // preceding visible gaps + // update hidden columns at the same time + Iterator regions = new RegionsIterator(); + ArrayList newhidden = new ArrayList<>(); + + int numGapsBefore = 0; + int gapPosition = 0; + while (regions.hasNext()) { - SequenceI sqobj = al.getSequenceAt(s); - if (sqobj == profileseq) + // get region coordinates accounting for gaps + // we can rely on gaps not being *in* hidden regions because we already + // removed those + int[] region = regions.next(); + while (gapPosition < region[0]) { - continue; - } - String sq = sqobj.getSequenceAsString(); - // pad sequence - int diff = origseq.getLength() - sq.length(); - while (diff > 0) - { - // sq = sq - // + ((diff >= sb.length()) ? sb.toString() : sb - // .substring(0, diff)); - if (diff >= sb.length()) + gapPosition++; + if (gaps.get(gapPosition)) { - sq += sb.toString(); + numGapsBefore++; } - else - { - char[] buf = new char[diff]; - sb.getChars(0, diff, buf, 0); - sq += buf.toString(); - } - diff = origseq.getLength() - sq.length(); } - } - } - } - /** - * remove any hiddenColumns or selected columns and shift remaining based on a - * series of position, range deletions. - * - * @param deletions - */ - private void pruneDeletions(ShiftList deletions) - { - if (deletions != null) - { - final List shifts = deletions.getShifts(); - if (shifts != null && shifts.size() > 0) - { - pruneDeletions(shifts); + int left = region[0] - numGapsBefore; + int right = region[1] - numGapsBefore; + newhidden.add(new int[] { left, right }); + + // make a string with number of gaps = length of hidden region + StringBuffer sb = new StringBuffer(); + for (int s = 0; s < right - left + 1; s++) + { + sb.append(gc); + } + padGaps(sb, left, profileseq, al); - // and shift the rest. - this.compensateForEdits(deletions); } + hiddenColumns = newhidden; + } finally + { + LOCK.writeLock().unlock(); } } /** - * Adjust hidden column boundaries based on a series of column additions or - * deletions in visible regions. + * Pad gaps in all sequences in alignment except profileseq * - * @param shiftrecord - * @return + * @param sb + * gap string to insert + * @param left + * position to insert at + * @param profileseq + * sequence not to pad + * @param al + * alignment to pad sequences in */ - private ShiftList compensateForEdits(ShiftList shiftrecord) + private void padGaps(StringBuffer sb, int pos, SequenceI profileseq, + AlignmentI al) { - if (shiftrecord != null) + // loop over the sequences and pad with gaps where required + for (int s = 0, ns = al.getHeight(); s < ns; s++) { - final List shifts = shiftrecord.getShifts(); - if (shifts != null && shifts.size() > 0) + SequenceI sqobj = al.getSequenceAt(s); + if (sqobj != profileseq) { - int shifted = 0; - for (int i = 0, j = shifts.size(); i < j; i++) + String sq = al.getSequenceAt(s).getSequenceAsString(); + if (sq.length() <= pos) + { + // pad sequence + int diff = pos - sq.length() - 1; + if (diff > 0) + { + // pad gaps + sq = sq + sb; + while ((diff = pos - sq.length() - 1) > 0) + { + if (diff >= sb.length()) + { + sq += sb.toString(); + } + else + { + char[] buf = new char[diff]; + sb.getChars(0, diff, buf, 0); + sq += buf.toString(); + } + } + } + sq += sb.toString(); + } + else { - int[] sh = shifts.get(i); - compensateForDelEdits(shifted + sh[0], sh[1]); - shifted -= sh[1]; + al.getSequenceAt(s).setSequence( + sq.substring(0, pos) + sb.toString() + sq.substring(pos)); } } - return shiftrecord.getInverse(); } - return null; } /** @@ -1563,17 +1114,15 @@ public class HiddenColumns { LOCK.readLock().lock(); int hashCode = 1; - if (hiddenColumns != null) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - for (int[] hidden : hiddenColumns) - { - hashCode = 31 * hashCode + hidden[0]; - hashCode = 31 * hashCode + hidden[1]; - } + int[] hidden = it.next(); + hashCode = HASH_MULTIPLIER * hashCode + hidden[0]; + hashCode = HASH_MULTIPLIER * hashCode + hidden[1]; } return hashCode; - } - finally + } finally { LOCK.readLock().unlock(); } @@ -1617,12 +1166,13 @@ public class HiddenColumns { return; } - for (int[] range : hiddenColumns) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { + int[] range = it.next(); inserts.set(range[0], range[1] + 1); } - } - finally + } finally { LOCK.readLock().unlock(); } @@ -1652,10 +1202,12 @@ public class HiddenColumns return new int[] { startPos, endPos }; } - for (int[] hiddenCol : hiddenColumns) + Iterator it = new RegionsIterator(); + while (it.hasNext()) { - lowestRange = (hiddenCol[0] <= startPos) ? hiddenCol : lowestRange; - higestRange = (hiddenCol[1] >= endPos) ? hiddenCol : higestRange; + int[] range = it.next(); + lowestRange = (range[0] <= startPos) ? range : lowestRange; + higestRange = (range[1] >= endPos) ? range : higestRange; } if (lowestRange[0] == -1 && lowestRange[1] == -1) @@ -1698,22 +1250,849 @@ public class HiddenColumns int adjres = adjustForHiddenColumns(res); int[] reveal = null; + Iterator it = new RegionsIterator(adjres - 2, + adjres + 2); + while (it.hasNext()) + { + int[] region = it.next(); + if (adjres + 1 == region[0] || adjres - 1 == region[1]) + { + reveal = region; + break; + } + } + return reveal; + } finally + { + LOCK.readLock().unlock(); + } + } + + /** + * Return an iterator over the hidden regions + */ + public Iterator iterator() + { + return new BoundedHiddenColsIterator(); + } + + /** + * Return a bounded iterator over the hidden regions + * + * @param start + * position to start from (inclusive, absolute column position) + * @param end + * position to end at (inclusive, absolute column position) + * @return + */ + public Iterator getBoundedIterator(int start, int end) + { + return new BoundedHiddenColsIterator(start, end); + } + + /** + * Return a bounded iterator over the *visible* start positions of hidden + * regions + * + * @param start + * position to start from (inclusive, visible column position) + * @param end + * position to end at (inclusive, visible column position) + */ + public Iterator getBoundedStartIterator(int start, int end) + { + return new BoundedStartRegionIterator(start, end, true); + } + + /** + * Return an iterator over visible *columns* (not regions) between the given + * start and end boundaries + * + * @param start + * first column (inclusive) + * @param end + * last column (inclusive) + */ + public Iterator getVisibleColsIterator(int start, int end) + { + return new VisibleColsIterator(start, end); + } + + /** + * return an iterator over visible segments between the given start and end + * boundaries + * + * @param start + * (first column inclusive from 0) + * @param end + * (last column - not inclusive) + */ + public Iterator getVisContigsIterator(int start, int end) + { + // return new VisibleBlocksIterator(start, end, true) + return new VisibleContigsIterator(start, end, true); + } + + /** + * return an iterator over visible segments between the given start and end + * boundaries + * + * @param start + * (first column - inclusive from 0) + * @param end + * (last column - inclusive) + * @param useVisibleCoords + * if true, start and end are visible column positions, not absolute + * positions + */ + public Iterator getVisibleBlocksIterator(int start, int end, + boolean useVisibleCoords) + { + if (useVisibleCoords) + { + // TODO + // we should really just convert start and end here with + // adjustForHiddenColumns + // and then create a VisibleContigsIterator + // but without a cursor this will be horribly slow in some situations + // ... so until then... + return new VisibleBlocksVisBoundsIterator(start, end, true); + } + else + { + return new VisibleContigsIterator(start, end - 1, true); + } + } + + /** + * A local iterator which iterates over hidden column regions in a range. + * Intended for use ONLY within the HiddenColumns class, because it works + * directly with the hiddenColumns collection without locking (callers should + * lock hiddenColumns). + */ + private class RegionsIterator implements Iterator + { + // start position to iterate from + private int start; + + // end position to iterate to + private int end; + + // current index in hiddenColumns + private int currentPosition = 0; + + // current column in hiddenColumns + private int[] nextRegion = null; + + // Constructor with bounds + RegionsIterator(int lowerBound, int upperBound) + { + init(lowerBound, upperBound); + } + + // Unbounded constructor + RegionsIterator() + { if (hiddenColumns != null) { - for (int[] region : hiddenColumns) + // iterator over full hiddenColumns collection + int last = hiddenColumns.get(hiddenColumns.size() - 1)[1]; + init(0, last); + } + else + { + // empty iterator + init(0, 0); + } + } + + /** + * Construct an iterator over hiddenColums bounded at + * [lowerBound,upperBound] + * + * @param lowerBound + * lower bound to iterate from + * @param upperBound + * upper bound to iterate to + */ + private void init(int lowerBound, int upperBound) + { + start = lowerBound; + end = upperBound; + + if (hiddenColumns != null) + { + // iterate until a region overlaps with [start,end] + currentPosition = 0; + while ((currentPosition < hiddenColumns.size()) + && (hiddenColumns.get(currentPosition)[1] < start)) + { + currentPosition++; + } + if (currentPosition < hiddenColumns.size()) { - if (adjres + 1 == region[0] || adjres - 1 == region[1]) + nextRegion = hiddenColumns.get(currentPosition); + } + } + } + + @Override + public boolean hasNext() + { + return (hiddenColumns != null) && (nextRegion != null) + && (nextRegion[0] <= end); + } + + @Override + public int[] next() + { + int[] region = nextRegion; + currentPosition++; + if (currentPosition < hiddenColumns.size()) + { + nextRegion = hiddenColumns.get(currentPosition); + } + else + { + nextRegion = null; + } + return region; + } + + } + + /** + * A local iterator which reverse iterates over hidden column regions in a + * range. Intended for use ONLY within the HiddenColumns class, because it + * works directly with the hiddenColumns collection without locking (callers + * should lock hiddenColumns). + */ + private class ReverseRegionsIterator implements Iterator + { + // start position to iterate to + private int start; + + // end position to iterate from + private int end; + + // current index in hiddenColumns + private int currentPosition = 0; + + // current column in hiddenColumns + private int[] nextRegion = null; + + // Constructor with bounds + ReverseRegionsIterator(int lowerBound, int upperBound) + { + init(lowerBound, upperBound); + } + + /** + * Construct an iterator over hiddenColums bounded at + * [lowerBound,upperBound] + * + * @param lowerBound + * lower bound to iterate to + * @param upperBound + * upper bound to iterate from + */ + private void init(int lowerBound, int upperBound) + { + start = lowerBound; + end = upperBound; + + if (hiddenColumns != null) + { + // iterate until a region overlaps with [start,end] + currentPosition = hiddenColumns.size() - 1; + while (currentPosition >= 0 + && hiddenColumns.get(currentPosition)[1] > end) + { + currentPosition--; + } + if (currentPosition >= 0) + { + nextRegion = hiddenColumns.get(currentPosition); + } + } + } + + @Override + public boolean hasNext() + { + return (hiddenColumns != null) && (nextRegion != null) + && (nextRegion[1] >= start); + } + + @Override + public int[] next() + { + int[] region = nextRegion; + currentPosition--; + if (currentPosition >= 0) + { + nextRegion = hiddenColumns.get(currentPosition); + } + else + { + nextRegion = null; + } + return region; + } + + } + + /** + * An iterator which iterates over hidden column regions in a range. Works + * with a copy of the hidden columns collection. Intended to be used by + * callers OUTSIDE of HiddenColumns. + */ + private class BoundedHiddenColsIterator implements Iterator + { + // start position to iterate from + private int start; + + // end position to iterate to + private int end; + + // current index in hiddenColumns + private int currentPosition = 0; + + // current column in hiddenColumns + private int[] currentRegion; + + // local copy or reference to hiddenColumns + private List localHidden; + + /** + * Unbounded constructor + */ + BoundedHiddenColsIterator() + { + if (hiddenColumns != null) + { + int last = hiddenColumns.get(hiddenColumns.size() - 1)[1]; + init(0, last); + } + else + { + init(0, 0); + } + } + + /** + * Construct an iterator over hiddenColums bounded at + * [lowerBound,upperBound] + * + * @param lowerBound + * lower bound to iterate from + * @param upperBound + * upper bound to iterate to + */ + BoundedHiddenColsIterator(int lowerBound, int upperBound) + { + init(lowerBound, upperBound); + } + + /** + * Construct an iterator over hiddenColums bounded at + * [lowerBound,upperBound] + * + * @param lowerBound + * lower bound to iterate from + * @param upperBound + * upper bound to iterate to + */ + private void init(int lowerBound, int upperBound) + { + start = lowerBound; + end = upperBound; + + try + { + LOCK.readLock().lock(); + + if (hiddenColumns != null) + { + localHidden = new ArrayList<>(); + + // iterate until a region overlaps with [start,end] + int i = 0; + while ((i < hiddenColumns.size()) + && (hiddenColumns.get(i)[1] < start)) { - reveal = region; - break; + i++; + } + + // iterate from start to end, adding each hidden region. Positions are + // absolute, and all regions which *overlap* [start,end] are added. + while (i < hiddenColumns.size() + && (hiddenColumns.get(i)[0] <= end)) + { + int[] rh = hiddenColumns.get(i); + int[] cp = new int[2]; + System.arraycopy(rh, 0, cp, 0, rh.length); + localHidden.add(cp); + i++; } } } - return reveal; - } finally + finally + { + LOCK.readLock().unlock(); + } + } + + @Override + public boolean hasNext() + { + return (localHidden != null) + && (currentPosition < localHidden.size()); + } + + @Override + public int[] next() { + currentRegion = localHidden.get(currentPosition); + currentPosition++; + return currentRegion; + } + } + + /** + * An iterator which iterates over visible start positions of hidden column + * regions in a range. + */ + private class BoundedStartRegionIterator implements Iterator + { + // start position to iterate from + private int start; + + // end position to iterate to + private int end; + + // current index in hiddenColumns + private int currentPosition = 0; + + // local copy or reference to hiddenColumns + private List positions = null; + + /** + * Construct an iterator over hiddenColums bounded at + * [lowerBound,upperBound] + * + * @param lowerBound + * lower bound to iterate from + * @param upperBound + * upper bound to iterate to + * @param useCopyCols + * whether to make a local copy of hiddenColumns for iteration (set + * to true if calling from outwith the HiddenColumns class) + */ + BoundedStartRegionIterator(int lowerBound, int upperBound, + boolean useCopy) + { + start = lowerBound; + end = upperBound; + + try + { + if (useCopy) + { + // assume that if useCopy is false the calling code has locked + // hiddenColumns + LOCK.readLock().lock(); + } + + if (hiddenColumns != null) + { + positions = new ArrayList<>(hiddenColumns.size()); + + // navigate to start, keeping count of hidden columns + int i = 0; + int hiddenSoFar = 0; + while ((i < hiddenColumns.size()) + && (hiddenColumns.get(i)[0] < start + hiddenSoFar)) + { + int[] region = hiddenColumns.get(i); + hiddenSoFar += region[1] - region[0] + 1; + i++; + } + + // iterate from start to end, adding start positions of each + // hidden region. Positions are visible columns count, not absolute + while (i < hiddenColumns.size() + && (hiddenColumns.get(i)[0] <= end + hiddenSoFar)) + { + int[] region = hiddenColumns.get(i); + positions.add(region[0] - hiddenSoFar); + hiddenSoFar += region[1] - region[0] + 1; + i++; + } + } + else + { + positions = new ArrayList<>(); + } + } finally + { + if (useCopy) + { + LOCK.readLock().unlock(); + } + } + } + + @Override + public boolean hasNext() + { + return (currentPosition < positions.size()); + } + + /** + * Get next hidden region start position + * + * @return the start position in *visible* coordinates + */ + @Override + public Integer next() + { + int result = positions.get(currentPosition); + currentPosition++; + return result; + } + } + + /** + * Iterator over the visible *columns* (not regions) as determined by the set + * of hidden columns. Uses a local copy of hidden columns. + * + * @author kmourao + * + */ + private class VisibleColsIterator implements Iterator + { + private int last; + + private int current; + + private int next; + + private List localHidden = new ArrayList<>(); + + private int nexthiddenregion; + + VisibleColsIterator(int firstcol, int lastcol) + { + last = lastcol; + current = firstcol; + next = firstcol; + nexthiddenregion = 0; + + LOCK.readLock().lock(); + + if (hiddenColumns != null) + { + int i = 0; + for (i = 0; i < hiddenColumns.size() + && (current <= hiddenColumns.get(i)[0]); ++i) + { + if (current >= hiddenColumns.get(i)[0] + && current <= hiddenColumns.get(i)[1]) + { + // current is hidden, move to right + current = hiddenColumns.get(i)[1] + 1; + next = current; + nexthiddenregion = i + 1; + } + } + + for (i = hiddenColumns.size() - 1; i >= 0 + && (last >= hiddenColumns.get(i)[1]); --i) + { + if (last >= hiddenColumns.get(i)[0] + && last <= hiddenColumns.get(i)[1]) + { + // last is hidden, move to left + last = hiddenColumns.get(i)[0] - 1; + } + } + + // make a local copy of the bit we need + i = nexthiddenregion; + while (i < hiddenColumns.size() && hiddenColumns.get(i)[0] <= last) + { + int[] region = new int[] { hiddenColumns.get(i)[0], + hiddenColumns.get(i)[1] }; + localHidden.add(region); + i++; + } + } + LOCK.readLock().unlock(); } + + @Override + public boolean hasNext() + { + return next <= last; + } + + @Override + public Integer next() + { + if (next > last) + { + throw new NoSuchElementException(); + } + current = next; + if ((localHidden != null) + && (nexthiddenregion < localHidden.size())) + { + // still some more hidden regions + if (next + 1 < localHidden.get(nexthiddenregion)[0]) + { + // next+1 is still before the next hidden region + next++; + } + else if ((next + 1 >= localHidden.get(nexthiddenregion)[0]) + && (next + 1 <= localHidden.get(nexthiddenregion)[1])) + { + // next + 1 is in the next hidden region + next = localHidden.get(nexthiddenregion)[1] + 1; + nexthiddenregion++; + } + } + else + { + // finished with hidden regions, just increment normally + next++; + } + return current; + } + + @Override + public void remove() + { + throw new UnsupportedOperationException(); + } } + /** + * An iterator which iterates over visible regions in a range. + */ + private class VisibleContigsIterator implements Iterator + { + private List vcontigs = new ArrayList<>(); + + private int currentPosition = 0; + + VisibleContigsIterator(int start, int end, boolean usecopy) + { + try + { + if (usecopy) + { + LOCK.readLock().lock(); + } + + if (hiddenColumns != null && hiddenColumns.size() > 0) + { + int vstart = start; + int hideStart; + int hideEnd; + + for (int[] region : hiddenColumns) + { + hideStart = region[0]; + hideEnd = region[1]; + + // navigate to start + if (hideEnd < vstart) + { + continue; + } + if (hideStart > vstart) + { + int[] contig = new int[] { vstart, hideStart - 1 }; + vcontigs.add(contig); + } + vstart = hideEnd + 1; + + // exit if we're past the end + if (vstart >= end) + { + break; + } + } + + if (vstart < end) + { + int[] contig = new int[] { vstart, end - 1 }; + vcontigs.add(contig); + } + } + else + { + int[] contig = new int[] { start, end - 1 }; + vcontigs.add(contig); + } + } finally + { + if (usecopy) + { + LOCK.readLock().unlock(); + } + } + } + + @Override + public boolean hasNext() + { + return (currentPosition < vcontigs.size()); + } + + @Override + public int[] next() + { + int[] result = vcontigs.get(currentPosition); + currentPosition++; + return result; + } + } + + /** + * An iterator which iterates over visible regions in a range. The range is + * specified in terms of visible column positions. Provides a special + * "endsAtHidden" indicator to allow callers to determine if the final visible + * column is adjacent to a hidden region. + */ + public class VisibleBlocksVisBoundsIterator implements Iterator + { + private List vcontigs = new ArrayList<>(); + + private int currentPosition = 0; + + private boolean endsAtHidden = false; + + /** + * Constructor for iterator over visible regions in a range. + * + * @param start + * start position in terms of visible column position + * @param end + * end position in terms of visible column position + * @param usecopy + * whether to use a local copy of hidden columns + */ + VisibleBlocksVisBoundsIterator(int start, int end, boolean usecopy) + { + /* actually this implementation always uses a local copy but this may change in future */ + try + { + if (usecopy) + { + LOCK.readLock().lock(); + } + + if (hiddenColumns != null && hiddenColumns.size() > 0) + { + int blockStart = start; + int blockEnd = end; + int hiddenSoFar = 0; + int visSoFar = 0; + + // iterate until a region begins within (start,end] + int i = 0; + while ((i < hiddenColumns.size()) + && (hiddenColumns.get(i)[0] <= blockStart + hiddenSoFar)) + { + hiddenSoFar += hiddenColumns.get(i)[1] - hiddenColumns.get(i)[0] + + 1; + i++; + } + + blockStart += hiddenSoFar; // convert start to absolute position + blockEnd += hiddenSoFar; // convert end to absolute position + + // iterate from start to end, adding each visible region. Positions + // are + // absolute, and all hidden regions which overlap [start,end] are + // used. + while (i < hiddenColumns.size() + && (hiddenColumns.get(i)[0] <= blockEnd)) + { + int[] region = hiddenColumns.get(i); + + // end position of this visible region is either just before the + // start of the next hidden region, or the absolute position of + // 'end', whichever is lowest + blockEnd = Math.min(blockEnd, region[0] - 1); + + vcontigs.add(new int[] { blockStart, blockEnd }); + + visSoFar += blockEnd - blockStart + 1; + + // next visible region starts after this hidden region + blockStart = region[1] + 1; + + hiddenSoFar += region[1] - region[0] + 1; + + // reset blockEnd to absolute position of 'end', assuming we've now + // passed all hidden regions before end + blockEnd = end + hiddenSoFar; + + i++; + } + if (visSoFar < end - start) + { + // the number of visible columns we've accounted for is less than + // the number specified by end-start; work out the end position of + // the last visible region + blockEnd = blockStart + end - start - visSoFar; + vcontigs.add(new int[] { blockStart, blockEnd }); + + // if the last visible region ends at the next hidden region, set + // endsAtHidden=true + if (i < hiddenColumns.size() + && hiddenColumns.get(i)[0] - 1 == blockEnd) + { + endsAtHidden = true; + } + } + } + else + { + // there are no hidden columns, return a single visible contig + vcontigs.add(new int[] { start, end }); + endsAtHidden = false; + } + } finally + { + if (usecopy) + { + LOCK.readLock().unlock(); + } + } + } + + @Override + public boolean hasNext() + { + return (currentPosition < vcontigs.size()); + } + + @Override + public int[] next() + { + int[] result = vcontigs.get(currentPosition); + currentPosition++; + return result; + } + + public boolean endsAtHidden() + { + return endsAtHidden; + } + } }