src/jalview/api/analysis/SimilarityParamsI.java

   1 package jalview.api.analysis;
   2
   3 /**
   4  * A description of options when computing percentage identity of two aligned
   5  * sequences
   6  */
   7 public interface SimilarityParamsI
   8 {
   9   /**
  10    * Answers true if gap-gap aligned positions should be included in the
  11    * calculation
  12    *
  13    * @return
  14    */
  15   boolean includeGappedColumns();
  16
  17   /**
  18    * Answers true if gap-residue alignment is considered a match
  19    *
  20    * @return
  21    */
  22   boolean matchGaps();
  23
  24   /**
  25    * Answers true if the demoninator (normalisation factor) of the score count
  26    * includes gap-residue positions, false if it only includes residue-residue
  27    * aligned positions. Gap-gap positions are included if this and
  28    * includeGappedColumns both answer true.
  29    *
  30    * @return
  31    */
  32   boolean denominatorIncludesGaps();
  33
  34   /**
  35    * Answers true if only the shortest sequence length is used to divide the
  36    * total score, false if the longest sequence length
  37    *
  38    * @return
  39    */
  40   boolean denominateByShortestLength();
  41 }