src/jalview/util/MappingUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.util;
  22
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.HashMap;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import java.util.Map;
  29
  30 import jalview.analysis.AlignmentSorter;
  31 import jalview.api.AlignViewportI;
  32 import jalview.bin.Cache;
  33 import jalview.commands.CommandI;
  34 import jalview.commands.EditCommand;
  35 import jalview.commands.EditCommand.Action;
  36 import jalview.commands.EditCommand.Edit;
  37 import jalview.commands.OrderCommand;
  38 import jalview.datamodel.AlignedCodonFrame;
  39 import jalview.datamodel.AlignedCodonFrame.SequenceToSequenceMapping;
  40 import jalview.datamodel.AlignmentI;
  41 import jalview.datamodel.AlignmentOrder;
  42 import jalview.datamodel.ColumnSelection;
  43 import jalview.datamodel.HiddenColumns;
  44 import jalview.datamodel.SearchResultMatchI;
  45 import jalview.datamodel.SearchResults;
  46 import jalview.datamodel.SearchResultsI;
  47 import jalview.datamodel.Sequence;
  48 import jalview.datamodel.SequenceGroup;
  49 import jalview.datamodel.SequenceI;
  50
  51 /**
  52  * Helper methods for manipulations involving sequence mappings.
  53  *
  54  * @author gmcarstairs
  55  *
  56  */
  57 public final class MappingUtils
  58 {
  59
  60   /**
  61    * Helper method to map a CUT or PASTE command.
  62    *
  63    * @param edit
  64    *          the original command
  65    * @param undo
  66    *          if true, the command is to be undone
  67    * @param targetSeqs
  68    *          the mapped sequences to apply the mapped command to
  69    * @param result
  70    *          the mapped EditCommand to add to
  71    * @param mappings
  72    */
  73   protected static void mapCutOrPaste(Edit edit, boolean undo,
  74           List<SequenceI> targetSeqs, EditCommand result,
  75           List<AlignedCodonFrame> mappings)
  76   {
  77     Action action = edit.getAction();
  78     if (undo)
  79     {
  80       action = action.getUndoAction();
  81     }
  82     // TODO write this
  83     Cache.log.error("MappingUtils.mapCutOrPaste not yet implemented");
  84   }
  85
  86   /**
  87    * Returns a new EditCommand representing the given command as mapped to the
  88    * given sequences. If there is no mapping, returns null.
  89    *
  90    * @param command
  91    * @param undo
  92    * @param mapTo
  93    * @param gapChar
  94    * @param mappings
  95    * @return
  96    */
  97   public static EditCommand mapEditCommand(EditCommand command,
  98           boolean undo, final AlignmentI mapTo, char gapChar,
  99           List<AlignedCodonFrame> mappings)
 100   {
 101     /*
 102      * For now, only support mapping from protein edits to cDna
 103      */
 104     if (!mapTo.isNucleotide())
 105     {
 106       return null;
 107     }
 108
 109     /*
 110      * Cache a copy of the target sequences so we can mimic successive edits on
 111      * them. This lets us compute mappings for all edits in the set.
 112      */
 113     Map<SequenceI, SequenceI> targetCopies = new HashMap<>();
 114     for (SequenceI seq : mapTo.getSequences())
 115     {
 116       SequenceI ds = seq.getDatasetSequence();
 117       if (ds != null)
 118       {
 119         final SequenceI copy = new Sequence(seq);
 120         copy.setDatasetSequence(ds);
 121         targetCopies.put(ds, copy);
 122       }
 123     }
 124
 125     /*
 126      * Compute 'source' sequences as they were before applying edits:
 127      */
 128     Map<SequenceI, SequenceI> originalSequences = command.priorState(undo);
 129
 130     EditCommand result = new EditCommand();
 131     Iterator<Edit> edits = command.getEditIterator(!undo);
 132     while (edits.hasNext())
 133     {
 134       Edit edit = edits.next();
 135       if (edit.getAction() == Action.CUT
 136               || edit.getAction() == Action.PASTE)
 137       {
 138         mapCutOrPaste(edit, undo, mapTo.getSequences(), result, mappings);
 139       }
 140       else if (edit.getAction() == Action.INSERT_GAP
 141               || edit.getAction() == Action.DELETE_GAP)
 142       {
 143         mapInsertOrDelete(edit, undo, originalSequences,
 144                 mapTo.getSequences(), targetCopies, gapChar, result,
 145                 mappings);
 146       }
 147     }
 148     return result.getSize() > 0 ? result : null;
 149   }
 150
 151   /**
 152    * Helper method to map an edit command to insert or delete gaps.
 153    *
 154    * @param edit
 155    *          the original command
 156    * @param undo
 157    *          if true, the action is to undo the command
 158    * @param originalSequences
 159    *          the sequences the command acted on
 160    * @param targetSeqs
 161    * @param targetCopies
 162    * @param gapChar
 163    * @param result
 164    *          the new EditCommand to add mapped commands to
 165    * @param mappings
 166    */
 167   protected static void mapInsertOrDelete(Edit edit, boolean undo,
 168           Map<SequenceI, SequenceI> originalSequences,
 169           final List<SequenceI> targetSeqs,
 170           Map<SequenceI, SequenceI> targetCopies, char gapChar,
 171           EditCommand result, List<AlignedCodonFrame> mappings)
 172   {
 173     Action action = edit.getAction();
 174
 175     /*
 176      * Invert sense of action if an Undo.
 177      */
 178     if (undo)
 179     {
 180       action = action.getUndoAction();
 181     }
 182     final int count = edit.getNumber();
 183     final int editPos = edit.getPosition();
 184     for (SequenceI seq : edit.getSequences())
 185     {
 186       /*
 187        * Get residue position at (or to right of) edit location. Note we use our
 188        * 'copy' of the sequence before editing for this.
 189        */
 190       SequenceI ds = seq.getDatasetSequence();
 191       if (ds == null)
 192       {
 193         continue;
 194       }
 195       final SequenceI actedOn = originalSequences.get(ds);
 196       final int seqpos = actedOn.findPosition(editPos);
 197
 198       /*
 199        * Determine all mappings from this position to mapped sequences.
 200        */
 201       SearchResultsI sr = buildSearchResults(seq, seqpos, mappings);
 202
 203       if (!sr.isEmpty())
 204       {
 205         for (SequenceI targetSeq : targetSeqs)
 206         {
 207           ds = targetSeq.getDatasetSequence();
 208           if (ds == null)
 209           {
 210             continue;
 211           }
 212           SequenceI copyTarget = targetCopies.get(ds);
 213           final int[] match = sr.getResults(copyTarget, 0,
 214                   copyTarget.getLength());
 215           if (match != null)
 216           {
 217             final int ratio = 3; // TODO: compute this - how?
 218             final int mappedCount = count * ratio;
 219
 220             /*
 221              * Shift Delete start position left, as it acts on positions to its
 222              * right.
 223              */
 224             int mappedEditPos = action == Action.DELETE_GAP
 225                     ? match[0] - mappedCount
 226                     : match[0];
 227             Edit e = result.new Edit(action, new SequenceI[] { targetSeq },
 228                     mappedEditPos, mappedCount, gapChar);
 229             result.addEdit(e);
 230
 231             /*
 232              * and 'apply' the edit to our copy of its target sequence
 233              */
 234             if (action == Action.INSERT_GAP)
 235             {
 236               copyTarget.setSequence(new String(
 237                       StringUtils.insertCharAt(copyTarget.getSequence(),
 238                               mappedEditPos, mappedCount, gapChar)));
 239             }
 240             else if (action == Action.DELETE_GAP)
 241             {
 242               copyTarget.setSequence(new String(
 243                       StringUtils.deleteChars(copyTarget.getSequence(),
 244                               mappedEditPos, mappedEditPos + mappedCount)));
 245             }
 246           }
 247         }
 248       }
 249       /*
 250        * and 'apply' the edit to our copy of its source sequence
 251        */
 252       if (action == Action.INSERT_GAP)
 253       {
 254         actedOn.setSequence(new String(StringUtils.insertCharAt(
 255                 actedOn.getSequence(), editPos, count, gapChar)));
 256       }
 257       else if (action == Action.DELETE_GAP)
 258       {
 259         actedOn.setSequence(new String(StringUtils.deleteChars(
 260                 actedOn.getSequence(), editPos, editPos + count)));
 261       }
 262     }
 263   }
 264
 265   /**
 266    * Returns a SearchResults object describing the mapped region corresponding
 267    * to the specified sequence position.
 268    *
 269    * @param seq
 270    * @param index
 271    * @param seqmappings
 272    * @return
 273    */
 274   public static SearchResultsI buildSearchResults(SequenceI seq, int index,
 275           List<AlignedCodonFrame> seqmappings)
 276   {
 277     SearchResultsI results = new SearchResults();
 278     addSearchResults(results, seq, index, seqmappings);
 279     return results;
 280   }
 281
 282   /**
 283    * Adds entries to a SearchResults object describing the mapped region
 284    * corresponding to the specified sequence position.
 285    *
 286    * @param results
 287    * @param seq
 288    * @param index
 289    * @param seqmappings
 290    */
 291   public static void addSearchResults(SearchResultsI results, SequenceI seq,
 292           int index, List<AlignedCodonFrame> seqmappings)
 293   {
 294     if (index >= seq.getStart() && index <= seq.getEnd())
 295     {
 296       for (AlignedCodonFrame acf : seqmappings)
 297       {
 298         acf.markMappedRegion(seq, index, results);
 299       }
 300     }
 301   }
 302
 303   /**
 304    * Returns a (possibly empty) SequenceGroup containing any sequences in the
 305    * mapped viewport corresponding to the given group in the source viewport.
 306    *
 307    * @param sg
 308    * @param mapFrom
 309    * @param mapTo
 310    * @return
 311    */
 312   public static SequenceGroup mapSequenceGroup(final SequenceGroup sg,
 313           final AlignViewportI mapFrom, final AlignViewportI mapTo)
 314   {
 315     /*
 316      * Note the SequenceGroup holds aligned sequences, the mappings hold dataset
 317      * sequences.
 318      */
 319     boolean targetIsNucleotide = mapTo.isNucleotide();
 320     AlignViewportI protein = targetIsNucleotide ? mapFrom : mapTo;
 321     List<AlignedCodonFrame> codonFrames = protein.getAlignment()
 322             .getCodonFrames();
 323     /*
 324      * Copy group name, colours etc, but not sequences or sequence colour scheme
 325      */
 326     SequenceGroup mappedGroup = new SequenceGroup(sg);
 327     mappedGroup.setColourScheme(mapTo.getGlobalColourScheme());
 328     mappedGroup.clear();
 329
 330     int minStartCol = -1;
 331     int maxEndCol = -1;
 332     final int selectionStartRes = sg.getStartRes();
 333     final int selectionEndRes = sg.getEndRes();
 334     for (SequenceI selected : sg.getSequences())
 335     {
 336       /*
 337        * Find the widest range of non-gapped positions in the selection range
 338        */
 339       int firstUngappedPos = selectionStartRes;
 340       while (firstUngappedPos <= selectionEndRes
 341               && Comparison.isGap(selected.getCharAt(firstUngappedPos)))
 342       {
 343         firstUngappedPos++;
 344       }
 345
 346       boolean allGapped = (firstUngappedPos > selectionEndRes);
 347
 348       int lastUngappedPos = selectionEndRes;
 349       if (!allGapped)
 350       {
 351         while (lastUngappedPos >= selectionStartRes
 352                 && Comparison.isGap(selected.getCharAt(lastUngappedPos)))
 353         {
 354           lastUngappedPos--;
 355         }
 356       }
 357
 358       /*
 359        * Find the selected start/end residue positions in sequence
 360        */
 361       int startResiduePos = allGapped ? 0 : selected.findPosition(firstUngappedPos);
 362       int endResiduePos = allGapped ? 0 : selected.findPosition(lastUngappedPos);
 363
 364       for (AlignedCodonFrame acf : codonFrames)
 365       {
 366         for (SequenceI seq : mapTo.getAlignment().getSequences())
 367         {
 368           SequenceI peptide = targetIsNucleotide ? selected : seq;
 369           SequenceI cds = targetIsNucleotide ? seq : selected;
 370           SequenceToSequenceMapping s2s = acf.getCoveringMapping(cds,
 371                   peptide);
 372           if (s2s == null)
 373           {
 374             continue;
 375           }
 376           mappedGroup.addSequence(seq, false);
 377           if (allGapped)
 378           {
 379             /*
 380              * sequence is mapped but includes no mapped residues
 381              */
 382             continue;
 383           }
 384           int mappedStartResidue = 0;
 385           int mappedEndResidue = 0;
 386           List<AlignedCodonFrame> mapping = Arrays.asList(acf);
 387           SearchResultsI sr = buildSearchResults(selected, startResiduePos,
 388                   mapping);
 389           for (SearchResultMatchI m : sr.getResults())
 390           {
 391             mappedStartResidue = m.getStart();
 392             mappedEndResidue = m.getEnd();
 393           }
 394           sr = buildSearchResults(selected, endResiduePos, mapping);
 395           for (SearchResultMatchI m : sr.getResults())
 396           {
 397             mappedStartResidue = Math.min(mappedStartResidue, m.getStart());
 398             mappedEndResidue = Math.max(mappedEndResidue, m.getEnd());
 399           }
 400
 401           /*
 402            * Find the mapped aligned columns, save the range. Note findIndex
 403            * returns a base 1 position, SequenceGroup uses base 0
 404            */
 405           int mappedStartCol = seq.findIndex(mappedStartResidue) - 1;
 406           minStartCol = minStartCol == -1 ? mappedStartCol
 407                   : Math.min(minStartCol, mappedStartCol);
 408           int mappedEndCol = seq.findIndex(mappedEndResidue) - 1;
 409           maxEndCol = maxEndCol == -1 ? mappedEndCol
 410                   : Math.max(maxEndCol, mappedEndCol);
 411         }
 412       }
 413     }
 414     mappedGroup.setStartRes(minStartCol < 0 ? 0 : minStartCol);
 415     mappedGroup.setEndRes(maxEndCol < 0 ? 0 : maxEndCol);
 416     return mappedGroup;
 417   }
 418
 419   /**
 420    * Returns an OrderCommand equivalent to the given one, but acting on mapped
 421    * sequences as described by the mappings, or null if no mapping can be made.
 422    *
 423    * @param command
 424    *          the original order command
 425    * @param undo
 426    *          if true, the action is to undo the sort
 427    * @param mapTo
 428    *          the alignment we are mapping to
 429    * @param mappings
 430    *          the mappings available
 431    * @return
 432    */
 433   public static CommandI mapOrderCommand(OrderCommand command, boolean undo,
 434           AlignmentI mapTo, List<AlignedCodonFrame> mappings)
 435   {
 436     SequenceI[] sortOrder = command.getSequenceOrder(undo);
 437     List<SequenceI> mappedOrder = new ArrayList<>();
 438     int j = 0;
 439
 440     /*
 441      * Assumption: we are only interested in a cDNA/protein mapping; refactor in
 442      * future if we want to support sorting (c)dna as (c)dna or protein as
 443      * protein
 444      */
 445     boolean mappingToNucleotide = mapTo.isNucleotide();
 446     for (SequenceI seq : sortOrder)
 447     {
 448       for (AlignedCodonFrame acf : mappings)
 449       {
 450           for (SequenceI seq2 : mapTo.getSequences())
 451           {
 452             /*
 453              * the corresponding peptide / CDS is the one for which there is
 454              * a complete ('covering') mapping to 'seq'
 455              */
 456             SequenceI peptide = mappingToNucleotide ? seq2 : seq;
 457             SequenceI cds = mappingToNucleotide ? seq : seq2;
 458             SequenceToSequenceMapping s2s = acf.getCoveringMapping(cds,
 459                     peptide);
 460             if (s2s != null)
 461             {
 462               mappedOrder.add(seq2);
 463               j++;
 464               break;
 465             }
 466           }
 467       }
 468     }
 469
 470     /*
 471      * Return null if no mappings made.
 472      */
 473     if (j == 0)
 474     {
 475       return null;
 476     }
 477
 478     /*
 479      * Add any unmapped sequences on the end of the sort in their original
 480      * ordering.
 481      */
 482     if (j < mapTo.getHeight())
 483     {
 484       for (SequenceI seq : mapTo.getSequences())
 485       {
 486         if (!mappedOrder.contains(seq))
 487         {
 488           mappedOrder.add(seq);
 489         }
 490       }
 491     }
 492
 493     /*
 494      * Have to sort the sequences before constructing the OrderCommand - which
 495      * then resorts them?!?
 496      */
 497     final SequenceI[] mappedOrderArray = mappedOrder
 498             .toArray(new SequenceI[mappedOrder.size()]);
 499     SequenceI[] oldOrder = mapTo.getSequencesArray();
 500     AlignmentSorter.sortBy(mapTo, new AlignmentOrder(mappedOrderArray));
 501     final OrderCommand result = new OrderCommand(command.getDescription(),
 502             oldOrder, mapTo);
 503     return result;
 504   }
 505
 506   /**
 507    * Returns a ColumnSelection in the 'mapTo' view which corresponds to the
 508    * given selection in the 'mapFrom' view. We assume one is nucleotide, the
 509    * other is protein (and holds the mappings from codons to protein residues).
 510    *
 511    * @param colsel
 512    * @param mapFrom
 513    * @param mapTo
 514    * @return
 515    */
 516   public static void mapColumnSelection(ColumnSelection colsel,
 517           HiddenColumns hiddencols, AlignViewportI mapFrom,
 518           AlignViewportI mapTo, ColumnSelection newColSel,
 519           HiddenColumns newHidden)
 520   {
 521     boolean targetIsNucleotide = mapTo.isNucleotide();
 522     AlignViewportI protein = targetIsNucleotide ? mapFrom : mapTo;
 523     List<AlignedCodonFrame> codonFrames = protein.getAlignment()
 524             .getCodonFrames();
 525
 526     if (colsel == null)
 527     {
 528       return;
 529     }
 530
 531     char fromGapChar = mapFrom.getAlignment().getGapCharacter();
 532
 533     /*
 534      * For each mapped column, find the range of columns that residues in that
 535      * column map to.
 536      */
 537     List<SequenceI> fromSequences = mapFrom.getAlignment().getSequences();
 538     List<SequenceI> toSequences = mapTo.getAlignment().getSequences();
 539
 540     for (Integer sel : colsel.getSelected())
 541     {
 542       mapColumn(sel.intValue(), codonFrames, newColSel, fromSequences,
 543               toSequences, fromGapChar);
 544     }
 545
 546     Iterator<int[]> regions = hiddencols.iterator();
 547     while (regions.hasNext())
 548     {
 549       mapHiddenColumns(regions.next(), codonFrames, newHidden,
 550               fromSequences, toSequences, fromGapChar);
 551     }
 552     return;
 553   }
 554
 555   /**
 556    * Helper method that maps a [start, end] hidden column range to its mapped
 557    * equivalent
 558    *
 559    * @param hidden
 560    * @param mappings
 561    * @param mappedColumns
 562    * @param fromSequences
 563    * @param toSequences
 564    * @param fromGapChar
 565    */
 566   protected static void mapHiddenColumns(int[] hidden,
 567           List<AlignedCodonFrame> mappings, HiddenColumns mappedColumns,
 568           List<SequenceI> fromSequences, List<SequenceI> toSequences,
 569           char fromGapChar)
 570   {
 571     for (int col = hidden[0]; col <= hidden[1]; col++)
 572     {
 573       int[] mappedTo = findMappedColumns(col, mappings, fromSequences,
 574               toSequences, fromGapChar);
 575
 576       /*
 577        * Add the range of hidden columns to the mapped selection (converting
 578        * base 1 to base 0).
 579        */
 580       if (mappedTo != null)
 581       {
 582         mappedColumns.hideColumns(mappedTo[0] - 1, mappedTo[1] - 1);
 583       }
 584     }
 585   }
 586
 587   /**
 588    * Helper method to map one column selection
 589    *
 590    * @param col
 591    *          the column number (base 0)
 592    * @param mappings
 593    *          the sequence mappings
 594    * @param mappedColumns
 595    *          the mapped column selections to add to
 596    * @param fromSequences
 597    * @param toSequences
 598    * @param fromGapChar
 599    */
 600   protected static void mapColumn(int col, List<AlignedCodonFrame> mappings,
 601           ColumnSelection mappedColumns, List<SequenceI> fromSequences,
 602           List<SequenceI> toSequences, char fromGapChar)
 603   {
 604     int[] mappedTo = findMappedColumns(col, mappings, fromSequences,
 605             toSequences, fromGapChar);
 606
 607     /*
 608      * Add the range of mapped columns to the mapped selection (converting
 609      * base 1 to base 0). Note that this may include intron-only regions which
 610      * lie between the start and end ranges of the selection.
 611      */
 612     if (mappedTo != null)
 613     {
 614       for (int i = mappedTo[0]; i <= mappedTo[1]; i++)
 615       {
 616         mappedColumns.addElement(i - 1);
 617       }
 618     }
 619   }
 620
 621   /**
 622    * Helper method to find the range of columns mapped to from one column.
 623    * Returns the maximal range of columns mapped to from all sequences in the
 624    * source column, or null if no mappings were found.
 625    *
 626    * @param col
 627    * @param mappings
 628    * @param fromSequences
 629    * @param toSequences
 630    * @param fromGapChar
 631    * @return
 632    */
 633   protected static int[] findMappedColumns(int col,
 634           List<AlignedCodonFrame> mappings, List<SequenceI> fromSequences,
 635           List<SequenceI> toSequences, char fromGapChar)
 636   {
 637     int[] mappedTo = new int[] { Integer.MAX_VALUE, Integer.MIN_VALUE };
 638     boolean found = false;
 639
 640     /*
 641      * For each sequence in the 'from' alignment
 642      */
 643     for (SequenceI fromSeq : fromSequences)
 644     {
 645       /*
 646        * Ignore gaps (unmapped anyway)
 647        */
 648       if (fromSeq.getCharAt(col) == fromGapChar)
 649       {
 650         continue;
 651       }
 652
 653       /*
 654        * Get the residue position and find the mapped position.
 655        */
 656       int residuePos = fromSeq.findPosition(col);
 657       SearchResultsI sr = buildSearchResults(fromSeq, residuePos, mappings);
 658       for (SearchResultMatchI m : sr.getResults())
 659       {
 660         int mappedStartResidue = m.getStart();
 661         int mappedEndResidue = m.getEnd();
 662         SequenceI mappedSeq = m.getSequence();
 663
 664         /*
 665          * Locate the aligned sequence whose dataset is mappedSeq. TODO a
 666          * datamodel that can do this efficiently.
 667          */
 668         for (SequenceI toSeq : toSequences)
 669         {
 670           if (toSeq.getDatasetSequence() == mappedSeq
 671                   && mappedStartResidue >= toSeq.getStart()
 672                   && mappedEndResidue <= toSeq.getEnd())
 673           {
 674             int mappedStartCol = toSeq.findIndex(mappedStartResidue);
 675             int mappedEndCol = toSeq.findIndex(mappedEndResidue);
 676             mappedTo[0] = Math.min(mappedTo[0], mappedStartCol);
 677             mappedTo[1] = Math.max(mappedTo[1], mappedEndCol);
 678             found = true;
 679             break;
 680             // note: remove break if we ever want to map one to many sequences
 681           }
 682         }
 683       }
 684     }
 685     return found ? mappedTo : null;
 686   }
 687
 688   /**
 689    * Returns the mapped codon or codons for a given aligned sequence column
 690    * position (base 0).
 691    *
 692    * @param seq
 693    *          an aligned peptide sequence
 694    * @param col
 695    *          an aligned column position (base 0)
 696    * @param mappings
 697    *          a set of codon mappings
 698    * @return the bases of the mapped codon(s) in the cDNA dataset sequence(s),
 699    *         or an empty list if none found
 700    */
 701   public static List<char[]> findCodonsFor(SequenceI seq, int col,
 702           List<AlignedCodonFrame> mappings)
 703   {
 704     List<char[]> result = new ArrayList<>();
 705     int dsPos = seq.findPosition(col);
 706     for (AlignedCodonFrame mapping : mappings)
 707     {
 708       if (mapping.involvesSequence(seq))
 709       {
 710         List<char[]> codons = mapping
 711                 .getMappedCodons(seq.getDatasetSequence(), dsPos);
 712         if (codons != null)
 713         {
 714           result.addAll(codons);
 715         }
 716       }
 717     }
 718     return result;
 719   }
 720
 721   /**
 722    * Converts a series of [start, end] range pairs into an array of individual
 723    * positions. This also caters for 'reverse strand' (start > end) cases.
 724    *
 725    * @param ranges
 726    * @return
 727    */
 728   public static int[] flattenRanges(int[] ranges)
 729   {
 730     /*
 731      * Count how many positions altogether
 732      */
 733     int count = 0;
 734     for (int i = 0; i < ranges.length - 1; i += 2)
 735     {
 736       count += Math.abs(ranges[i + 1] - ranges[i]) + 1;
 737     }
 738
 739     int[] result = new int[count];
 740     int k = 0;
 741     for (int i = 0; i < ranges.length - 1; i += 2)
 742     {
 743       int from = ranges[i];
 744       final int to = ranges[i + 1];
 745       int step = from <= to ? 1 : -1;
 746       do
 747       {
 748         result[k++] = from;
 749         from += step;
 750       } while (from != to + step);
 751     }
 752     return result;
 753   }
 754
 755   /**
 756    * Returns a list of any mappings that are from or to the given (aligned or
 757    * dataset) sequence.
 758    *
 759    * @param sequence
 760    * @param mappings
 761    * @return
 762    */
 763   public static List<AlignedCodonFrame> findMappingsForSequence(
 764           SequenceI sequence, List<AlignedCodonFrame> mappings)
 765   {
 766     return findMappingsForSequenceAndOthers(sequence, mappings, null);
 767   }
 768
 769   /**
 770    * Returns a list of any mappings that are from or to the given (aligned or
 771    * dataset) sequence, optionally limited to mappings involving one of a given
 772    * list of sequences.
 773    *
 774    * @param sequence
 775    * @param mappings
 776    * @param filterList
 777    * @return
 778    */
 779   public static List<AlignedCodonFrame> findMappingsForSequenceAndOthers(
 780           SequenceI sequence, List<AlignedCodonFrame> mappings,
 781           List<SequenceI> filterList)
 782   {
 783     List<AlignedCodonFrame> result = new ArrayList<>();
 784     if (sequence == null || mappings == null)
 785     {
 786       return result;
 787     }
 788     for (AlignedCodonFrame mapping : mappings)
 789     {
 790       if (mapping.involvesSequence(sequence))
 791       {
 792         if (filterList != null)
 793         {
 794           for (SequenceI otherseq : filterList)
 795           {
 796             SequenceI otherDataset = otherseq.getDatasetSequence();
 797             if (otherseq == sequence
 798                     || otherseq == sequence.getDatasetSequence()
 799                     || (otherDataset != null && (otherDataset == sequence
 800                             || otherDataset == sequence
 801                                     .getDatasetSequence())))
 802             {
 803               // skip sequences in subset which directly relate to sequence
 804               continue;
 805             }
 806             if (mapping.involvesSequence(otherseq))
 807             {
 808               // selected a mapping contained in subselect alignment
 809               result.add(mapping);
 810               break;
 811             }
 812           }
 813         }
 814         else
 815         {
 816           result.add(mapping);
 817         }
 818       }
 819     }
 820     return result;
 821   }
 822
 823   /**
 824    * Returns the total length of the supplied ranges, which may be as single
 825    * [start, end] or multiple [start, end, start, end ...]
 826    *
 827    * @param ranges
 828    * @return
 829    */
 830   public static int getLength(List<int[]> ranges)
 831   {
 832     if (ranges == null)
 833     {
 834       return 0;
 835     }
 836     int length = 0;
 837     for (int[] range : ranges)
 838     {
 839       if (range.length % 2 != 0)
 840       {
 841         Cache.log.error(
 842                 "Error unbalance start/end ranges: " + ranges.toString());
 843         return 0;
 844       }
 845       for (int i = 0; i < range.length - 1; i += 2)
 846       {
 847         length += Math.abs(range[i + 1] - range[i]) + 1;
 848       }
 849     }
 850     return length;
 851   }
 852
 853   /**
 854    * Answers true if any range includes the given value
 855    *
 856    * @param ranges
 857    * @param value
 858    * @return
 859    */
 860   public static boolean contains(List<int[]> ranges, int value)
 861   {
 862     if (ranges == null)
 863     {
 864       return false;
 865     }
 866     for (int[] range : ranges)
 867     {
 868       if (range[1] >= range[0] && value >= range[0] && value <= range[1])
 869       {
 870         /*
 871          * value within ascending range
 872          */
 873         return true;
 874       }
 875       if (range[1] < range[0] && value <= range[0] && value >= range[1])
 876       {
 877         /*
 878          * value within descending range
 879          */
 880         return true;
 881       }
 882     }
 883     return false;
 884   }
 885
 886   /**
 887    * Removes a specified number of positions from the start of a ranges list.
 888    * For example, could be used to adjust cds ranges to allow for an incomplete
 889    * start codon. Subranges are removed completely, or their start positions
 890    * adjusted, until the required number of positions has been removed from the
 891    * range. Reverse strand ranges are supported. The input array is not
 892    * modified.
 893    *
 894    * @param removeCount
 895    * @param ranges
 896    *          an array of [start, end, start, end...] positions
 897    * @return a new array with the first removeCount positions removed
 898    */
 899   public static int[] removeStartPositions(int removeCount,
 900           final int[] ranges)
 901   {
 902     if (removeCount <= 0)
 903     {
 904       return ranges;
 905     }
 906
 907     int[] copy = Arrays.copyOf(ranges, ranges.length);
 908     int sxpos = -1;
 909     int cdspos = 0;
 910     for (int x = 0; x < copy.length && sxpos == -1; x += 2)
 911     {
 912       cdspos += Math.abs(copy[x + 1] - copy[x]) + 1;
 913       if (removeCount < cdspos)
 914       {
 915         /*
 916          * we have removed enough, time to finish
 917          */
 918         sxpos = x;
 919
 920         /*
 921          * increment start of first exon, or decrement if reverse strand
 922          */
 923         if (copy[x] <= copy[x + 1])
 924         {
 925           copy[x] = copy[x + 1] - cdspos + removeCount + 1;
 926         }
 927         else
 928         {
 929           copy[x] = copy[x + 1] + cdspos - removeCount - 1;
 930         }
 931         break;
 932       }
 933     }
 934
 935     if (sxpos > 0)
 936     {
 937       /*
 938        * we dropped at least one entire sub-range - compact the array
 939        */
 940       int[] nxon = new int[copy.length - sxpos];
 941       System.arraycopy(copy, sxpos, nxon, 0, copy.length - sxpos);
 942       return nxon;
 943     }
 944     return copy;
 945   }
 946
 947   /**
 948    * Answers true if range's start-end positions include those of queryRange,
 949    * where either range might be in reverse direction, else false
 950    *
 951    * @param range
 952    *          a start-end range
 953    * @param queryRange
 954    *          a candidate subrange of range (start2-end2)
 955    * @return
 956    */
 957   public static boolean rangeContains(int[] range, int[] queryRange)
 958   {
 959     if (range == null || queryRange == null || range.length != 2
 960             || queryRange.length != 2)
 961     {
 962       /*
 963        * invalid arguments
 964        */
 965       return false;
 966     }
 967
 968     int min = Math.min(range[0], range[1]);
 969     int max = Math.max(range[0], range[1]);
 970
 971     return (min <= queryRange[0] && max >= queryRange[0]
 972             && min <= queryRange[1] && max >= queryRange[1]);
 973   }
 974
 975   /**
 976    * Removes the specified number of positions from the given ranges. Provided
 977    * to allow a stop codon to be stripped from a CDS sequence so that it matches
 978    * the peptide translation length.
 979    *
 980    * @param positions
 981    * @param ranges
 982    *          a list of (single) [start, end] ranges
 983    * @return
 984    */
 985   public static void removeEndPositions(int positions, List<int[]> ranges)
 986   {
 987     int toRemove = positions;
 988     Iterator<int[]> it = new ReverseListIterator<>(ranges);
 989     while (toRemove > 0)
 990     {
 991       int[] endRange = it.next();
 992       if (endRange.length != 2)
 993       {
 994         /*
 995          * not coded for [start1, end1, start2, end2, ...]
 996          */
 997         Cache.log.error(
 998                 "MappingUtils.removeEndPositions doesn't handle multiple  ranges");
 999         return;
1000       }
1001
1002       int length = endRange[1] - endRange[0] + 1;
1003       if (length <= 0)
1004       {
1005         /*
1006          * not coded for a reverse strand range (end < start)
1007          */
1008         Cache.log.error(
1009                 "MappingUtils.removeEndPositions doesn't handle reverse strand");
1010         return;
1011       }
1012       if (length > toRemove)
1013       {
1014         endRange[1] -= toRemove;
1015         toRemove = 0;
1016       }
1017       else
1018       {
1019         toRemove -= length;
1020         it.remove();
1021       }
1022     }
1023   }
1024
1025   /**
1026    * Converts a list of [start, end] ranges to a single array of [start, end,
1027    * start, end ...]
1028    *
1029    * @param ranges
1030    * @return
1031    */
1032   public static int[] listToArray(List<int[]> ranges)
1033   {
1034     int[] result = new int[ranges.size() * 2];
1035     int i = 0;
1036     for (int[] range : ranges)
1037     {
1038       result[i++] = range[0];
1039       result[i++] = range[1];
1040     }
1041     return result;
1042   }
1043
1044   /**
1045    * Returns the maximal start-end positions in the given (ordered) list of
1046    * ranges which is overlapped by the given begin-end range, or null if there
1047    * is no overlap.
1048    *
1049    * <pre>
1050    * Examples:
1051    *   if ranges is {[4, 8], [10, 12], [16, 19]}
1052    * then
1053    *   findOverlap(ranges, 1, 20) == [4, 19]
1054    *   findOverlap(ranges, 6, 11) == [6, 11]
1055    *   findOverlap(ranges, 9, 15) == [10, 12]
1056    *   findOverlap(ranges, 13, 15) == null
1057    * </pre>
1058    *
1059    * @param ranges
1060    * @param begin
1061    * @param end
1062    * @return
1063    */
1064   protected static int[] findOverlap(List<int[]> ranges, final int begin,
1065           final int end)
1066   {
1067     boolean foundStart = false;
1068     int from = 0;
1069     int to = 0;
1070
1071     /*
1072      * traverse the ranges to find the first position (if any) >= begin,
1073      * and the last position (if any) <= end
1074      */
1075     for (int[] range : ranges)
1076     {
1077       if (!foundStart)
1078       {
1079         if (range[0] >= begin)
1080         {
1081           /*
1082            * first range that starts with, or follows, begin
1083            */
1084           foundStart = true;
1085           from = Math.max(range[0], begin);
1086         }
1087         else if (range[1] >= begin)
1088         {
1089           /*
1090            * first range that contains begin
1091            */
1092           foundStart = true;
1093           from = begin;
1094         }
1095       }
1096
1097       if (range[0] <= end)
1098       {
1099         to = Math.min(end, range[1]);
1100       }
1101     }
1102
1103     return foundStart && to >= from ? new int[] { from, to } : null;
1104   }
1105 }