package jalview.datamodel;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.BitSet;
import java.util.Iterator;
import java.util.List;
*
* - getVisibleColsIterator: iterates over the visible *columns*
*
- * For performance reasons, provide bounds where possible.
+ * For performance reasons, provide bounds where possible. Note that column
+ * numbering begins at 0 throughout this class.
*
* @author kmourao
*
* list of hidden column [start, end] ranges; the list is maintained in
* ascending start column order
*/
- private ArrayList<int[]> hiddenColumns;
+ private List<int[]> hiddenColumns = new ArrayList<>();
/**
* Constructor
*/
public HiddenColumns(HiddenColumns copy)
{
- try
- {
- LOCK.writeLock().lock();
- numColumns = 0;
- if (copy != null)
- {
- if (copy.hiddenColumns != null)
- {
- hiddenColumns = new ArrayList<>();
- Iterator<int[]> it = copy.iterator();
- while (it.hasNext())
- {
- int[] region = it.next();
- hiddenColumns.add(region);
- numColumns += region[1] - region[0] + 1;
- }
- cursor.resetCursor(hiddenColumns);
- }
- }
- } finally
- {
- LOCK.writeLock().unlock();
- }
+ this(copy, Integer.MIN_VALUE, Integer.MAX_VALUE, 0);
}
/**
LOCK.writeLock().lock();
if (copy != null)
{
- hiddenColumns = new ArrayList<>();
numColumns = 0;
Iterator<int[]> it = copy.getBoundedIterator(start, end);
while (it.hasNext())
wasAlreadyLocked = true;
}
- if (hiddenColumns == null)
+ int previndex = 0;
+ int prevHiddenCount = 0;
+ int regionindex = 0;
+ if (!hiddenColumns.isEmpty())
{
- hiddenColumns = new ArrayList<>();
+ // set up cursor reset values
+ HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start);
+ regionindex = cursorPos.getRegionIndex();
+
+ if (regionindex > 0)
+ {
+ // get previous index and hidden count for updating the cursor later
+ previndex = regionindex - 1;
+ int[] prevRegion = hiddenColumns.get(previndex);
+ prevHiddenCount = cursorPos.getHiddenSoFar()
+ - (prevRegion[1] - prevRegion[0] + 1);
+ }
}
/*
* appropriate
*/
boolean added = false;
- for (int i = 0; !added && i < hiddenColumns.size(); i++)
+ if (regionindex > 0)
+ {
+ added = insertRangeAtRegion(regionindex - 1, start, end);
+ }
+ if (!added && regionindex < hiddenColumns.size())
{
- added = insertRangeAtRegion(i, start, end);
- } // for
+ insertRangeAtRegion(regionindex, start, end);
+ }
}
- if (!wasAlreadyLocked)
- {
- cursor.resetCursor(hiddenColumns);
- // reset the number of columns so they will be recounted
- numColumns = 0;
- }
+ // reset the cursor to just before our insertion point: this saves
+ // a lot of reprocessing in large alignments
+ cursor.resetCursor(hiddenColumns, previndex, prevHiddenCount);
+
+ // reset the number of columns so they will be recounted
+ numColumns = 0;
+
} finally
{
if (!wasAlreadyLocked)
break;
}
region[1] = Math.max(nextRegion[1], end);
+
+ // in theory this is faster than hiddenColumns.remove(i+1)
+ // benchmarking results a bit ambivalent
hiddenColumns.subList(i + 1, i + 2).clear();
}
added = true;
}
/**
- * mark the columns corresponding to gap characters as hidden in the column
- * selection
+ * hide a list of ranges
*
- * @param sr
+ * @param ranges
*/
- public void hideInsertionsFor(SequenceI sr)
+ public void hideList(List<int[]> ranges)
{
try
{
LOCK.writeLock().lock();
- List<int[]> inserts = sr.getInsertions();
- for (int[] r : inserts)
+ for (int[] r : ranges)
{
hideColumns(r[0], r[1]);
}
try
{
LOCK.writeLock().lock();
- if (hiddenColumns != null)
+
+ for (int[] region : hiddenColumns)
{
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+ for (int j = region[0]; j < region[1] + 1; j++)
{
- int[] region = it.next();
- for (int j = region[0]; j < region[1] + 1; j++)
- {
- sel.addElement(j);
- }
+ sel.addElement(j);
}
- hiddenColumns = null;
- cursor.resetCursor(hiddenColumns);
- numColumns = 0;
}
+ hiddenColumns.clear();
+ cursor.resetCursor(hiddenColumns);
+ numColumns = 0;
+
} finally
{
LOCK.writeLock().unlock();
{
LOCK.writeLock().lock();
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
int regionIndex = cursor.findRegionForColumn(start)
.getRegionIndex();
if (hiddenColumns.isEmpty())
{
- hiddenColumns = null;
+ hiddenColumns.clear();
numColumns = 0;
}
else
// 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
+ // first get the non-gaps as a Bitset
+ // then calculate hidden ^ not(gap)
BitSet gaps = origseq.gapBitset();
-
- // now calculate hidden ^ not(gap)
- BitSet hidden = new BitSet();
- markHiddenRegions(hidden);
- hidden.andNot(gaps);
- hiddenColumns = null;
- this.hideMarkedBits(hidden);
+ this.andNot(gaps);
// 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<int[]> regions = hiddenColumns.iterator();
- ArrayList<int[]> newhidden = new ArrayList<>();
+ List<int[]> newhidden = new ArrayList<>();
int numGapsBefore = 0;
int gapPosition = 0;
- while (regions.hasNext())
+ for (int[] region : hiddenColumns)
{
// 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])
{
gapPosition++;
newhidden.add(new int[] { left, right });
// make a string with number of gaps = length of hidden region
- StringBuffer sb = new StringBuffer();
+ StringBuilder sb = new StringBuilder();
for (int s = 0; s < right - left + 1; s++)
{
sb.append(gc);
* @param al
* alignment to pad sequences in
*/
- private void padGaps(StringBuffer sb, int pos, SequenceI profileseq,
+ private void padGaps(StringBuilder sb, int pos, SequenceI profileseq,
AlignmentI al)
{
// loop over the sequences and pad with gaps where required
{
LOCK.readLock().lock();
StringBuilder regionBuilder = new StringBuilder();
- if (hiddenColumns != null)
+
+ boolean first = true;
+ for (int[] range : hiddenColumns)
{
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+ if (!first)
{
- int[] range = it.next();
- regionBuilder.append(delimiter).append(range[0]).append(between)
- .append(range[1]);
- if (!it.hasNext())
- {
- regionBuilder.deleteCharAt(0);
- }
+ regionBuilder.append(delimiter);
}
+ else
+ {
+ first = false;
+ }
+ regionBuilder.append(range[0]).append(between).append(range[1]);
+
}
+
return regionBuilder.toString();
} finally
{
{
LOCK.readLock().lock();
- if (numColumns == 0 && hiddenColumns != null)
+ if (numColumns == 0)
{
// numColumns is out of date, so recalculate
int size = 0;
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+ for (int[] range : hiddenColumns)
{
- int[] range = it.next();
size += range[1] - range[0] + 1;
}
try
{
LOCK.readLock().lock();
- int num = 0;
- if (hasHiddenColumns())
- {
- num = hiddenColumns.size();
- }
- return num;
+ return hiddenColumns.size();
} finally
{
LOCK.readLock().unlock();
/*
* check hidden columns are either both null, or match
*/
- if (this.hiddenColumns == null)
- {
- return (that.hiddenColumns == null);
- }
- if (that.hiddenColumns == null
- || that.hiddenColumns.size() != this.hiddenColumns.size())
+
+ if (that.hiddenColumns.size() != this.hiddenColumns.size())
{
return false;
}
- Iterator<int[]> it = hiddenColumns.iterator();
+ Iterator<int[]> it = this.iterator();
Iterator<int[]> thatit = that.iterator();
while (it.hasNext())
{
- int[] thisRange = it.next();
- int[] thatRange = thatit.next();
- if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
+ if (!(Arrays.equals(it.next(), thatit.next())))
{
return false;
}
}
return true;
+
} finally
{
LOCK.readLock().unlock();
* int column index in alignment view (count from zero)
* @return alignment column index for column
*/
- public int adjustForHiddenColumns(int column)
+ public int visibleToAbsoluteColumn(int column)
{
try
{
LOCK.readLock().lock();
int result = column;
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
- result += cursor.getHiddenOffset(column).getHiddenSoFar();
+ result += cursor.findRegionForVisColumn(column).getHiddenSoFar();
}
return result;
/**
* Use this method to find out where a column will appear in the visible
* alignment when hidden columns exist. If the column is not visible, then the
- * left-most visible column will always be returned.
+ * index of the next visible column on the left will be returned (or 0 if
+ * there is no visible column on the left)
*
* @param hiddenColumn
* the column index in the full alignment including hidden columns
* @return the position of the column in the visible alignment
*/
- public int findColumnPosition(int hiddenColumn)
+ public int absoluteToVisibleColumn(int hiddenColumn)
{
try
{
LOCK.readLock().lock();
int result = hiddenColumn;
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
HiddenCursorPosition cursorPos = cursor
.findRegionForColumn(hiddenColumn);
/**
* Find the visible column which is a given visible number of columns to the
- * left of another visible column. i.e. for a startColumn x, the column which
- * is distance 1 away will be column x-1.
+ * left (negative visibleDistance) or right (positive visibleDistance) of
+ * startColumn. If startColumn is not visible, we use the visible column at
+ * the left boundary of the hidden region containing startColumn.
*
* @param visibleDistance
- * the number of visible columns to offset by
+ * the number of visible columns to offset by (left offset = negative
+ * value; right offset = positive value)
* @param startColumn
- * the column to start from
- * @return the position of the column in the visible alignment
+ * the position of the column to start from (absolute position)
+ * @return the position of the column which is <visibleDistance> away
+ * (absolute position)
*/
- public int subtractVisibleColumns(int visibleDistance, int startColumn)
+ public int offsetByVisibleColumns(int visibleDistance, int startColumn)
{
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));
-
- Iterator<int[]> it = new ReverseRegionsIterator(0, start,
- hiddenColumns);
-
- while (it.hasNext() && (distance > 0))
- {
- int[] region = it.next();
-
- if (start > region[1])
- {
- // subtract the gap to right of region from distance
- if (start - region[1] <= distance)
- {
- distance -= start - region[1];
- start = region[0] - 1;
- }
- else
- {
- start = start - distance;
- distance = 0;
- }
- }
- }
- return start - distance;
+ int start = absoluteToVisibleColumn(startColumn);
+ return visibleToAbsoluteColumn(start + visibleDistance);
} finally
{
* @param alPos
* the absolute (visible) alignmentPosition to find the next hidden
* column for
+ * @return the index of the next hidden column, or alPos if there is no next
+ * hidden column
*/
public int getHiddenBoundaryRight(int alPos)
{
try
{
LOCK.readLock().lock();
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
int index = cursor.findRegionForColumn(alPos).getRegionIndex();
if (index < hiddenColumns.size())
{
LOCK.readLock().lock();
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
int index = cursor.findRegionForColumn(alPos).getRegionIndex();
LOCK.readLock().lock();
int iSize = seqs.length;
String[] selections = new String[iSize];
- if (hiddenColumns != null && hiddenColumns.size() > 0)
+ if (!hiddenColumns.isEmpty())
{
for (int i = 0; i < iSize; i++)
{
- StringBuffer visibleSeq = new StringBuffer();
+ StringBuilder visibleSeq = new StringBuilder();
Iterator<int[]> blocks = new VisibleContigsIterator(start,
end + 1, hiddenColumns);
LOCK.readLock().lock();
int start = 0;
- if (hiddenColumns == null || hiddenColumns.size() == 0)
+ if (hiddenColumns.isEmpty())
{
return seq.findIndex(seq.getStart()) - 1;
}
if (foundStart)
{
- return findColumnPosition(start);
+ return absoluteToVisibleColumn(start);
}
// otherwise, sequence was completely hidden
return visPrev;
}
}
- /**
- * delete any columns in alignmentAnnotation that are hidden (including
- * sequence associated annotation).
- *
- * @param alignmentAnnotation
- */
- public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
- {
- if (alignmentAnnotation != null
- && alignmentAnnotation.annotations != null)
- {
- makeVisibleAnnotation(0, alignmentAnnotation.annotations.length,
- alignmentAnnotation);
- }
- }
-
- /**
- * delete any columns in alignmentAnnotation that are hidden (including
- * sequence associated annotation).
- *
- * @param start
- * remove any annotation to the right of this column
- * @param end
- * remove any annotation to the left of this column
- * @param alignmentAnnotation
- * the annotation to operate on
- */
- public void makeVisibleAnnotation(int start, int end,
- AlignmentAnnotation alignmentAnnotation)
- {
- try
- {
- LOCK.readLock().lock();
-
- int startFrom = start;
- int endAt = end;
-
- if (alignmentAnnotation != null
- && alignmentAnnotation.annotations != null)
- {
- if (hiddenColumns != null && hiddenColumns.size() > 0)
- {
- removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation);
- }
- else
- {
- alignmentAnnotation.restrict(startFrom, endAt);
- }
- }
- } finally
- {
- LOCK.readLock().unlock();
- }
- }
-
- private void removeHiddenAnnotation(int start, int end,
- AlignmentAnnotation alignmentAnnotation)
- {
- // mangle the alignmentAnnotation annotation array
- ArrayList<Annotation[]> annels = new ArrayList<>();
- Annotation[] els = null;
-
- int w = 0;
-
- Iterator<int[]> blocks = new VisibleContigsIterator(start, end + 1,
- hiddenColumns);
-
- 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
- {
- 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;
- }
-
- if (w != 0)
- {
- alignmentAnnotation.annotations = new Annotation[w];
-
- w = 0;
- for (Annotation[] chnk : annels)
- {
- System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
- chnk.length);
- w += chnk.length;
- }
- }
- }
/**
*
try
{
LOCK.readLock().lock();
- return hiddenColumns != null && hiddenColumns.size() > 0;
+
+ // we don't use getSize()>0 here because it has to iterate over
+ // the full hiddenColumns collection and so will be much slower
+ return (!hiddenColumns.isEmpty());
} finally
{
LOCK.readLock().unlock();
/**
*
- * @return true if there are more than one set of columns hidden
+ * @return true if there is more than one hidden column region
*/
- public boolean hasManyHiddenColumns()
+ public boolean hasMultiHiddenColumnRegions()
{
try
{
LOCK.readLock().lock();
- return hiddenColumns != null && hiddenColumns.size() > 1;
+ return !hiddenColumns.isEmpty() && hiddenColumns.size() > 1;
} finally
{
LOCK.readLock().unlock();
{
LOCK.readLock().lock();
int hashCode = 1;
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+ for (int[] hidden : hiddenColumns)
{
- int[] hidden = it.next();
hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
}
* Hide columns corresponding to the marked bits
*
* @param inserts
- * - columns map to bits starting from zero
+ * - columns mapped to bits starting from zero
*/
- public void hideMarkedBits(BitSet inserts)
+ public void hideColumns(BitSet inserts)
{
try
{
}
/**
+ * Hide columns corresponding to the marked bits, within the range
+ * [start,end]. Entries in tohide which are outside [start,end] are ignored.
+ *
+ * @param tohide
+ * columns mapped to bits starting from zero
+ * @param start
+ * start of range to hide columns within
+ * @param end
+ * end of range to hide columns within
+ */
+ public void hideColumns(BitSet tohide, int start, int end)
+ {
+ clearHiddenColumnsInRange(start, end);
+
+ // make sure only bits between start and end are set
+ if (!tohide.isEmpty())
+ {
+ tohide.clear(0, start);
+ tohide.clear(Math.min(end + 1, tohide.length() + 1),
+ tohide.length() + 1);
+ }
+
+ hideColumns(tohide);
+ }
+
+ /**
+ * Make all columns in the range [start,end] visible
+ *
+ * @param start
+ * start of range to show columns
+ * @param end
+ * end of range to show columns
+ */
+ private void clearHiddenColumnsInRange(int start, int end)
+ {
+ try
+ {
+ LOCK.writeLock().lock();
+
+ if (!hiddenColumns.isEmpty())
+ {
+ HiddenCursorPosition pos = cursor.findRegionForColumn(start);
+ int index = pos.getRegionIndex();
+ int startindex = index; // first index in hiddenColumns to remove
+
+ if (index != -1 && index != hiddenColumns.size())
+ {
+ // regionIndex is the region which either contains start
+ // or lies to the right of start
+ int[] region = hiddenColumns.get(index);
+ if (region[0] < start && region[1] >= start)
+ {
+ // region contains start, truncate so that it ends just before start
+ region[1] = start - 1;
+ startindex++;
+ }
+ }
+
+ pos = cursor.findRegionForColumn(end);
+ index = pos.getRegionIndex();
+ int endindex = index - 1; // last index in hiddenColumns to remove
+
+ if (index != -1 && index != hiddenColumns.size())
+ {
+ // regionIndex is the region which either contains end
+ // or lies to the right of end
+ int[] region = hiddenColumns.get(index);
+ if (region[0] <= end && region[1] > end)
+ {
+ // region contains end, truncate so that it starts just after end
+ region[0] = end + 1;
+ }
+ }
+
+ hiddenColumns.subList(startindex, endindex + 1).clear();
+ cursor.resetCursor(hiddenColumns);
+ numColumns = 0;
+ }
+ } finally
+ {
+ LOCK.writeLock().unlock();
+ }
+ }
+
+ /**
*
* @param inserts
* BitSet where hidden columns will be marked
*/
- public void markHiddenRegions(BitSet inserts)
+ private void andNot(BitSet updates)
{
try
{
LOCK.readLock().lock();
- if (hiddenColumns == null)
- {
- return;
- }
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+
+ BitSet hiddenBitSet = new BitSet();
+ for (int[] range : hiddenColumns)
{
- int[] range = it.next();
- inserts.set(range[0], range[1] + 1);
+ hiddenBitSet.set(range[0], range[1] + 1);
}
+ hiddenBitSet.andNot(updates);
+ hiddenColumns.clear();
+ hideColumns(hiddenBitSet);
} finally
{
LOCK.readLock().unlock();
int[] lowestRange = new int[] { -1, -1 };
int[] higestRange = new int[] { -1, -1 };
- if (hiddenColumns == null)
+ if (hiddenColumns.isEmpty())
{
return new int[] { startPos, endPos };
}
- Iterator<int[]> it = hiddenColumns.iterator();
- while (it.hasNext())
+ for (int[] range : hiddenColumns)
{
- int[] range = it.next();
lowestRange = (range[0] <= startPos) ? range : lowestRange;
higestRange = (range[1] >= endPos) ? range : higestRange;
}
*
* @param res
* visible residue position, unadjusted for hidden columns
- * @return region as [start,end] or null if no matching region is found
+ * @return region as [start,end] or null if no matching region is found. If
+ * res is adjacent to two regions, returns the left region.
*/
public int[] getRegionWithEdgeAtRes(int res)
{
try
{
LOCK.readLock().lock();
- int adjres = adjustForHiddenColumns(res);
+ int adjres = visibleToAbsoluteColumn(res);
int[] reveal = null;
- if (hiddenColumns != null)
+ if (!hiddenColumns.isEmpty())
{
// look for a region ending just before adjres
int regionindex = cursor.findRegionForColumn(adjres - 1)
try
{
LOCK.readLock().lock();
- return new BoundedHiddenColsIterator(hiddenColumns);
+ return new HiddenColsIterator(hiddenColumns);
} finally
{
LOCK.readLock().unlock();
try
{
LOCK.readLock().lock();
- return new BoundedHiddenColsIterator(start, end, hiddenColumns);
+ return new HiddenColsIterator(start, end, hiddenColumns);
} finally
{
LOCK.readLock().unlock();
LOCK.readLock().lock();
// get absolute position of column in alignment
- int absoluteStart = adjustForHiddenColumns(start);
+ int absoluteStart = visibleToAbsoluteColumn(start);
// Get cursor position and supply it to the iterator:
// Since we want visible region start, we look for a cursor for the
* if true, start and end are visible column positions, not absolute
* positions*
*/
- public Iterator<int[]> getVisContigsIterator(int start, int end,
+ public VisibleContigsIterator getVisContigsIterator(int start,
+ int end,
boolean useVisibleCoords)
{
int adjstart = start;
int adjend = end;
if (useVisibleCoords)
{
- adjstart = adjustForHiddenColumns(start);
- adjend = adjustForHiddenColumns(end);
+ adjstart = visibleToAbsoluteColumn(start);
+ adjend = visibleToAbsoluteColumn(end);
}
try
git://source.jalview.org / jalview.git / blobdiff