JAL-3929 URLencode pdbid to remove problematic characters - propagate urlEncoded...
[jalview.git] / src / jalview / api / analysis / PairwiseScoreModelI.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.api.analysis;
22
23 /**
24  * An interface that describes classes that can compute similarity (aka
25  * substitution) scores for pairs of residues
26  */
27 public interface PairwiseScoreModelI
28 {
29   /**
30    * Answers a similarity score between two sequence characters (for
31    * substitution of the first by the second). Typically the highest scores are
32    * for identity, and the lowest for substitution of a residue by one with very
33    * different properties.
34    * 
35    * @param c
36    * @param d
37    * @return
38    */
39   abstract public float getPairwiseScore(char c, char d);
40   // TODO make this static when Java 8
41
42 }