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       /*
 347        * If this sequence is only gaps in the selected range, skip it
 348        */
 349       if (firstUngappedPos > selectionEndRes)
 350       {
 351         continue;
 352       }
 353
 354       int lastUngappedPos = selectionEndRes;
 355       while (lastUngappedPos >= selectionStartRes
 356               && Comparison.isGap(selected.getCharAt(lastUngappedPos)))
 357       {
 358         lastUngappedPos--;
 359       }
 360
 361       /*
 362        * Find the selected start/end residue positions in sequence
 363        */
 364       int startResiduePos = selected.findPosition(firstUngappedPos);
 365       int endResiduePos = selected.findPosition(lastUngappedPos);
 366
 367       for (AlignedCodonFrame acf : codonFrames)
 368       {
 369         for (SequenceI seq : mapTo.getAlignment().getSequences())
 370         {
 371           SequenceI peptide = targetIsNucleotide ? selected : seq;
 372           SequenceI cds = targetIsNucleotide ? seq : selected;
 373           SequenceToSequenceMapping s2s = acf.getCoveringMapping(cds,
 374                   peptide);
 375           if (s2s == null)
 376           {
 377             continue;
 378           }
 379           int mappedStartResidue = 0;
 380           int mappedEndResidue = 0;
 381           List<AlignedCodonFrame> mapping = Arrays.asList(acf);
 382           SearchResultsI sr = buildSearchResults(selected, startResiduePos,
 383                   mapping);
 384           for (SearchResultMatchI m : sr.getResults())
 385           {
 386             mappedStartResidue = m.getStart();
 387             mappedEndResidue = m.getEnd();
 388           }
 389           sr = buildSearchResults(selected, endResiduePos, mapping);
 390           for (SearchResultMatchI m : sr.getResults())
 391           {
 392             mappedStartResidue = Math.min(mappedStartResidue, m.getStart());
 393             mappedEndResidue = Math.max(mappedEndResidue, m.getEnd());
 394           }
 395
 396           /*
 397            * Find the mapped aligned columns, save the range. Note findIndex
 398            * returns a base 1 position, SequenceGroup uses base 0
 399            */
 400           int mappedStartCol = seq.findIndex(mappedStartResidue) - 1;
 401           minStartCol = minStartCol == -1 ? mappedStartCol
 402                   : Math.min(minStartCol, mappedStartCol);
 403           int mappedEndCol = seq.findIndex(mappedEndResidue) - 1;
 404           maxEndCol = maxEndCol == -1 ? mappedEndCol
 405                   : Math.max(maxEndCol, mappedEndCol);
 406           mappedGroup.addSequence(seq, false);
 407           break;
 408         }
 409       }
 410     }
 411     mappedGroup.setStartRes(minStartCol < 0 ? 0 : minStartCol);
 412     mappedGroup.setEndRes(maxEndCol < 0 ? 0 : maxEndCol);
 413     return mappedGroup;
 414   }
 415
 416   /**
 417    * Returns an OrderCommand equivalent to the given one, but acting on mapped
 418    * sequences as described by the mappings, or null if no mapping can be made.
 419    *
 420    * @param command
 421    *          the original order command
 422    * @param undo
 423    *          if true, the action is to undo the sort
 424    * @param mapTo
 425    *          the alignment we are mapping to
 426    * @param mappings
 427    *          the mappings available
 428    * @return
 429    */
 430   public static CommandI mapOrderCommand(OrderCommand command, boolean undo,
 431           AlignmentI mapTo, List<AlignedCodonFrame> mappings)
 432   {
 433     SequenceI[] sortOrder = command.getSequenceOrder(undo);
 434     List<SequenceI> mappedOrder = new ArrayList<>();
 435     int j = 0;
 436
 437     /*
 438      * Assumption: we are only interested in a cDNA/protein mapping; refactor in
 439      * future if we want to support sorting (c)dna as (c)dna or protein as
 440      * protein
 441      */
 442     boolean mappingToNucleotide = mapTo.isNucleotide();
 443     for (SequenceI seq : sortOrder)
 444     {
 445       for (AlignedCodonFrame acf : mappings)
 446       {
 447           for (SequenceI seq2 : mapTo.getSequences())
 448           {
 449             /*
 450              * the corresponding peptide / CDS is the one for which there is
 451              * a complete ('covering') mapping to 'seq'
 452              */
 453             SequenceI peptide = mappingToNucleotide ? seq2 : seq;
 454             SequenceI cds = mappingToNucleotide ? seq : seq2;
 455             SequenceToSequenceMapping s2s = acf.getCoveringMapping(cds,
 456                     peptide);
 457             if (s2s != null)
 458             {
 459               mappedOrder.add(seq2);
 460               j++;
 461               break;
 462             }
 463           }
 464       }
 465     }
 466
 467     /*
 468      * Return null if no mappings made.
 469      */
 470     if (j == 0)
 471     {
 472       return null;
 473     }
 474
 475     /*
 476      * Add any unmapped sequences on the end of the sort in their original
 477      * ordering.
 478      */
 479     if (j < mapTo.getHeight())
 480     {
 481       for (SequenceI seq : mapTo.getSequences())
 482       {
 483         if (!mappedOrder.contains(seq))
 484         {
 485           mappedOrder.add(seq);
 486         }
 487       }
 488     }
 489
 490     /*
 491      * Have to sort the sequences before constructing the OrderCommand - which
 492      * then resorts them?!?
 493      */
 494     final SequenceI[] mappedOrderArray = mappedOrder
 495             .toArray(new SequenceI[mappedOrder.size()]);
 496     SequenceI[] oldOrder = mapTo.getSequencesArray();
 497     AlignmentSorter.sortBy(mapTo, new AlignmentOrder(mappedOrderArray));
 498     final OrderCommand result = new OrderCommand(command.getDescription(),
 499             oldOrder, mapTo);
 500     return result;
 501   }
 502
 503   /**
 504    * Returns a ColumnSelection in the 'mapTo' view which corresponds to the
 505    * given selection in the 'mapFrom' view. We assume one is nucleotide, the
 506    * other is protein (and holds the mappings from codons to protein residues).
 507    *
 508    * @param colsel
 509    * @param mapFrom
 510    * @param mapTo
 511    * @return
 512    */
 513   public static void mapColumnSelection(ColumnSelection colsel,
 514           HiddenColumns hiddencols, AlignViewportI mapFrom,
 515           AlignViewportI mapTo, ColumnSelection newColSel,
 516           HiddenColumns newHidden)
 517   {
 518     boolean targetIsNucleotide = mapTo.isNucleotide();
 519     AlignViewportI protein = targetIsNucleotide ? mapFrom : mapTo;
 520     List<AlignedCodonFrame> codonFrames = protein.getAlignment()
 521             .getCodonFrames();
 522
 523     if (colsel == null)
 524     {
 525       return;
 526     }
 527
 528     char fromGapChar = mapFrom.getAlignment().getGapCharacter();
 529
 530     /*
 531      * For each mapped column, find the range of columns that residues in that
 532      * column map to.
 533      */
 534     List<SequenceI> fromSequences = mapFrom.getAlignment().getSequences();
 535     List<SequenceI> toSequences = mapTo.getAlignment().getSequences();
 536
 537     for (Integer sel : colsel.getSelected())
 538     {
 539       mapColumn(sel.intValue(), codonFrames, newColSel, fromSequences,
 540               toSequences, fromGapChar);
 541     }
 542
 543     Iterator<int[]> regions = hiddencols.iterator();
 544     while (regions.hasNext())
 545     {
 546       mapHiddenColumns(regions.next(), codonFrames, newHidden,
 547               fromSequences, toSequences, fromGapChar);
 548     }
 549     return;
 550   }
 551
 552   /**
 553    * Helper method that maps a [start, end] hidden column range to its mapped
 554    * equivalent
 555    *
 556    * @param hidden
 557    * @param mappings
 558    * @param mappedColumns
 559    * @param fromSequences
 560    * @param toSequences
 561    * @param fromGapChar
 562    */
 563   protected static void mapHiddenColumns(int[] hidden,
 564           List<AlignedCodonFrame> mappings, HiddenColumns mappedColumns,
 565           List<SequenceI> fromSequences, List<SequenceI> toSequences,
 566           char fromGapChar)
 567   {
 568     for (int col = hidden[0]; col <= hidden[1]; col++)
 569     {
 570       int[] mappedTo = findMappedColumns(col, mappings, fromSequences,
 571               toSequences, fromGapChar);
 572
 573       /*
 574        * Add the range of hidden columns to the mapped selection (converting
 575        * base 1 to base 0).
 576        */
 577       if (mappedTo != null)
 578       {
 579         mappedColumns.hideColumns(mappedTo[0] - 1, mappedTo[1] - 1);
 580       }
 581     }
 582   }
 583
 584   /**
 585    * Helper method to map one column selection
 586    *
 587    * @param col
 588    *          the column number (base 0)
 589    * @param mappings
 590    *          the sequence mappings
 591    * @param mappedColumns
 592    *          the mapped column selections to add to
 593    * @param fromSequences
 594    * @param toSequences
 595    * @param fromGapChar
 596    */
 597   protected static void mapColumn(int col, List<AlignedCodonFrame> mappings,
 598           ColumnSelection mappedColumns, List<SequenceI> fromSequences,
 599           List<SequenceI> toSequences, char fromGapChar)
 600   {
 601     int[] mappedTo = findMappedColumns(col, mappings, fromSequences,
 602             toSequences, fromGapChar);
 603
 604     /*
 605      * Add the range of mapped columns to the mapped selection (converting
 606      * base 1 to base 0). Note that this may include intron-only regions which
 607      * lie between the start and end ranges of the selection.
 608      */
 609     if (mappedTo != null)
 610     {
 611       for (int i = mappedTo[0]; i <= mappedTo[1]; i++)
 612       {
 613         mappedColumns.addElement(i - 1);
 614       }
 615     }
 616   }
 617
 618   /**
 619    * Helper method to find the range of columns mapped to from one column.
 620    * Returns the maximal range of columns mapped to from all sequences in the
 621    * source column, or null if no mappings were found.
 622    *
 623    * @param col
 624    * @param mappings
 625    * @param fromSequences
 626    * @param toSequences
 627    * @param fromGapChar
 628    * @return
 629    */
 630   protected static int[] findMappedColumns(int col,
 631           List<AlignedCodonFrame> mappings, List<SequenceI> fromSequences,
 632           List<SequenceI> toSequences, char fromGapChar)
 633   {
 634     int[] mappedTo = new int[] { Integer.MAX_VALUE, Integer.MIN_VALUE };
 635     boolean found = false;
 636
 637     /*
 638      * For each sequence in the 'from' alignment
 639      */
 640     for (SequenceI fromSeq : fromSequences)
 641     {
 642       /*
 643        * Ignore gaps (unmapped anyway)
 644        */
 645       if (fromSeq.getCharAt(col) == fromGapChar)
 646       {
 647         continue;
 648       }
 649
 650       /*
 651        * Get the residue position and find the mapped position.
 652        */
 653       int residuePos = fromSeq.findPosition(col);
 654       SearchResultsI sr = buildSearchResults(fromSeq, residuePos, mappings);
 655       for (SearchResultMatchI m : sr.getResults())
 656       {
 657         int mappedStartResidue = m.getStart();
 658         int mappedEndResidue = m.getEnd();
 659         SequenceI mappedSeq = m.getSequence();
 660
 661         /*
 662          * Locate the aligned sequence whose dataset is mappedSeq. TODO a
 663          * datamodel that can do this efficiently.
 664          */
 665         for (SequenceI toSeq : toSequences)
 666         {
 667           if (toSeq.getDatasetSequence() == mappedSeq
 668                   && mappedStartResidue >= toSeq.getStart()
 669                   && mappedEndResidue <= toSeq.getEnd())
 670           {
 671             int mappedStartCol = toSeq.findIndex(mappedStartResidue);
 672             int mappedEndCol = toSeq.findIndex(mappedEndResidue);
 673             mappedTo[0] = Math.min(mappedTo[0], mappedStartCol);
 674             mappedTo[1] = Math.max(mappedTo[1], mappedEndCol);
 675             found = true;
 676             break;
 677             // note: remove break if we ever want to map one to many sequences
 678           }
 679         }
 680       }
 681     }
 682     return found ? mappedTo : null;
 683   }
 684
 685   /**
 686    * Returns the mapped codon or codons for a given aligned sequence column
 687    * position (base 0).
 688    *
 689    * @param seq
 690    *          an aligned peptide sequence
 691    * @param col
 692    *          an aligned column position (base 0)
 693    * @param mappings
 694    *          a set of codon mappings
 695    * @return the bases of the mapped codon(s) in the cDNA dataset sequence(s),
 696    *         or an empty list if none found
 697    */
 698   public static List<char[]> findCodonsFor(SequenceI seq, int col,
 699           List<AlignedCodonFrame> mappings)
 700   {
 701     List<char[]> result = new ArrayList<>();
 702     int dsPos = seq.findPosition(col);
 703     for (AlignedCodonFrame mapping : mappings)
 704     {
 705       if (mapping.involvesSequence(seq))
 706       {
 707         List<char[]> codons = mapping
 708                 .getMappedCodons(seq.getDatasetSequence(), dsPos);
 709         if (codons != null)
 710         {
 711           result.addAll(codons);
 712         }
 713       }
 714     }
 715     return result;
 716   }
 717
 718   /**
 719    * Converts a series of [start, end] range pairs into an array of individual
 720    * positions. This also caters for 'reverse strand' (start > end) cases.
 721    *
 722    * @param ranges
 723    * @return
 724    */
 725   public static int[] flattenRanges(int[] ranges)
 726   {
 727     /*
 728      * Count how many positions altogether
 729      */
 730     int count = 0;
 731     for (int i = 0; i < ranges.length - 1; i += 2)
 732     {
 733       count += Math.abs(ranges[i + 1] - ranges[i]) + 1;
 734     }
 735
 736     int[] result = new int[count];
 737     int k = 0;
 738     for (int i = 0; i < ranges.length - 1; i += 2)
 739     {
 740       int from = ranges[i];
 741       final int to = ranges[i + 1];
 742       int step = from <= to ? 1 : -1;
 743       do
 744       {
 745         result[k++] = from;
 746         from += step;
 747       } while (from != to + step);
 748     }
 749     return result;
 750   }
 751
 752   /**
 753    * Returns a list of any mappings that are from or to the given (aligned or
 754    * dataset) sequence.
 755    *
 756    * @param sequence
 757    * @param mappings
 758    * @return
 759    */
 760   public static List<AlignedCodonFrame> findMappingsForSequence(
 761           SequenceI sequence, List<AlignedCodonFrame> mappings)
 762   {
 763     return findMappingsForSequenceAndOthers(sequence, mappings, null);
 764   }
 765
 766   /**
 767    * Returns a list of any mappings that are from or to the given (aligned or
 768    * dataset) sequence, optionally limited to mappings involving one of a given
 769    * list of sequences.
 770    *
 771    * @param sequence
 772    * @param mappings
 773    * @param filterList
 774    * @return
 775    */
 776   public static List<AlignedCodonFrame> findMappingsForSequenceAndOthers(
 777           SequenceI sequence, List<AlignedCodonFrame> mappings,
 778           List<SequenceI> filterList)
 779   {
 780     List<AlignedCodonFrame> result = new ArrayList<>();
 781     if (sequence == null || mappings == null)
 782     {
 783       return result;
 784     }
 785     for (AlignedCodonFrame mapping : mappings)
 786     {
 787       if (mapping.involvesSequence(sequence))
 788       {
 789         if (filterList != null)
 790         {
 791           for (SequenceI otherseq : filterList)
 792           {
 793             SequenceI otherDataset = otherseq.getDatasetSequence();
 794             if (otherseq == sequence
 795                     || otherseq == sequence.getDatasetSequence()
 796                     || (otherDataset != null && (otherDataset == sequence
 797                             || otherDataset == sequence
 798                                     .getDatasetSequence())))
 799             {
 800               // skip sequences in subset which directly relate to sequence
 801               continue;
 802             }
 803             if (mapping.involvesSequence(otherseq))
 804             {
 805               // selected a mapping contained in subselect alignment
 806               result.add(mapping);
 807               break;
 808             }
 809           }
 810         }
 811         else
 812         {
 813           result.add(mapping);
 814         }
 815       }
 816     }
 817     return result;
 818   }
 819
 820   /**
 821    * Returns the total length of the supplied ranges, which may be as single
 822    * [start, end] or multiple [start, end, start, end ...]
 823    *
 824    * @param ranges
 825    * @return
 826    */
 827   public static int getLength(List<int[]> ranges)
 828   {
 829     if (ranges == null)
 830     {
 831       return 0;
 832     }
 833     int length = 0;
 834     for (int[] range : ranges)
 835     {
 836       if (range.length % 2 != 0)
 837       {
 838         Cache.log.error(
 839                 "Error unbalance start/end ranges: " + ranges.toString());
 840         return 0;
 841       }
 842       for (int i = 0; i < range.length - 1; i += 2)
 843       {
 844         length += Math.abs(range[i + 1] - range[i]) + 1;
 845       }
 846     }
 847     return length;
 848   }
 849
 850   /**
 851    * Answers true if any range includes the given value
 852    *
 853    * @param ranges
 854    * @param value
 855    * @return
 856    */
 857   public static boolean contains(List<int[]> ranges, int value)
 858   {
 859     if (ranges == null)
 860     {
 861       return false;
 862     }
 863     for (int[] range : ranges)
 864     {
 865       if (range[1] >= range[0] && value >= range[0] && value <= range[1])
 866       {
 867         /*
 868          * value within ascending range
 869          */
 870         return true;
 871       }
 872       if (range[1] < range[0] && value <= range[0] && value >= range[1])
 873       {
 874         /*
 875          * value within descending range
 876          */
 877         return true;
 878       }
 879     }
 880     return false;
 881   }
 882
 883   /**
 884    * Removes a specified number of positions from the start of a ranges list.
 885    * For example, could be used to adjust cds ranges to allow for an incomplete
 886    * start codon. Subranges are removed completely, or their start positions
 887    * adjusted, until the required number of positions has been removed from the
 888    * range. Reverse strand ranges are supported. The input array is not
 889    * modified.
 890    *
 891    * @param removeCount
 892    * @param ranges
 893    *          an array of [start, end, start, end...] positions
 894    * @return a new array with the first removeCount positions removed
 895    */
 896   public static int[] removeStartPositions(int removeCount,
 897           final int[] ranges)
 898   {
 899     if (removeCount <= 0)
 900     {
 901       return ranges;
 902     }
 903
 904     int[] copy = Arrays.copyOf(ranges, ranges.length);
 905     int sxpos = -1;
 906     int cdspos = 0;
 907     for (int x = 0; x < copy.length && sxpos == -1; x += 2)
 908     {
 909       cdspos += Math.abs(copy[x + 1] - copy[x]) + 1;
 910       if (removeCount < cdspos)
 911       {
 912         /*
 913          * we have removed enough, time to finish
 914          */
 915         sxpos = x;
 916
 917         /*
 918          * increment start of first exon, or decrement if reverse strand
 919          */
 920         if (copy[x] <= copy[x + 1])
 921         {
 922           copy[x] = copy[x + 1] - cdspos + removeCount + 1;
 923         }
 924         else
 925         {
 926           copy[x] = copy[x + 1] + cdspos - removeCount - 1;
 927         }
 928         break;
 929       }
 930     }
 931
 932     if (sxpos > 0)
 933     {
 934       /*
 935        * we dropped at least one entire sub-range - compact the array
 936        */
 937       int[] nxon = new int[copy.length - sxpos];
 938       System.arraycopy(copy, sxpos, nxon, 0, copy.length - sxpos);
 939       return nxon;
 940     }
 941     return copy;
 942   }
 943
 944   /**
 945    * Answers true if range's start-end positions include those of queryRange,
 946    * where either range might be in reverse direction, else false
 947    *
 948    * @param range
 949    *          a start-end range
 950    * @param queryRange
 951    *          a candidate subrange of range (start2-end2)
 952    * @return
 953    */
 954   public static boolean rangeContains(int[] range, int[] queryRange)
 955   {
 956     if (range == null || queryRange == null || range.length != 2
 957             || queryRange.length != 2)
 958     {
 959       /*
 960        * invalid arguments
 961        */
 962       return false;
 963     }
 964
 965     int min = Math.min(range[0], range[1]);
 966     int max = Math.max(range[0], range[1]);
 967
 968     return (min <= queryRange[0] && max >= queryRange[0]
 969             && min <= queryRange[1] && max >= queryRange[1]);
 970   }
 971
 972   /**
 973    * Removes the specified number of positions from the given ranges. Provided
 974    * to allow a stop codon to be stripped from a CDS sequence so that it matches
 975    * the peptide translation length.
 976    *
 977    * @param positions
 978    * @param ranges
 979    *          a list of (single) [start, end] ranges
 980    * @return
 981    */
 982   public static void removeEndPositions(int positions, List<int[]> ranges)
 983   {
 984     int toRemove = positions;
 985     Iterator<int[]> it = new ReverseListIterator<>(ranges);
 986     while (toRemove > 0)
 987     {
 988       int[] endRange = it.next();
 989       if (endRange.length != 2)
 990       {
 991         /*
 992          * not coded for [start1, end1, start2, end2, ...]
 993          */
 994         Cache.log.error(
 995                 "MappingUtils.removeEndPositions doesn't handle multiple  ranges");
 996         return;
 997       }
 998
 999       int length = endRange[1] - endRange[0] + 1;
1000       if (length <= 0)
1001       {
1002         /*
1003          * not coded for a reverse strand range (end < start)
1004          */
1005         Cache.log.error(
1006                 "MappingUtils.removeEndPositions doesn't handle reverse strand");
1007         return;
1008       }
1009       if (length > toRemove)
1010       {
1011         endRange[1] -= toRemove;
1012         toRemove = 0;
1013       }
1014       else
1015       {
1016         toRemove -= length;
1017         it.remove();
1018       }
1019     }
1020   }
1021
1022   /**
1023    * Converts a list of [start, end] ranges to a single array of [start, end,
1024    * start, end ...]
1025    *
1026    * @param ranges
1027    * @return
1028    */
1029   public static int[] listToArray(List<int[]> ranges)
1030   {
1031     int[] result = new int[ranges.size() * 2];
1032     int i = 0;
1033     for (int[] range : ranges)
1034     {
1035       result[i++] = range[0];
1036       result[i++] = range[1];
1037     }
1038     return result;
1039   }
1040
1041   /**
1042    * Returns the maximal start-end positions in the given (ordered) list of
1043    * ranges which is overlapped by the given begin-end range, or null if there
1044    * is no overlap.
1045    *
1046    * <pre>
1047    * Examples:
1048    *   if ranges is {[4, 8], [10, 12], [16, 19]}
1049    * then
1050    *   findOverlap(ranges, 1, 20) == [4, 19]
1051    *   findOverlap(ranges, 6, 11) == [6, 11]
1052    *   findOverlap(ranges, 9, 15) == [10, 12]
1053    *   findOverlap(ranges, 13, 15) == null
1054    * </pre>
1055    *
1056    * @param ranges
1057    * @param begin
1058    * @param end
1059    * @return
1060    */
1061   protected static int[] findOverlap(List<int[]> ranges, final int begin,
1062           final int end)
1063   {
1064     boolean foundStart = false;
1065     int from = 0;
1066     int to = 0;
1067
1068     /*
1069      * traverse the ranges to find the first position (if any) >= begin,
1070      * and the last position (if any) <= end
1071      */
1072     for (int[] range : ranges)
1073     {
1074       if (!foundStart)
1075       {
1076         if (range[0] >= begin)
1077         {
1078           /*
1079            * first range that starts with, or follows, begin
1080            */
1081           foundStart = true;
1082           from = Math.max(range[0], begin);
1083         }
1084         else if (range[1] >= begin)
1085         {
1086           /*
1087            * first range that contains begin
1088            */
1089           foundStart = true;
1090           from = begin;
1091         }
1092       }
1093
1094       if (range[0] <= end)
1095       {
1096         to = Math.min(end, range[1]);
1097       }
1098     }
1099
1100     return foundStart && to >= from ? new int[] { from, to } : null;
1101   }
1102 }