X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FMapList.java;h=0f3fc2e4cfea5d718281c4988fee2c9871253f43;hb=a1984b1c8c273ed33c7ce9283039f4027dcae2de;hp=f67b47f4c0b82d2bbc7bc072a2a7942a754618e3;hpb=81c319be6445aadda7c29045b37d6ee2ad26aa3e;p=jalview.git diff --git a/src/jalview/util/MapList.java b/src/jalview/util/MapList.java index f67b47f..0f3fc2e 100644 --- a/src/jalview/util/MapList.java +++ b/src/jalview/util/MapList.java @@ -1,105 +1,175 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.util; -import java.util.*; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.BitSet; +import java.util.List; + +import jalview.bin.Cache; /** - * MapList - * Simple way of bijectively mapping a non-contiguous linear range to another non-contiguous linear range + * A simple way of bijectively mapping a non-contiguous linear range to another + * non-contiguous linear range. + * * Use at your own risk! - * TODO: efficient implementation of private posMap method - * TODO: test/ensure that sense of from and to ratio start position is conserved (codon start position recovery) - * TODO: optimize to use int[][] arrays rather than vectors. + * + * TODO: test/ensure that sense of from and to ratio start position is conserved + * (codon start position recovery) */ public class MapList { - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + + /* + * Subregions (base 1) described as { [start1, end1], [start2, end2], ...} */ - public boolean equals(MapList obj) { - if (obj==this) - return true; - if (obj!=null && obj.fromRatio==fromRatio && obj.toRatio==toRatio - && obj.fromShifts!=null && obj.toShifts!=null) { - int i,iSize=fromShifts.size(),j,jSize=obj.fromShifts.size(); - if (iSize!=jSize) - return false; - for (i=0,iSize=fromShifts.size(),j=0, jSize=obj.fromShifts.size(); i fromShifts; + + /* + * Same format as fromShifts, for the 'mapped to' sequence + */ + private List toShifts; + + /* + * number of steps in fromShifts to one toRatio unit + */ + private int fromRatio; + + /* + * number of steps in toShifts to one fromRatio + */ + private int toRatio; + + /* + * lowest and highest value in the from Map + */ + private int fromLowest; + + private int fromHighest; + + /* + * lowest and highest value in the to Map + */ + private int toLowest; + + private int toHighest; + + /** + * Constructor + */ + public MapList() + { + fromShifts = new ArrayList<>(); + toShifts = new ArrayList<>(); + } + + /** + * Two MapList objects are equal if they are the same object, or they both + * have populated shift ranges and all values are the same. + */ + @Override + public boolean equals(Object o) + { + if (o == null || !(o instanceof MapList)) + { + return false; + } + + MapList obj = (MapList) o; + if (obj == this) + { return true; } - return false; + if (obj.fromRatio != fromRatio || obj.toRatio != toRatio + || obj.fromShifts == null || obj.toShifts == null) + { + return false; + } + return Arrays.deepEquals(fromShifts.toArray(), obj.fromShifts.toArray()) + && Arrays.deepEquals(toShifts.toArray(), + obj.toShifts.toArray()); } - public Vector fromShifts; - public Vector toShifts; - int fromRatio; // number of steps in fromShifts to one toRatio unit - int toRatio; // number of steps in toShifts to one fromRatio - + /** + * Returns a hashcode made from the fromRatio, toRatio, and from/to ranges + */ + @Override + public int hashCode() + { + int hashCode = 31 * fromRatio; + hashCode = 31 * hashCode + toRatio; + for (int[] shift : fromShifts) + { + hashCode = 31 * hashCode + shift[0]; + hashCode = 31 * hashCode + shift[1]; + } + for (int[] shift : toShifts) + { + hashCode = 31 * hashCode + shift[0]; + hashCode = 31 * hashCode + shift[1]; + } + + return hashCode; + } + + /** + * Returns the 'from' ranges as {[start1, end1], [start2, end2], ...} * - * @return series of intervals mapped in from + * @return */ - public int[] getFromRanges() + public List getFromRanges() { - return getRanges(fromShifts); + return fromShifts; } - public int[] getToRanges() + + /** + * Returns the 'to' ranges as {[start1, end1], [start2, end2], ...} + * + * @return + */ + public List getToRanges() { - return getRanges(toShifts); + return toShifts; } - - private int[] getRanges(Vector shifts) + + /** + * Flattens a list of [start, end] into a single [start1, end1, start2, + * end2,...] array. + * + * @param shifts + * @return + */ + protected static int[] getRanges(List shifts) { - int[] rnges = new int[2*shifts.size()]; - Enumeration e = shifts.elements(); - int i=0; - while (e.hasMoreElements()) + int[] rnges = new int[2 * shifts.size()]; + int i = 0; + for (int[] r : shifts) { - int r[] = (int[]) e.nextElement(); rnges[i++] = r[0]; rnges[i++] = r[1]; } return rnges; } - /** - * lowest and highest value in the from Map - */ - int[] fromRange=null; - /** - * lowest and highest value in the to Map - */ - int[] toRange=null; + /** * * @return length of mapped phrase in from @@ -108,6 +178,7 @@ public class MapList { return fromRatio; } + /** * * @return length of mapped phrase in to @@ -116,166 +187,312 @@ public class MapList { return toRatio; } - public int getFromLowest() { - return fromRange[0]; - } - public int getFromHighest() { - return fromRange[1]; + + public int getFromLowest() + { + return fromLowest; } - public int getToLowest() { - return toRange[0]; + + public int getFromHighest() + { + return fromHighest; } - public int getToHighest() { - return toRange[1]; + + public int getToLowest() + { + return toLowest; } - private void ensureRange(int[] limits, int pos) { - if (limits[0]>pos) - limits[0]=pos; - if (limits[1] fromRange, List toRange, int fromRatio, + int toRatio) + { + this(); + fromRange = coalesceRanges(fromRange); + toRange = coalesceRanges(toRange); + this.fromShifts = fromRange; + this.toShifts = toRange; + this.fromRatio = fromRatio; + this.toRatio = toRatio; + + fromLowest = Integer.MAX_VALUE; + fromHighest = Integer.MIN_VALUE; + for (int[] range : fromRange) + { + if (range.length != 2) + { + // throw new IllegalArgumentException(range); + Cache.error("Invalid format for fromRange " + + Arrays.toString(range) + " may cause errors"); + } + fromLowest = Math.min(fromLowest, Math.min(range[0], range[1])); + fromHighest = Math.max(fromHighest, Math.max(range[0], range[1])); + } + + toLowest = Integer.MAX_VALUE; + toHighest = Integer.MIN_VALUE; + for (int[] range : toRange) + { + if (range.length != 2) + { + // throw new IllegalArgumentException(range); + Cache.error("Invalid format for toRange " + + Arrays.toString(range) + " may cause errors"); + } + toLowest = Math.min(toLowest, Math.min(range[0], range[1])); + toHighest = Math.max(toHighest, Math.max(range[0], range[1])); + } + } + + /** + * Consolidates a list of ranges so that any contiguous ranges are merged. + * This assumes the ranges are already in start order (does not sort them). + *

+ * The main use case for this method is when mapping cDNA sequence to its + * protein product, based on CDS feature ranges which derive from spliced + * exons, but are contiguous on the cDNA sequence. For example + * + *

+   *   CDS 1-20  // from exon1
+   *   CDS 21-35 // from exon2
+   *   CDS 36-71 // from exon3
+   * 'coalesce' to range 1-71
+   * 
+ * + * @param ranges + * @return the same list (if unchanged), else a new merged list, leaving the + * input list unchanged + */ + public static List coalesceRanges(final List ranges) + { + if (ranges == null || ranges.size() < 2) + { + return ranges; + } + + boolean changed = false; + List merged = new ArrayList<>(); + int[] lastRange = ranges.get(0); + int lastDirection = lastRange[1] >= lastRange[0] ? 1 : -1; + lastRange = new int[] { lastRange[0], lastRange[1] }; + merged.add(lastRange); + boolean first = true; + + for (final int[] range : ranges) + { + if (first) { - int[] el = (int[]) e.nextElement(); - toShifts.addElement(new int[] - { el[0], el[1] }); + first = false; + continue; + } + + int direction = range[1] >= range[0] ? 1 : -1; + + /* + * if next range is in the same direction as last and contiguous, + * just update the end position of the last range + */ + boolean sameDirection = range[1] == range[0] + || direction == lastDirection; + boolean extending = range[0] == lastRange[1] + lastDirection; + if (sameDirection && extending) + { + lastRange[1] = range[1]; + changed = true; + } + else + { + lastRange = new int[] { range[0], range[1] }; + merged.add(lastRange); + // careful: merging [5, 5] after [7, 6] should keep negative direction + lastDirection = (range[1] == range[0]) ? lastDirection : direction; } } + + return changed ? merged : ranges; } + /** * get all mapped positions from 'from' to 'to' - * @return int[][] { int[] { fromStart, fromFinish, toStart, toFinish }, int [fromFinish-fromStart+2] { toStart..toFinish mappings}} + * + * @return int[][] { int[] { fromStart, fromFinish, toStart, toFinish }, int + * [fromFinish-fromStart+2] { toStart..toFinish mappings}} */ - public int[][] makeFromMap() + protected int[][] makeFromMap() { + // TODO only used for test - remove?? return posMap(fromShifts, fromRatio, toShifts, toRatio); } + /** * get all mapped positions from 'to' to 'from' + * * @return int[to position]=position mapped in from */ - public int[][] makeToMap() + protected int[][] makeToMap() { - return posMap(toShifts,toRatio, fromShifts, fromRatio); + // TODO only used for test - remove?? + return posMap(toShifts, toRatio, fromShifts, fromRatio); } + /** * construct an int map for intervals in intVals - * @param intVals - * @return int[] { from, to pos in range }, int[range.to-range.from+1] returning mapped position + * + * @param shiftTo + * @return int[] { from, to pos in range }, int[range.to-range.from+1] + * returning mapped position */ - private int[][] posMap(Vector intVals, int ratio, Vector toIntVals, - int toRatio) + private int[][] posMap(List shiftTo, int sourceRatio, + List shiftFrom, int targetRatio) { - int iv=0,ivSize = intVals.size(); - if (iv>=ivSize) + // TODO only used for test - remove?? + int iv = 0, ivSize = shiftTo.size(); + if (iv >= ivSize) { return null; } - int[] intv=(int[]) intVals.elementAt(iv++); - int from=intv[0],to=intv[1]; + int[] intv = shiftTo.get(iv++); + int from = intv[0], to = intv[1]; if (from > to) { from = intv[1]; - to=intv[0]; + to = intv[0]; } - while (ivto) + if (intv[0] > to) { - to=intv[0]; + to = intv[0]; } - if (intv[1]>to) + if (intv[1] > to) { - to=intv[1]; + to = intv[1]; } } - int tF=0,tT=0; - int mp[][] = new int[to-from+2][]; + int tF = 0, tT = 0; + int mp[][] = new int[to - from + 2][]; for (int i = 0; i < mp.length; i++) { - int[] m = shift(i+from,intVals,ratio,toIntVals, toRatio); + int[] m = shift(i + from, shiftTo, sourceRatio, shiftFrom, + targetRatio); if (m != null) { if (i == 0) { - tF=tT=m[0]; + tF = tT = m[0]; } else { if (m[0] < tF) { - tF=m[0]; + tF = m[0]; } if (m[0] > tT) { - tT=m[0]; + tT = m[0]; } } } mp[i] = m; } - int[][] map = new int[][] - { - new int[] - { - from, to, tF, tT}, new int[to - from + 2]}; + int[][] map = new int[][] { new int[] { from, to, tF, tT }, + new int[to - from + 2] }; map[0][2] = tF; map[0][3] = tT; @@ -284,7 +501,7 @@ public class MapList { if (mp[i] != null) { - map[1][i] = mp[i][0]-tF; + map[1][i] = mp[i][0] - tF; } else { @@ -293,28 +510,29 @@ public class MapList } return map; } + /** * addShift - * @param pos start position for shift (in original reference frame) - * @param shift length of shift - * - public void addShift(int pos, int shift) - { - int sidx = 0; - int[] rshift=null; - while (sidx shiftTo, int fromRatio, + List shiftFrom, int toRatio) { - int[] fromCount = countPos(fromShifts, pos); - if (fromCount==null) + // TODO: javadoc; tests + int[] fromCount = countPositions(shiftTo, pos); + if (fromCount == null) { return null; } - int fromRemainder=(fromCount[0]-1) % fromRatio; - int toCount = 1+(((fromCount[0]-1) / fromRatio) * toRatio); - int[] toPos = countToPos(toShifts, toCount); - if (toPos==null) + int fromRemainder = (fromCount[0] - 1) % fromRatio; + int toCount = 1 + (((fromCount[0] - 1) / fromRatio) * toRatio); + int[] toPos = traverseToPosition(shiftFrom, toCount); + if (toPos == null) { - return null; // throw new Error("Bad Mapping!"); + return null; } - //System.out.println(fromCount[0]+" "+fromCount[1]+" "+toCount); - return new int[] - { - toPos[0], fromRemainder, toPos[1]}; + return new int[] { toPos[0], fromRemainder, toPos[1] }; } + /** - * count how many positions pos is along the series of intervals. - * @param intVals + * Counts how many positions pos is along the series of intervals. Returns an + * array of two values: + *
    + *
  • the number of positions traversed (inclusive) to reach {@code pos}
  • + *
  • +1 if the last interval traversed is forward, -1 if in a negative + * direction
  • + *
+ * Returns null if {@code pos} does not lie in any of the given intervals. + * + * @param intervals + * a list of start-end intervals * @param pos - * @return number of positions or null if pos is not within intervals + * a position that may lie in one (or more) of the intervals + * @return */ - private int[] countPos(Vector intVals, int pos) + protected static int[] countPositions(List intervals, int pos) { - int count=0,intv[],iv=0,ivSize=intVals.size(); - while (iv= intv[0] && pos <= intv[1]) { - return new int[] - { - count + pos - intv[0] + 1, +1}; + return new int[] { count + pos - intv[0] + 1, +1 }; } else { - count+=intv[1]-intv[0]+1; + count += intv[1] - intv[0] + 1; } } else { + /* + * reverse interval + */ if (pos >= intv[1] && pos <= intv[0]) { - return new int[] - { - count + intv[0] - pos + 1, -1}; + return new int[] { count + intv[0] - pos + 1, -1 }; } else { - count+=intv[0]-intv[1]+1; + count += intv[0] - intv[1] + 1; } } } return null; } + /** - * count out pos positions into a series of intervals and return the position - * @param intVals - * @param pos - * @return position pos in interval set + * Reads through the given intervals until {@code count} positions have been + * traversed, and returns an array consisting of two values: + *
    + *
  • the value at the {@code count'th} position
  • + *
  • +1 if the last interval read is forwards, -1 if reverse direction
  • + *
+ * Returns null if the ranges include less than {@code count} positions, or if + * {@code count < 1}. + * + * @param intervals + * a list of [start, end] ranges + * @param count + * the number of positions to traverse + * @return */ - private int[] countToPos(Vector intVals, int pos) + protected static int[] traverseToPosition(List intervals, + final int count) { - int count = 0, diff = 0, iv=0,ivSize=intVals.size(), intv[] = + int traversed = 0; + int ivSize = intervals.size(); + int iv = 0; + + if (count < 1) { - 0, 0}; - while (iv= 0) { - if (pos <= count + 1 + diff) + if (count <= traversed + 1 + diff) { - return new int[] - { - pos - count - 1 + intv[0], +1}; + return new int[] { intv[0] + (count - traversed - 1), +1 }; } else { - count+=1+diff; + traversed += 1 + diff; } } else { - if (pos <= count + 1 - diff) + if (count <= traversed + 1 - diff) { - return new int[] - { - intv[0] - (pos - count - 1), -1}; + return new int[] { intv[0] - (count - traversed - 1), -1 }; } else { - count+=1-diff; + traversed += 1 - diff; } } } - return null;//(diff<0) ? (intv[1]-1) : (intv[0]+1); - } - /** - * find series of intervals mapping from start-end in the From map. - * @param start position in to map - * @param end position in to map - * @return series of ranges in from map - */ - public int[] locateInFrom(int start, int end) { - // inefficient implementation - int fromStart[] = shiftTo(start); - int fromEnd[] = shiftTo(end); // needs to be inclusive of end of symbol position - if (fromStart==null || fromEnd==null) - return null; - int iv[] = getIntervals(fromShifts, fromStart, fromEnd,fromRatio); - return iv; + return null; } /** - * find series of intervals mapping from start-end in the to map. - * @param start position in from map - * @param end position in from map - * @return series of ranges in to map - */ - public int[] locateInTo(int start, int end) { - // inefficient implementation - int toStart[] = shiftFrom(start); - int toEnd[] = shiftFrom(end); - if (toStart==null || toEnd==null) - return null; - int iv[] = getIntervals(toShifts, toStart, toEnd, toRatio); - return iv; - } - /** - * like shift - except returns the intervals in the given vector of shifts which were spanned - * in traversing fromStart to fromEnd - * @param fromShifts2 + * like shift - except returns the intervals in the given vector of shifts + * which were spanned in traversing fromStart to fromEnd + * + * @param shiftFrom * @param fromStart * @param fromEnd * @param fromRatio2 - * @return series of from,to intervals from from first position of starting region to final position of ending region inclusive - */ - private int[] getIntervals(Vector fromShifts2, int[] fromStart, int[] fromEnd, int fromRatio2) - { - int startpos,endpos; - startpos = fromStart[0]; // first position in fromStart - endpos = fromEnd[0]+fromEnd[2]*(fromRatio2-1); // last position in fromEnd - int intv=0,intvSize= fromShifts2.size(); - int iv[],i=0,fs=-1,fe=-1; // containing intervals - while (intv=iv[0] && startpos<=iv[1]) { + * @return series of from,to intervals from from first position of starting + * region to final position of ending region inclusive + */ + protected static int[] getIntervals(List shiftFrom, + int[] fromStart, int[] fromEnd, int fromRatio2) + { + if (fromStart == null || fromEnd == null) + { + return null; + } + int startpos, endpos; + startpos = fromStart[0]; // first position in fromStart + endpos = fromEnd[0]; // last position in fromEnd + int endindx = (fromRatio2 - 1); // additional positions to get to last + // position from endpos + int intv = 0, intvSize = shiftFrom.size(); + int iv[], i = 0, fs = -1, fe_s = -1, fe = -1; // containing intervals + // search intervals to locate ones containing startpos and count endindx + // positions on from endpos + while (intv < intvSize && (fs == -1 || fe == -1)) + { + iv = shiftFrom.get(intv++); + if (fe_s > -1) + { + endpos = iv[0]; // start counting from beginning of interval + endindx--; // inclusive of endpos + } + if (iv[0] <= iv[1]) + { + if (fs == -1 && startpos >= iv[0] && startpos <= iv[1]) + { fs = i; } - if (fe==-1 && endpos>=iv[0] && endpos<=iv[1]) { - fe = i; + if (endpos >= iv[0] && endpos <= iv[1]) + { + if (fe_s == -1) + { + fe_s = i; + } + if (fe_s != -1) + { + if (endpos + endindx <= iv[1]) + { + fe = i; + endpos = endpos + endindx; // end of end token is within this + // interval + } + else + { + endindx -= iv[1] - endpos; // skip all this interval too + } + } } - } else { - if (fs==-1 && startpos<=iv[0] && startpos>=iv[1]) { + } + else + { + if (fs == -1 && startpos <= iv[0] && startpos >= iv[1]) + { fs = i; } - if (fe==-1 && endpos<=iv[0] && endpos>=iv[1]) { - fe = i; + if (endpos <= iv[0] && endpos >= iv[1]) + { + if (fe_s == -1) + { + fe_s = i; + } + if (fe_s != -1) + { + if (endpos - endindx >= iv[1]) + { + fe = i; + endpos = endpos - endindx; // end of end token is within this + // interval + } + else + { + endindx -= endpos - iv[1]; // skip all this interval too + } + } } } i++; } - if (fs==fe && fe==-1) + if (fs == fe && fe == -1) + { return null; - Vector ranges=new Vector(); - if (fs<=fe) { + } + List ranges = new ArrayList<>(); + if (fs <= fe) + { intv = fs; - i=fs; + i = fs; // truncate initial interval - iv = (int[]) fromShifts2.elementAt(intv++); - iv = new int[] { iv[0], iv[1]};// clone - if (i==fs) + iv = shiftFrom.get(intv++); + iv = new int[] { iv[0], iv[1] };// clone + if (i == fs) + { iv[0] = startpos; - while (i!=fe) { - ranges.addElement(iv); // add initial range - iv = (int[]) fromShifts2.elementAt(intv++); // get next interval - iv = new int[] { iv[0], iv[1]};// clone + } + while (i != fe) + { + ranges.add(iv); // add initial range + iv = shiftFrom.get(intv++); // get next interval + iv = new int[] { iv[0], iv[1] };// clone i++; } - if (i==fe) + if (i == fe) + { iv[1] = endpos; - ranges.addElement(iv); // add only - or final range - } else { + } + ranges.add(iv); // add only - or final range + } + else + { // walk from end of interval. - i=fromShifts2.size()-1; - while (i>fs) { + i = shiftFrom.size() - 1; + while (i > fs) + { i--; } - iv = (int[]) fromShifts2.elementAt(i); - iv = new int[] { iv[1], iv[0]};// reverse and clone + iv = shiftFrom.get(i); + iv = new int[] { iv[1], iv[0] };// reverse and clone // truncate initial interval - if (i==fs) + if (i == fs) { iv[0] = startpos; } - while (--i!=fe) { // fix apparent logic bug when fe==-1 - ranges.addElement(iv); // add (truncated) reversed interval - iv = (int[]) fromShifts2.elementAt(i); + while (--i != fe) + { // fix apparent logic bug when fe==-1 + ranges.add(iv); // add (truncated) reversed interval + iv = shiftFrom.get(i); iv = new int[] { iv[1], iv[0] }; // reverse and clone } - if (i==fe) { + if (i == fe) + { // interval is already reversed iv[1] = endpos; } - ranges.addElement(iv); // add only - or final range + ranges.add(iv); // add only - or final range } // create array of start end intervals. int[] range = null; - if (ranges!=null && ranges.size()>0) + if (ranges != null && ranges.size() > 0) { - range = new int[ranges.size()*2]; + range = new int[ranges.size() * 2]; intv = 0; - intvSize=ranges.size(); - i=0; - while (intv addTo) { - for (int from = 1; from <= 25; from++) + /* + * list is empty - add to it! + */ + if (addTo.size() == 0) + { + addTo.add(range); + return; + } + + int[] last = addTo.get(addTo.size() - 1); + boolean lastForward = last[1] >= last[0]; + boolean newForward = range[1] >= range[0]; + + /* + * contiguous range in the same direction - just update endpoint + */ + if (lastForward == newForward && last[1] == range[0]) + { + last[1] = range[1]; + return; + } + + /* + * next range starts at +1 in forward sense - update endpoint + */ + if (lastForward && newForward && range[0] == last[1] + 1) { - int[] too=ml.shiftFrom(from); - System.out.print("ShiftFrom("+from+")=="); - if (too==null) + last[1] = range[1]; + return; + } + + /* + * next range starts at -1 in reverse sense - update endpoint + */ + if (!lastForward && !newForward && range[0] == last[1] - 1) + { + last[1] = range[1]; + return; + } + + /* + * just add the new range + */ + addTo.add(range); + } + + /** + * Returns true if mapping is from forward strand, false if from reverse + * strand. Result is just based on the first 'from' range that is not a single + * position. Default is true unless proven to be false. Behaviour is not well + * defined if the mapping has a mixture of forward and reverse ranges. + * + * @return + */ + public boolean isFromForwardStrand() + { + return isForwardStrand(getFromRanges()); + } + + /** + * Returns true if mapping is to forward strand, false if to reverse strand. + * Result is just based on the first 'to' range that is not a single position. + * Default is true unless proven to be false. Behaviour is not well defined if + * the mapping has a mixture of forward and reverse ranges. + * + * @return + */ + public boolean isToForwardStrand() + { + return isForwardStrand(getToRanges()); + } + + /** + * A helper method that returns true unless at least one range has start > + * end. Behaviour is undefined for a mixture of forward and reverse ranges. + * + * @param ranges + * @return + */ + private boolean isForwardStrand(List ranges) + { + boolean forwardStrand = true; + for (int[] range : ranges) + { + if (range[1] > range[0]) { - System.out.print("NaN\n"); + break; // forward strand confirmed } - else + else if (range[1] < range[0]) { - System.out.print(too[0]+" % "+too[1]+" ("+too[2]+")"); - System.out.print("\t+--+\t"); - int[] toofrom=ml.shiftTo(too[0]); - if (toofrom != null) - { - if (toofrom[0]!=from) - { - System.err.println("Mapping not reflexive:" + from + " " + too[0] + - "->" + toofrom[0]); - } - System.out.println("ShiftTo(" + too[0] + ")==" + toofrom[0] + " % " + - toofrom[1]+" ("+toofrom[2]+")"); - } - else - { - System.out.println("ShiftTo(" + too[0] + ")==" + - "NaN! - not Bijective Mapping!"); - } + forwardStrand = false; + break; // reverse strand confirmed } } - int mmap[][] = ml.makeFromMap(); - System.out.println("FromMap : (" + mmap[0][0] + " " + mmap[0][1] + " " + - mmap[0][2] + " " + mmap[0][3] + " "); - for (int i = 1; i <= mmap[1].length; i++) + return forwardStrand; + } + + /** + * + * @return true if from, or to is a three to 1 mapping + */ + public boolean isTripletMap() + { + return (toRatio == 3 && fromRatio == 1) + || (fromRatio == 3 && toRatio == 1); + } + + /** + * Returns a map which is the composite of this one and the input map. That + * is, the output map has the fromRanges of this map, and its toRanges are the + * toRanges of this map as transformed by the input map. + *

+ * Returns null if the mappings cannot be traversed (not all toRanges of this + * map correspond to fromRanges of the input), or if this.toRatio does not + * match map.fromRatio. + * + *

+   * Example 1:
+   *    this:   from [1-100] to [501-600]
+   *    input:  from [10-40] to [60-90]
+   *    output: from [10-40] to [560-590]
+   * Example 2 ('reverse strand exons'):
+   *    this:   from [1-100] to [2000-1951], [1000-951] // transcript to loci
+   *    input:  from [1-50]  to [41-90] // CDS to transcript
+   *    output: from [10-40] to [1960-1951], [1000-971] // CDS to gene loci
+   * 
+ * + * @param map + * @return + */ + public MapList traverse(MapList map) + { + if (map == null) { - if (mmap[1][i - 1] == -1) - { - System.out.print(i+"=XXX"); + return null; + } - } - else + /* + * compound the ratios by this rule: + * A:B with M:N gives A*M:B*N + * reduced by greatest common divisor + * so 1:3 with 3:3 is 3:9 or 1:3 + * 1:3 with 3:1 is 3:3 or 1:1 + * 1:3 with 1:3 is 1:9 + * 2:5 with 3:7 is 6:35 + */ + int outFromRatio = getFromRatio() * map.getFromRatio(); + int outToRatio = getToRatio() * map.getToRatio(); + int gcd = MathUtils.gcd(outFromRatio, outToRatio); + outFromRatio /= gcd; + outToRatio /= gcd; + + List toRanges = new ArrayList<>(); + for (int[] range : getToRanges()) + { + int fromLength = Math.abs(range[1] - range[0]) + 1; + int[] transferred = map.locateInTo(range[0], range[1]); + if (transferred == null || transferred.length % 2 != 0) { - System.out.print(i+"="+(mmap[0][2]+mmap[1][i-1])); + return null; } - if (i % 20==0) + + /* + * convert [start1, end1, start2, end2, ...] + * to [[start1, end1], [start2, end2], ...] + */ + int toLength = 0; + for (int i = 0; i < transferred.length;) { - System.out.print("\n"); + toRanges.add(new int[] { transferred[i], transferred[i + 1] }); + toLength += Math.abs(transferred[i + 1] - transferred[i]) + 1; + i += 2; } - else + + /* + * check we mapped the full range - if not, abort + */ + if (fromLength * map.getToRatio() != toLength * map.getFromRatio()) { - System.out.print(","); + return null; } } - //test range function - System.out.print("\nTest locateInFrom\n"); + + return new MapList(getFromRanges(), toRanges, outFromRatio, outToRatio); + } + + /** + * Answers true if the mapping is from one contiguous range to another, else + * false + * + * @return + */ + public boolean isContiguous() + { + return fromShifts.size() == 1 && toShifts.size() == 1; + } + + /** + * <<<<<<< HEAD Returns the [start1, end1, start2, end2, ...] positions in the + * 'from' range that map to positions between {@code start} and {@code end} in + * the 'to' range. Note that for a reverse strand mapping this will return + * ranges with end < start. Returns null if no mapped positions are found in + * start-end. + * + * @param start + * @param end + * @return + */ + public int[] locateInFrom(int start, int end) + { + return mapPositions(start, end, toShifts, fromShifts, toRatio, + fromRatio); + } + + /** + * Returns the [start1, end1, start2, end2, ...] positions in the 'to' range + * that map to positions between {@code start} and {@code end} in the 'from' + * range. Note that for a reverse strand mapping this will return ranges with + * end < start. Returns null if no mapped positions are found in start-end. + * + * @param start + * @param end + * @return + */ + public int[] locateInTo(int start, int end) + { + return mapPositions(start, end, fromShifts, toShifts, fromRatio, + toRatio); + } + + /** + * Helper method that returns the [start1, end1, start2, end2, ...] positions + * in {@code targetRange} that map to positions between {@code start} and + * {@code end} in {@code sourceRange}. Note that for a reverse strand mapping + * this will return ranges with end < start. Returns null if no mapped + * positions are found in start-end. + * + * @param start + * @param end + * @param sourceRange + * @param targetRange + * @param sourceWordLength + * @param targetWordLength + * @return + */ + final static int[] mapPositions(int start, int end, + List sourceRange, List targetRange, + int sourceWordLength, int targetWordLength) + { + if (end < start) + { + int tmp = end; + end = start; + start = tmp; + } + + /* + * traverse sourceRange and mark offsets in targetRange + * of any positions that lie in [start, end] + */ + BitSet offsets = getMappedOffsetsForPositions(start, end, sourceRange, + sourceWordLength, targetWordLength); + + /* + * traverse targetRange and collect positions at the marked offsets + */ + List mapped = getPositionsForOffsets(targetRange, offsets); + + // TODO: or just return the List and adjust calling code to match + return mapped.isEmpty() ? null : MappingUtils.rangeListToArray(mapped); + } + + /** + * Scans the list of {@code ranges} for any values (positions) that lie + * between start and end (inclusive), and records the offsets from + * the start of the list as a BitSet. The offset positions are converted to + * corresponding words in blocks of {@code wordLength2}. + * + *
+   * For example:
+   * 1:1 (e.g. gene to CDS):
+   * ranges { [10-20], [31-40] }, wordLengthFrom = wordLength 2 = 1
+   *   for start = 1, end = 9, returns a BitSet with no bits set
+   *   for start = 1, end = 11, returns a BitSet with bits 0-1 set
+   *   for start = 15, end = 35, returns a BitSet with bits 5-15 set
+   * 1:3 (peptide to codon):
+   * ranges { [1-200] }, wordLengthFrom = 1, wordLength 2 = 3
+   *   for start = 9, end = 9, returns a BitSet with bits 24-26 set
+   * 3:1 (codon to peptide):
+   * ranges { [101-150], [171-180] }, wordLengthFrom = 3, wordLength 2 = 1
+   *   for start = 101, end = 102 (partial first codon), returns a BitSet with bit 0 set
+   *   for start = 150, end = 171 (partial 17th codon), returns a BitSet with bit 16 set
+   * 3:1 (circular DNA to peptide):
+   * ranges { [101-150], [21-30] }, wordLengthFrom = 3, wordLength 2 = 1
+   *   for start = 24, end = 40 (spans codons 18-20), returns a BitSet with bits 17-19 set
+   * 
+ * + * @param start + * @param end + * @param sourceRange + * @param sourceWordLength + * @param targetWordLength + * @return + */ + protected final static BitSet getMappedOffsetsForPositions(int start, + int end, List sourceRange, int sourceWordLength, + int targetWordLength) + { + BitSet overlaps = new BitSet(); + int offset = 0; + final int s1 = sourceRange.size(); + for (int i = 0; i < s1; i++) { - int f=mmap[0][2],t=mmap[0][3]; - while (f<=t) { - System.out.println("Range "+f+" to "+t); - int rng[] = ml.locateInFrom(f,t); - if (rng!=null) - { - for (int i=0; i= range[0]) + { + /* + * forward direction range + */ + if (start <= range[1] && end >= range[0]) { - System.out.println("No range!"); + /* + * overlap + */ + int overlapStart = Math.max(start, range[0]); + overlapStartOffset = offset1 + overlapStart - range[0]; + int overlapEnd = Math.min(end, range[1]); + overlapEndOffset = offset1 + overlapEnd - range[0]; } - System.out.print("\nReversed\n"); - rng = ml.locateInFrom(t,f); - if (rng!=null) + } + else + { + /* + * reverse direction range + */ + if (start <= range[0] && end >= range[1]) { - for (int i=0; i -1) + { + /* + * found an overlap + */ + if (sourceWordLength != targetWordLength) { - System.out.println("No range!"); + /* + * convert any overlap found to whole words in the target range + * (e.g. treat any partial codon overlap as if the whole codon) + */ + overlapStartOffset -= overlapStartOffset % sourceWordLength; + overlapStartOffset = overlapStartOffset / sourceWordLength + * targetWordLength; + + /* + * similar calculation for range end, adding + * (wordLength2 - 1) for end of mapped word + */ + overlapEndOffset -= overlapEndOffset % sourceWordLength; + overlapEndOffset = overlapEndOffset / sourceWordLength + * targetWordLength; + overlapEndOffset += targetWordLength - 1; } - System.out.print("\n"); - f++;t--; + overlaps.set(overlapStartOffset, overlapEndOffset + 1); } + offset += 1 + Math.abs(range[1] - range[0]); } - System.out.print("\n"); - mmap = ml.makeToMap(); - System.out.println("ToMap : (" + mmap[0][0] + " " + mmap[0][1] + " " + - mmap[0][2] + " " + mmap[0][3] + " "); - for (int i = 1; i <= mmap[1].length; i++) + return overlaps; + } + + /** + * Returns a (possibly empty) list of the [start-end] values (positions) at + * offsets in the {@code targetRange} list that are marked by 'on' bits in the + * {@code offsets} bitset. + * + * @param targetRange + * @param offsets + * @return + */ + protected final static List getPositionsForOffsets( + List targetRange, BitSet offsets) + { + List mapped = new ArrayList<>(); + if (offsets.isEmpty()) { - if (mmap[1][i - 1] == -1) - { - System.out.print(i+"=XXX"); + return mapped; + } - } - else - { - System.out.print(i+"="+(mmap[0][2]+mmap[1][i-1])); - } - if (i % 20==0) - { - System.out.print("\n"); - } - else - { - System.out.print(","); - } + /* + * count of positions preceding ranges[i] + */ + int traversed = 0; + + /* + * for each [from-to] range in ranges: + * - find subranges (if any) at marked offsets + * - add the start-end values at the marked positions + */ + final int toAdd = offsets.cardinality(); + int added = 0; + final int s2 = targetRange.size(); + for (int i = 0; added < toAdd && i < s2; i++) + { + int[] range = targetRange.get(i); + added += addOffsetPositions(mapped, traversed, range, offsets); + traversed += Math.abs(range[1] - range[0]) + 1; } - System.out.print("\n"); - //test range function - System.out.print("\nTest locateInTo\n"); + return mapped; + } + + /** + * Helper method that adds any start-end subranges of {@code range} that are + * at offsets in {@code range} marked by set bits in overlaps. + * {@code mapOffset} is added to {@code range} offset positions. Returns the + * count of positions added. + * + * @param mapped + * @param mapOffset + * @param range + * @param overlaps + * @return + */ + final static int addOffsetPositions(List mapped, + final int mapOffset, final int[] range, final BitSet overlaps) + { + final int rangeLength = 1 + Math.abs(range[1] - range[0]); + final int step = range[1] < range[0] ? -1 : 1; + int offsetStart = 0; // offset into range + int added = 0; + + while (offsetStart < rangeLength) { - int f=mmap[0][2],t=mmap[0][3]; - while (f<=t) { - System.out.println("Range "+f+" to "+t); - int rng[] = ml.locateInTo(f,t); - if (rng!=null) { - for (int i=0; i= rangeLength) + { + /* + * no more overlaps, or no more within range[] + */ + return added; } + overlapStart -= mapOffset; + + /* + * end of the overlap range is just before the next clear bit; + * restrict it to end of range if necessary; + * note we may add a reverse strand range here (end < start) + */ + int overlapEnd = overlaps.nextClearBit(mapOffset + overlapStart + 1); + overlapEnd = (overlapEnd == -1) ? rangeLength - 1 + : Math.min(rangeLength - 1, overlapEnd - mapOffset - 1); + int startPosition = range[0] + step * overlapStart; + int endPosition = range[0] + step * overlapEnd; + mapped.add(new int[] { startPosition, endPosition }); + offsetStart = overlapEnd + 1; + added += Math.abs(endPosition - startPosition) + 1; } + return added; } - public static void main(String argv[]) + /* + * Returns the [start, end...] positions in the range mapped from, that are + * mapped to by part or all of the given begin-end of the range mapped to. + * Returns null if begin-end does not overlap any position mapped to. + * + * @param begin + * @param end + * @return + */ + public int[] getOverlapsInFrom(final int begin, final int end) { - MapList ml = new MapList(new int[] - {1, 5, 10, 15, 25, 20}, - new int[] - {51, 1}, 1, 3); - MapList ml1 = new MapList(new int[] - {1, 3, 17, 4}, - new int[] - {51, 1}, 1, 3); - MapList ml2 = new MapList(new int[] { 1, 60 }, - new int[] { 1, 20 }, 3, 1); - // test internal consistency - int to[] = new int[51]; - MapList.testMap(ml, 1, 60); - /* - for (int from=1; from<=51; from++) { - int[] too=ml.shiftTo(from); - int[] toofrom=ml.shiftFrom(too[0]); - System.out.println("ShiftFrom("+from+")=="+too[0]+" % "+too[1]+"\t+-+\tShiftTo("+too[0]+")=="+toofrom[0]+" % "+toofrom[1]); - }*/ - System.out.print("Success?\n"); // if we get here - something must be working! + int[] overlaps = MappingUtils.findOverlap(toShifts, begin, end); + + return overlaps == null ? null : locateInFrom(overlaps[0], overlaps[1]); } + /** + * Returns the [start, end...] positions in the range mapped to, that are + * mapped to by part or all of the given begin-end of the range mapped from. + * Returns null if begin-end does not overlap any position mapped from. * - * @return a MapList whose From range is this maplist's To Range, and vice versa + * @param begin + * @param end + * @return */ - public MapList getInverse() + public int[] getOverlapsInTo(final int begin, final int end) { - return new MapList(getToRanges(), getFromRanges(), getToRatio(), getFromRatio()); + int[] overlaps = MappingUtils.findOverlap(fromShifts, begin, end); + + return overlaps == null ? null : locateInTo(overlaps[0], overlaps[1]); } }