You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by br...@apache.org on 2015/03/01 13:14:31 UTC
svn commit: r941823 [9/21] - in
/websites/production/commons/content/sandbox/commons-text: ./ apidocs/
apidocs/org/apache/commons/text/diff/
apidocs/org/apache/commons/text/diff/class-use/
apidocs/org/apache/commons/text/similarity/ apidocs/org/apache/...
Modified: websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/LevenshteinDistance.html
==============================================================================
--- websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/LevenshteinDistance.html (original)
+++ websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/LevenshteinDistance.html Sun Mar 1 12:14:29 2015
@@ -27,243 +27,231 @@
<span class="sourceLineNo">019</span>import java.util.Arrays;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
-<span class="sourceLineNo">022</span> * <p><a name="line.22"></a>
-<span class="sourceLineNo">023</span> * A string metric for measuring the difference between two sequences.<a name="line.23"></a>
-<span class="sourceLineNo">024</span> * </p><a name="line.24"></a>
-<span class="sourceLineNo">025</span> *<a name="line.25"></a>
-<span class="sourceLineNo">026</span> * <p><a name="line.26"></a>
-<span class="sourceLineNo">027</span> * This code has been adapted from Apache Commons Lang 3.3.<a name="line.27"></a>
+<span class="sourceLineNo">022</span> * An algorithm for measuring the difference between two character sequences.<a name="line.22"></a>
+<span class="sourceLineNo">023</span> *<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * <p><a name="line.24"></a>
+<span class="sourceLineNo">025</span> * This is the number of changes needed to change one sequence into another,<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * where each change is a single character modification (deletion, insertion<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * or substitution).<a name="line.27"></a>
<span class="sourceLineNo">028</span> * </p><a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * @since 1.0<a name="line.30"></a>
-<span class="sourceLineNo">031</span> */<a name="line.31"></a>
-<span class="sourceLineNo">032</span>public class LevenshteinDistance implements StringMetric<Integer> {<a name="line.32"></a>
-<span class="sourceLineNo">033</span><a name="line.33"></a>
-<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * <p><a name="line.35"></a>
-<span class="sourceLineNo">036</span> * Find the Levenshtein distance between two Strings.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> * </p><a name="line.37"></a>
+<span class="sourceLineNo">030</span> * <p><a name="line.30"></a>
+<span class="sourceLineNo">031</span> * This code has been adapted from Apache Commons Lang 3.3.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * </p><a name="line.32"></a>
+<span class="sourceLineNo">033</span> */<a name="line.33"></a>
+<span class="sourceLineNo">034</span>public class LevenshteinDistance implements StringMetric<Integer> {<a name="line.34"></a>
+<span class="sourceLineNo">035</span><a name="line.35"></a>
+<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * Find the Levenshtein distance between two Strings.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * <p><a name="line.39"></a>
-<span class="sourceLineNo">040</span> * This is the number of changes needed to change one String into another,<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * where each change is a single character modification (deletion, insertion<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * or substitution).<a name="line.42"></a>
-<span class="sourceLineNo">043</span> * </p><a name="line.43"></a>
-<span class="sourceLineNo">044</span> *<a name="line.44"></a>
-<span class="sourceLineNo">045</span> * <p><a name="line.45"></a>
-<span class="sourceLineNo">046</span> * The previous implementation of the Levenshtein distance algorithm was<a name="line.46"></a>
-<span class="sourceLineNo">047</span> * from <a<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * href="http://www.merriampark.com/ld.htm">http://www.merriampark.com<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * /ld.htm</a><a name="line.49"></a>
-<span class="sourceLineNo">050</span> * </p><a name="line.50"></a>
-<span class="sourceLineNo">051</span> *<a name="line.51"></a>
-<span class="sourceLineNo">052</span> * <p><a name="line.52"></a>
-<span class="sourceLineNo">053</span> * Chas Emerick has written an implementation in Java, which avoids an<a name="line.53"></a>
-<span class="sourceLineNo">054</span> * OutOfMemoryError which can occur when my Java implementation is used with<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * very large strings.<br><a name="line.55"></a>
-<span class="sourceLineNo">056</span> * This implementation of the Levenshtein distance algorithm is from <a<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * href="http://www.merriampark.com/ldjava.htm">http://www.merriampark.com/<a name="line.57"></a>
-<span class="sourceLineNo">058</span> * ldjava.htm</a><a name="line.58"></a>
-<span class="sourceLineNo">059</span> * </p><a name="line.59"></a>
-<span class="sourceLineNo">060</span> *<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * <pre><a name="line.61"></a>
-<span class="sourceLineNo">062</span> * StringUtils.getLevenshteinDistance(null, *) = IllegalArgumentException<a name="line.62"></a>
-<span class="sourceLineNo">063</span> * StringUtils.getLevenshteinDistance(*, null) = IllegalArgumentException<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * StringUtils.getLevenshteinDistance("","") = 0<a name="line.64"></a>
-<span class="sourceLineNo">065</span> * StringUtils.getLevenshteinDistance("","a") = 1<a name="line.65"></a>
-<span class="sourceLineNo">066</span> * StringUtils.getLevenshteinDistance("aaapppp", "") = 7<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * StringUtils.getLevenshteinDistance("frog", "fog") = 1<a name="line.67"></a>
-<span class="sourceLineNo">068</span> * StringUtils.getLevenshteinDistance("fly", "ant") = 3<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * StringUtils.getLevenshteinDistance("elephant", "hippo") = 7<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * StringUtils.getLevenshteinDistance("hippo", "elephant") = 7<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * StringUtils.getLevenshteinDistance("hippo", "zzzzzzzz") = 8<a name="line.71"></a>
-<span class="sourceLineNo">072</span> * StringUtils.getLevenshteinDistance("hello", "hallo") = 1<a name="line.72"></a>
-<span class="sourceLineNo">073</span> * </pre><a name="line.73"></a>
-<span class="sourceLineNo">074</span> *<a name="line.74"></a>
-<span class="sourceLineNo">075</span> * @param left the first string, must not be null<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * @param right the second string, must not be null<a name="line.76"></a>
-<span class="sourceLineNo">077</span> * @return result distance<a name="line.77"></a>
-<span class="sourceLineNo">078</span> * @throws IllegalArgumentException if either String input {@code null}<a name="line.78"></a>
-<span class="sourceLineNo">079</span> */<a name="line.79"></a>
-<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
-<span class="sourceLineNo">081</span> public Integer compare(CharSequence left, CharSequence right) {<a name="line.81"></a>
-<span class="sourceLineNo">082</span> return compare(left, right, Integer.MAX_VALUE);<a name="line.82"></a>
-<span class="sourceLineNo">083</span> }<a name="line.83"></a>
-<span class="sourceLineNo">084</span><a name="line.84"></a>
-<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * <p><a name="line.86"></a>
-<span class="sourceLineNo">087</span> * Find the Levenshtein distance between two Strings if it's less than or<a name="line.87"></a>
-<span class="sourceLineNo">088</span> * equal to a given threshold.<a name="line.88"></a>
-<span class="sourceLineNo">089</span> * </p><a name="line.89"></a>
-<span class="sourceLineNo">090</span> *<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * <p><a name="line.91"></a>
-<span class="sourceLineNo">092</span> * This is the number of changes needed to change one String into another,<a name="line.92"></a>
-<span class="sourceLineNo">093</span> * where each change is a single character modification (deletion, insertion<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * or substitution).<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * </p><a name="line.95"></a>
-<span class="sourceLineNo">096</span> *<a name="line.96"></a>
-<span class="sourceLineNo">097</span> * <p><a name="line.97"></a>
-<span class="sourceLineNo">098</span> * This implementation follows from Algorithms on Strings, Trees and<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * Sequences by Dan Gusfield and Chas Emerick's implementation of the<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * Levenshtein distance algorithm from <a<a name="line.100"></a>
-<span class="sourceLineNo">101</span> * href="http://www.merriampark.com/ld.htm"<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * >http://www.merriampark.com/ld.htm</a><a name="line.102"></a>
-<span class="sourceLineNo">103</span> * </p><a name="line.103"></a>
-<span class="sourceLineNo">104</span> *<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * <pre><a name="line.105"></a>
-<span class="sourceLineNo">106</span> * StringUtils.getLevenshteinDistance(null, *, *) = IllegalArgumentException<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * StringUtils.getLevenshteinDistance(*, null, *) = IllegalArgumentException<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * StringUtils.getLevenshteinDistance(*, *, -1) = IllegalArgumentException<a name="line.108"></a>
-<span class="sourceLineNo">109</span> * StringUtils.getLevenshteinDistance("","", 0) = 0<a name="line.109"></a>
-<span class="sourceLineNo">110</span> * StringUtils.getLevenshteinDistance("aaapppp", "", 8) = 7<a name="line.110"></a>
-<span class="sourceLineNo">111</span> * StringUtils.getLevenshteinDistance("aaapppp", "", 7) = 7<a name="line.111"></a>
-<span class="sourceLineNo">112</span> * StringUtils.getLevenshteinDistance("aaapppp", "", 6)) = -1<a name="line.112"></a>
-<span class="sourceLineNo">113</span> * StringUtils.getLevenshteinDistance("elephant", "hippo", 7) = 7<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * StringUtils.getLevenshteinDistance("elephant", "hippo", 6) = -1<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * StringUtils.getLevenshteinDistance("hippo", "elephant", 7) = 7<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * StringUtils.getLevenshteinDistance("hippo", "elephant", 6) = -1<a name="line.116"></a>
-<span class="sourceLineNo">117</span> * </pre><a name="line.117"></a>
-<span class="sourceLineNo">118</span> *<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * @param left the first string, must not be null<a name="line.119"></a>
-<span class="sourceLineNo">120</span> * @param right the second string, must not be null<a name="line.120"></a>
-<span class="sourceLineNo">121</span> * @param threshold the target threshold, must not be negative<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * @return result distance<a name="line.122"></a>
-<span class="sourceLineNo">123</span> * @throws IllegalArgumentException if either String input {@code null} or<a name="line.123"></a>
-<span class="sourceLineNo">124</span> * negative threshold<a name="line.124"></a>
-<span class="sourceLineNo">125</span> */<a name="line.125"></a>
-<span class="sourceLineNo">126</span> public Integer compare(CharSequence left, CharSequence right, int threshold) {<a name="line.126"></a>
-<span class="sourceLineNo">127</span> if (left == null || right == null) {<a name="line.127"></a>
-<span class="sourceLineNo">128</span> throw new IllegalArgumentException("Strings must not be null");<a name="line.128"></a>
-<span class="sourceLineNo">129</span> }<a name="line.129"></a>
-<span class="sourceLineNo">130</span> if (threshold < 0) {<a name="line.130"></a>
-<span class="sourceLineNo">131</span> throw new IllegalArgumentException("Threshold must not be negative");<a name="line.131"></a>
-<span class="sourceLineNo">132</span> }<a name="line.132"></a>
-<span class="sourceLineNo">133</span><a name="line.133"></a>
-<span class="sourceLineNo">134</span> /*<a name="line.134"></a>
-<span class="sourceLineNo">135</span> * This implementation only computes the distance if it's less than or<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * equal to the threshold value, returning -1 if it's greater. The<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * advantage is performance: unbounded distance is O(nm), but a bound of<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * k allows us to reduce it to O(km) time by only computing a diagonal<a name="line.138"></a>
-<span class="sourceLineNo">139</span> * stripe of width 2k + 1 of the cost table. It is also possible to use<a name="line.139"></a>
-<span class="sourceLineNo">140</span> * this to compute the unbounded Levenshtein distance by starting the<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * threshold at 1 and doubling each time until the distance is found;<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * this is O(dm), where d is the distance.<a name="line.142"></a>
-<span class="sourceLineNo">143</span> *<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * One subtlety comes from needing to ignore entries on the border of<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * our stripe eg. p[] = |#|#|#|* d[] = *|#|#|#| We must ignore the entry<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * to the left of the leftmost member We must ignore the entry above the<a name="line.146"></a>
-<span class="sourceLineNo">147</span> * rightmost member<a name="line.147"></a>
+<span class="sourceLineNo">039</span> * <p>A higher score indicates a greater distance.</p><a name="line.39"></a>
+<span class="sourceLineNo">040</span> *<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <p><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * The previous implementation of the Levenshtein distance algorithm was<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * from <a<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * href="http://www.merriampark.com/ld.htm">http://www.merriampark.com<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * /ld.htm</a><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * </p><a name="line.46"></a>
+<span class="sourceLineNo">047</span> *<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * <p><a name="line.48"></a>
+<span class="sourceLineNo">049</span> * Chas Emerick has written an implementation in Java, which avoids an<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * OutOfMemoryError which can occur when my Java implementation is used with<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * very large strings.<br><a name="line.51"></a>
+<span class="sourceLineNo">052</span> * This implementation of the Levenshtein distance algorithm is from <a<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * href="http://www.merriampark.com/ldjava.htm">http://www.merriampark.com/<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * ldjava.htm</a><a name="line.54"></a>
+<span class="sourceLineNo">055</span> * </p><a name="line.55"></a>
+<span class="sourceLineNo">056</span> *<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * <pre><a name="line.57"></a>
+<span class="sourceLineNo">058</span> * distance.compare(null, *) = IllegalArgumentException<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * distance.compare(*, null) = IllegalArgumentException<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * distance.compare("","") = 0<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * distance.compare("","a") = 1<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * distance.compare("aaapppp", "") = 7<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * distance.compare("frog", "fog") = 1<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * distance.compare("fly", "ant") = 3<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * distance.compare("elephant", "hippo") = 7<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * distance.compare("hippo", "elephant") = 7<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * distance.compare("hippo", "zzzzzzzz") = 8<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * distance.compare("hello", "hallo") = 1<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * </pre><a name="line.69"></a>
+<span class="sourceLineNo">070</span> *<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * @param left the first string, must not be null<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * @param right the second string, must not be null<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * @return result distance<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * @throws IllegalArgumentException if either String input {@code null}<a name="line.74"></a>
+<span class="sourceLineNo">075</span> */<a name="line.75"></a>
+<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
+<span class="sourceLineNo">077</span> public Integer compare(CharSequence left, CharSequence right) {<a name="line.77"></a>
+<span class="sourceLineNo">078</span> return compare(left, right, Integer.MAX_VALUE);<a name="line.78"></a>
+<span class="sourceLineNo">079</span> }<a name="line.79"></a>
+<span class="sourceLineNo">080</span><a name="line.80"></a>
+<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * Find the Levenshtein distance between two CharSequences if it's less than or<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * equal to a given threshold.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> *<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * <p><a name="line.85"></a>
+<span class="sourceLineNo">086</span> * This implementation follows from Algorithms on Strings, Trees and<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * Sequences by Dan Gusfield and Chas Emerick's implementation of the<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * Levenshtein distance algorithm from <a<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * href="http://www.merriampark.com/ld.htm"<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * >http://www.merriampark.com/ld.htm</a><a name="line.90"></a>
+<span class="sourceLineNo">091</span> * </p><a name="line.91"></a>
+<span class="sourceLineNo">092</span> *<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * <pre><a name="line.93"></a>
+<span class="sourceLineNo">094</span> * distance.compare(null, *, *) = IllegalArgumentException<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * distance.compare(*, null, *) = IllegalArgumentException<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * distance.compare(*, *, -1) = IllegalArgumentException<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * distance.compare("","", 0) = 0<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * distance.compare("aaapppp", "", 8) = 7<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * distance.compare("aaapppp", "", 7) = 7<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * distance.compare("aaapppp", "", 6)) = -1<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * distance.compare("elephant", "hippo", 7) = 7<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * distance.compare("elephant", "hippo", 6) = -1<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * distance.compare("hippo", "elephant", 7) = 7<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * distance.compare("hippo", "elephant", 6) = -1<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * </pre><a name="line.105"></a>
+<span class="sourceLineNo">106</span> *<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * @param left the first string, must not be null<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @param right the second string, must not be null<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param threshold the target threshold, must not be negative<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * @return result distance<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * @throws IllegalArgumentException if either String input {@code null} or<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * negative threshold<a name="line.112"></a>
+<span class="sourceLineNo">113</span> */<a name="line.113"></a>
+<span class="sourceLineNo">114</span> public Integer compare(CharSequence left, CharSequence right, int threshold) {<a name="line.114"></a>
+<span class="sourceLineNo">115</span> if (left == null || right == null) {<a name="line.115"></a>
+<span class="sourceLineNo">116</span> throw new IllegalArgumentException("Strings must not be null");<a name="line.116"></a>
+<span class="sourceLineNo">117</span> }<a name="line.117"></a>
+<span class="sourceLineNo">118</span> if (threshold < 0) {<a name="line.118"></a>
+<span class="sourceLineNo">119</span> throw new IllegalArgumentException("Threshold must not be negative");<a name="line.119"></a>
+<span class="sourceLineNo">120</span> }<a name="line.120"></a>
+<span class="sourceLineNo">121</span><a name="line.121"></a>
+<span class="sourceLineNo">122</span> /*<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * This implementation only computes the distance if it's less than or<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * equal to the threshold value, returning -1 if it's greater. The<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * advantage is performance: unbounded distance is O(nm), but a bound of<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * k allows us to reduce it to O(km) time by only computing a diagonal<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * stripe of width 2k + 1 of the cost table. It is also possible to use<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * this to compute the unbounded Levenshtein distance by starting the<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * threshold at 1 and doubling each time until the distance is found;<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * this is O(dm), where d is the distance.<a name="line.130"></a>
+<span class="sourceLineNo">131</span> *<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * One subtlety comes from needing to ignore entries on the border of<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * our stripe eg. p[] = |#|#|#|* d[] = *|#|#|#| We must ignore the entry<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * to the left of the leftmost member We must ignore the entry above the<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * rightmost member<a name="line.135"></a>
+<span class="sourceLineNo">136</span> *<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * Another subtlety comes from our stripe running off the matrix if the<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * strings aren't of the same size. Since string s is always swapped to<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * be the shorter of the two, the stripe will always run off to the<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * upper right instead of the lower left of the matrix.<a name="line.140"></a>
+<span class="sourceLineNo">141</span> *<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * As a concrete example, suppose s is of length 5, t is of length 7,<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * and our threshold is 1. In this case we're going to walk a stripe of<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * length 3. The matrix would look like so:<a name="line.144"></a>
+<span class="sourceLineNo">145</span> *<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * 1 2 3 4 5 1 |#|#| | | | 2 |#|#|#| | | 3 | |#|#|#| | 4 | | |#|#|#| 5 |<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * | | |#|#| 6 | | | | |#| 7 | | | | | |<a name="line.147"></a>
<span class="sourceLineNo">148</span> *<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * Another subtlety comes from our stripe running off the matrix if the<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * strings aren't of the same size. Since string s is always swapped to<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * be the shorter of the two, the stripe will always run off to the<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * upper right instead of the lower left of the matrix.<a name="line.152"></a>
-<span class="sourceLineNo">153</span> *<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * As a concrete example, suppose s is of length 5, t is of length 7,<a name="line.154"></a>
-<span class="sourceLineNo">155</span> * and our threshold is 1. In this case we're going to walk a stripe of<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * length 3. The matrix would look like so:<a name="line.156"></a>
-<span class="sourceLineNo">157</span> *<a name="line.157"></a>
-<span class="sourceLineNo">158</span> * 1 2 3 4 5 1 |#|#| | | | 2 |#|#|#| | | 3 | |#|#|#| | 4 | | |#|#|#| 5 |<a name="line.158"></a>
-<span class="sourceLineNo">159</span> * | | |#|#| 6 | | | | |#| 7 | | | | | |<a name="line.159"></a>
-<span class="sourceLineNo">160</span> *<a name="line.160"></a>
-<span class="sourceLineNo">161</span> * Note how the stripe leads off the table as there is no possible way<a name="line.161"></a>
-<span class="sourceLineNo">162</span> * to turn a string of length 5 into one of length 7 in edit distance of<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * 1.<a name="line.163"></a>
-<span class="sourceLineNo">164</span> *<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * Additionally, this implementation decreases memory usage by using two<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * single-dimensional arrays and swapping them back and forth instead of<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * allocating an entire n by m matrix. This requires a few minor<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * changes, such as immediately returning when it's detected that the<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * stripe has run off the matrix and initially filling the arrays with<a name="line.169"></a>
-<span class="sourceLineNo">170</span> * large values so that entries we don't compute are ignored.<a name="line.170"></a>
-<span class="sourceLineNo">171</span> *<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * See Algorithms on Strings, Trees and Sequences by Dan Gusfield for<a name="line.172"></a>
-<span class="sourceLineNo">173</span> * some discussion.<a name="line.173"></a>
-<span class="sourceLineNo">174</span> */<a name="line.174"></a>
-<span class="sourceLineNo">175</span><a name="line.175"></a>
-<span class="sourceLineNo">176</span> int n = left.length(); // length of s<a name="line.176"></a>
-<span class="sourceLineNo">177</span> int m = right.length(); // length of t<a name="line.177"></a>
-<span class="sourceLineNo">178</span><a name="line.178"></a>
-<span class="sourceLineNo">179</span> // if one string is empty, the edit distance is necessarily the length<a name="line.179"></a>
-<span class="sourceLineNo">180</span> // of the other<a name="line.180"></a>
-<span class="sourceLineNo">181</span> if (n == 0) {<a name="line.181"></a>
-<span class="sourceLineNo">182</span> return m <= threshold ? m : -1;<a name="line.182"></a>
-<span class="sourceLineNo">183</span> } else if (m == 0) {<a name="line.183"></a>
-<span class="sourceLineNo">184</span> return n <= threshold ? n : -1;<a name="line.184"></a>
-<span class="sourceLineNo">185</span> }<a name="line.185"></a>
-<span class="sourceLineNo">186</span><a name="line.186"></a>
-<span class="sourceLineNo">187</span> if (n > m) {<a name="line.187"></a>
-<span class="sourceLineNo">188</span> // swap the two strings to consume less memory<a name="line.188"></a>
-<span class="sourceLineNo">189</span> final CharSequence tmp = left;<a name="line.189"></a>
-<span class="sourceLineNo">190</span> left = right;<a name="line.190"></a>
-<span class="sourceLineNo">191</span> right = tmp;<a name="line.191"></a>
-<span class="sourceLineNo">192</span> n = m;<a name="line.192"></a>
-<span class="sourceLineNo">193</span> m = right.length();<a name="line.193"></a>
-<span class="sourceLineNo">194</span> }<a name="line.194"></a>
-<span class="sourceLineNo">195</span><a name="line.195"></a>
-<span class="sourceLineNo">196</span> int[] p = new int[n + 1]; // 'previous' cost array, horizontally<a name="line.196"></a>
-<span class="sourceLineNo">197</span> int[] d = new int[n + 1]; // cost array, horizontally<a name="line.197"></a>
-<span class="sourceLineNo">198</span> int[] _d; // placeholder to assist in swapping p and d<a name="line.198"></a>
-<span class="sourceLineNo">199</span><a name="line.199"></a>
-<span class="sourceLineNo">200</span> // fill in starting table values<a name="line.200"></a>
-<span class="sourceLineNo">201</span> final int boundary = Math.min(n, threshold) + 1;<a name="line.201"></a>
-<span class="sourceLineNo">202</span> for (int i = 0; i < boundary; i++) {<a name="line.202"></a>
-<span class="sourceLineNo">203</span> p[i] = i;<a name="line.203"></a>
-<span class="sourceLineNo">204</span> }<a name="line.204"></a>
-<span class="sourceLineNo">205</span> // these fills ensure that the value above the rightmost entry of our<a name="line.205"></a>
-<span class="sourceLineNo">206</span> // stripe will be ignored in following loop iterations<a name="line.206"></a>
-<span class="sourceLineNo">207</span> Arrays.fill(p, boundary, p.length, Integer.MAX_VALUE);<a name="line.207"></a>
-<span class="sourceLineNo">208</span> Arrays.fill(d, Integer.MAX_VALUE);<a name="line.208"></a>
-<span class="sourceLineNo">209</span><a name="line.209"></a>
-<span class="sourceLineNo">210</span> // iterates through t<a name="line.210"></a>
-<span class="sourceLineNo">211</span> for (int j = 1; j <= m; j++) {<a name="line.211"></a>
-<span class="sourceLineNo">212</span> final char t_j = right.charAt(j - 1); // jth character of t<a name="line.212"></a>
-<span class="sourceLineNo">213</span> d[0] = j;<a name="line.213"></a>
-<span class="sourceLineNo">214</span><a name="line.214"></a>
-<span class="sourceLineNo">215</span> // compute stripe indices, constrain to array size<a name="line.215"></a>
-<span class="sourceLineNo">216</span> final int min = Math.max(1, j - threshold);<a name="line.216"></a>
-<span class="sourceLineNo">217</span> final int max = j > Integer.MAX_VALUE - threshold ? n : Math.min(<a name="line.217"></a>
-<span class="sourceLineNo">218</span> n, j + threshold);<a name="line.218"></a>
-<span class="sourceLineNo">219</span><a name="line.219"></a>
-<span class="sourceLineNo">220</span> // the stripe may lead off of the table if s and t are of different<a name="line.220"></a>
-<span class="sourceLineNo">221</span> // sizes<a name="line.221"></a>
-<span class="sourceLineNo">222</span> if (min > max) {<a name="line.222"></a>
-<span class="sourceLineNo">223</span> return -1;<a name="line.223"></a>
-<span class="sourceLineNo">224</span> }<a name="line.224"></a>
-<span class="sourceLineNo">225</span><a name="line.225"></a>
-<span class="sourceLineNo">226</span> // ignore entry left of leftmost<a name="line.226"></a>
-<span class="sourceLineNo">227</span> if (min > 1) {<a name="line.227"></a>
-<span class="sourceLineNo">228</span> d[min - 1] = Integer.MAX_VALUE;<a name="line.228"></a>
+<span class="sourceLineNo">149</span> * Note how the stripe leads off the table as there is no possible way<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * to turn a string of length 5 into one of length 7 in edit distance of<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * 1.<a name="line.151"></a>
+<span class="sourceLineNo">152</span> *<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * Additionally, this implementation decreases memory usage by using two<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * single-dimensional arrays and swapping them back and forth instead of<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * allocating an entire n by m matrix. This requires a few minor<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * changes, such as immediately returning when it's detected that the<a name="line.156"></a>
+<span class="sourceLineNo">157</span> * stripe has run off the matrix and initially filling the arrays with<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * large values so that entries we don't compute are ignored.<a name="line.158"></a>
+<span class="sourceLineNo">159</span> *<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * See Algorithms on Strings, Trees and Sequences by Dan Gusfield for<a name="line.160"></a>
+<span class="sourceLineNo">161</span> * some discussion.<a name="line.161"></a>
+<span class="sourceLineNo">162</span> */<a name="line.162"></a>
+<span class="sourceLineNo">163</span><a name="line.163"></a>
+<span class="sourceLineNo">164</span> int n = left.length(); // length of s<a name="line.164"></a>
+<span class="sourceLineNo">165</span> int m = right.length(); // length of t<a name="line.165"></a>
+<span class="sourceLineNo">166</span><a name="line.166"></a>
+<span class="sourceLineNo">167</span> // if one string is empty, the edit distance is necessarily the length<a name="line.167"></a>
+<span class="sourceLineNo">168</span> // of the other<a name="line.168"></a>
+<span class="sourceLineNo">169</span> if (n == 0) {<a name="line.169"></a>
+<span class="sourceLineNo">170</span> return m <= threshold ? m : -1;<a name="line.170"></a>
+<span class="sourceLineNo">171</span> } else if (m == 0) {<a name="line.171"></a>
+<span class="sourceLineNo">172</span> return n <= threshold ? n : -1;<a name="line.172"></a>
+<span class="sourceLineNo">173</span> }<a name="line.173"></a>
+<span class="sourceLineNo">174</span><a name="line.174"></a>
+<span class="sourceLineNo">175</span> if (n > m) {<a name="line.175"></a>
+<span class="sourceLineNo">176</span> // swap the two strings to consume less memory<a name="line.176"></a>
+<span class="sourceLineNo">177</span> final CharSequence tmp = left;<a name="line.177"></a>
+<span class="sourceLineNo">178</span> left = right;<a name="line.178"></a>
+<span class="sourceLineNo">179</span> right = tmp;<a name="line.179"></a>
+<span class="sourceLineNo">180</span> n = m;<a name="line.180"></a>
+<span class="sourceLineNo">181</span> m = right.length();<a name="line.181"></a>
+<span class="sourceLineNo">182</span> }<a name="line.182"></a>
+<span class="sourceLineNo">183</span><a name="line.183"></a>
+<span class="sourceLineNo">184</span> int[] p = new int[n + 1]; // 'previous' cost array, horizontally<a name="line.184"></a>
+<span class="sourceLineNo">185</span> int[] d = new int[n + 1]; // cost array, horizontally<a name="line.185"></a>
+<span class="sourceLineNo">186</span> int[] _d; // placeholder to assist in swapping p and d<a name="line.186"></a>
+<span class="sourceLineNo">187</span><a name="line.187"></a>
+<span class="sourceLineNo">188</span> // fill in starting table values<a name="line.188"></a>
+<span class="sourceLineNo">189</span> final int boundary = Math.min(n, threshold) + 1;<a name="line.189"></a>
+<span class="sourceLineNo">190</span> for (int i = 0; i < boundary; i++) {<a name="line.190"></a>
+<span class="sourceLineNo">191</span> p[i] = i;<a name="line.191"></a>
+<span class="sourceLineNo">192</span> }<a name="line.192"></a>
+<span class="sourceLineNo">193</span> // these fills ensure that the value above the rightmost entry of our<a name="line.193"></a>
+<span class="sourceLineNo">194</span> // stripe will be ignored in following loop iterations<a name="line.194"></a>
+<span class="sourceLineNo">195</span> Arrays.fill(p, boundary, p.length, Integer.MAX_VALUE);<a name="line.195"></a>
+<span class="sourceLineNo">196</span> Arrays.fill(d, Integer.MAX_VALUE);<a name="line.196"></a>
+<span class="sourceLineNo">197</span><a name="line.197"></a>
+<span class="sourceLineNo">198</span> // iterates through t<a name="line.198"></a>
+<span class="sourceLineNo">199</span> for (int j = 1; j <= m; j++) {<a name="line.199"></a>
+<span class="sourceLineNo">200</span> final char t_j = right.charAt(j - 1); // jth character of t<a name="line.200"></a>
+<span class="sourceLineNo">201</span> d[0] = j;<a name="line.201"></a>
+<span class="sourceLineNo">202</span><a name="line.202"></a>
+<span class="sourceLineNo">203</span> // compute stripe indices, constrain to array size<a name="line.203"></a>
+<span class="sourceLineNo">204</span> final int min = Math.max(1, j - threshold);<a name="line.204"></a>
+<span class="sourceLineNo">205</span> final int max = j > Integer.MAX_VALUE - threshold ? n : Math.min(<a name="line.205"></a>
+<span class="sourceLineNo">206</span> n, j + threshold);<a name="line.206"></a>
+<span class="sourceLineNo">207</span><a name="line.207"></a>
+<span class="sourceLineNo">208</span> // the stripe may lead off of the table if s and t are of different<a name="line.208"></a>
+<span class="sourceLineNo">209</span> // sizes<a name="line.209"></a>
+<span class="sourceLineNo">210</span> if (min > max) {<a name="line.210"></a>
+<span class="sourceLineNo">211</span> return -1;<a name="line.211"></a>
+<span class="sourceLineNo">212</span> }<a name="line.212"></a>
+<span class="sourceLineNo">213</span><a name="line.213"></a>
+<span class="sourceLineNo">214</span> // ignore entry left of leftmost<a name="line.214"></a>
+<span class="sourceLineNo">215</span> if (min > 1) {<a name="line.215"></a>
+<span class="sourceLineNo">216</span> d[min - 1] = Integer.MAX_VALUE;<a name="line.216"></a>
+<span class="sourceLineNo">217</span> }<a name="line.217"></a>
+<span class="sourceLineNo">218</span><a name="line.218"></a>
+<span class="sourceLineNo">219</span> // iterates through [min, max] in s<a name="line.219"></a>
+<span class="sourceLineNo">220</span> for (int i = min; i <= max; i++) {<a name="line.220"></a>
+<span class="sourceLineNo">221</span> if (left.charAt(i - 1) == t_j) {<a name="line.221"></a>
+<span class="sourceLineNo">222</span> // diagonally left and up<a name="line.222"></a>
+<span class="sourceLineNo">223</span> d[i] = p[i - 1];<a name="line.223"></a>
+<span class="sourceLineNo">224</span> } else {<a name="line.224"></a>
+<span class="sourceLineNo">225</span> // 1 + minimum of cell to the left, to the top, diagonally<a name="line.225"></a>
+<span class="sourceLineNo">226</span> // left and up<a name="line.226"></a>
+<span class="sourceLineNo">227</span> d[i] = 1 + Math.min(Math.min(d[i - 1], p[i]), p[i - 1]);<a name="line.227"></a>
+<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
-<span class="sourceLineNo">231</span> // iterates through [min, max] in s<a name="line.231"></a>
-<span class="sourceLineNo">232</span> for (int i = min; i <= max; i++) {<a name="line.232"></a>
-<span class="sourceLineNo">233</span> if (left.charAt(i - 1) == t_j) {<a name="line.233"></a>
-<span class="sourceLineNo">234</span> // diagonally left and up<a name="line.234"></a>
-<span class="sourceLineNo">235</span> d[i] = p[i - 1];<a name="line.235"></a>
-<span class="sourceLineNo">236</span> } else {<a name="line.236"></a>
-<span class="sourceLineNo">237</span> // 1 + minimum of cell to the left, to the top, diagonally<a name="line.237"></a>
-<span class="sourceLineNo">238</span> // left and up<a name="line.238"></a>
-<span class="sourceLineNo">239</span> d[i] = 1 + Math.min(Math.min(d[i - 1], p[i]), p[i - 1]);<a name="line.239"></a>
-<span class="sourceLineNo">240</span> }<a name="line.240"></a>
-<span class="sourceLineNo">241</span> }<a name="line.241"></a>
-<span class="sourceLineNo">242</span><a name="line.242"></a>
-<span class="sourceLineNo">243</span> // copy current distance counts to 'previous row' distance counts<a name="line.243"></a>
-<span class="sourceLineNo">244</span> _d = p;<a name="line.244"></a>
-<span class="sourceLineNo">245</span> p = d;<a name="line.245"></a>
-<span class="sourceLineNo">246</span> d = _d;<a name="line.246"></a>
-<span class="sourceLineNo">247</span> }<a name="line.247"></a>
-<span class="sourceLineNo">248</span><a name="line.248"></a>
-<span class="sourceLineNo">249</span> // if p[n] is greater than the threshold, there's no guarantee on it<a name="line.249"></a>
-<span class="sourceLineNo">250</span> // being the correct<a name="line.250"></a>
-<span class="sourceLineNo">251</span> // distance<a name="line.251"></a>
-<span class="sourceLineNo">252</span> if (p[n] <= threshold) {<a name="line.252"></a>
-<span class="sourceLineNo">253</span> return p[n];<a name="line.253"></a>
-<span class="sourceLineNo">254</span> }<a name="line.254"></a>
-<span class="sourceLineNo">255</span> return -1;<a name="line.255"></a>
-<span class="sourceLineNo">256</span> }<a name="line.256"></a>
-<span class="sourceLineNo">257</span><a name="line.257"></a>
-<span class="sourceLineNo">258</span>}<a name="line.258"></a>
+<span class="sourceLineNo">231</span> // copy current distance counts to 'previous row' distance counts<a name="line.231"></a>
+<span class="sourceLineNo">232</span> _d = p;<a name="line.232"></a>
+<span class="sourceLineNo">233</span> p = d;<a name="line.233"></a>
+<span class="sourceLineNo">234</span> d = _d;<a name="line.234"></a>
+<span class="sourceLineNo">235</span> }<a name="line.235"></a>
+<span class="sourceLineNo">236</span><a name="line.236"></a>
+<span class="sourceLineNo">237</span> // if p[n] is greater than the threshold, there's no guarantee on it<a name="line.237"></a>
+<span class="sourceLineNo">238</span> // being the correct<a name="line.238"></a>
+<span class="sourceLineNo">239</span> // distance<a name="line.239"></a>
+<span class="sourceLineNo">240</span> if (p[n] <= threshold) {<a name="line.240"></a>
+<span class="sourceLineNo">241</span> return p[n];<a name="line.241"></a>
+<span class="sourceLineNo">242</span> }<a name="line.242"></a>
+<span class="sourceLineNo">243</span> return -1;<a name="line.243"></a>
+<span class="sourceLineNo">244</span> }<a name="line.244"></a>
+<span class="sourceLineNo">245</span><a name="line.245"></a>
+<span class="sourceLineNo">246</span>}<a name="line.246"></a>
@@ -327,4 +315,4 @@
</pre>
</div>
</body>
-</html>
+</html>
\ No newline at end of file
Modified: websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/StringMetric.html
==============================================================================
--- websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/StringMetric.html (original)
+++ websites/production/commons/content/sandbox/commons-text/apidocs/src-html/org/apache/commons/text/similarity/StringMetric.html Sun Mar 1 12:14:29 2015
@@ -25,32 +25,27 @@
<span class="sourceLineNo">017</span>package org.apache.commons.text.similarity;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
-<span class="sourceLineNo">020</span> * <p><a name="line.20"></a>
-<span class="sourceLineNo">021</span> * Marker interface for <a<a name="line.21"></a>
-<span class="sourceLineNo">022</span> * href='http://en.wikipedia.org/wiki/String_metric'>String Metrics</a><a name="line.22"></a>
-<span class="sourceLineNo">023</span> * </p><a name="line.23"></a>
-<span class="sourceLineNo">024</span> *<a name="line.24"></a>
-<span class="sourceLineNo">025</span> * <p><a name="line.25"></a>
-<span class="sourceLineNo">026</span> * A string metric measures the distance between two text strings.<a name="line.26"></a>
-<span class="sourceLineNo">027</span> * </p><a name="line.27"></a>
-<span class="sourceLineNo">028</span> *<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * @param <R> return type of the edit distance<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * @since 1.0<a name="line.30"></a>
-<span class="sourceLineNo">031</span> */<a name="line.31"></a>
-<span class="sourceLineNo">032</span>public interface StringMetric<R> {<a name="line.32"></a>
-<span class="sourceLineNo">033</span><a name="line.33"></a>
-<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * <p><a name="line.35"></a>
-<span class="sourceLineNo">036</span> * Compares two strings.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> * </p><a name="line.37"></a>
-<span class="sourceLineNo">038</span> *<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * @param left the first string<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * @param right the second string<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * @return result distance<a name="line.41"></a>
-<span class="sourceLineNo">042</span> */<a name="line.42"></a>
-<span class="sourceLineNo">043</span> R compare(CharSequence left, CharSequence right);<a name="line.43"></a>
-<span class="sourceLineNo">044</span><a name="line.44"></a>
-<span class="sourceLineNo">045</span>}<a name="line.45"></a>
+<span class="sourceLineNo">020</span> * Interface for <a href='http://en.wikipedia.org/wiki/String_metric'>String Metrics</a>.<a name="line.20"></a>
+<span class="sourceLineNo">021</span> *<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * <p><a name="line.22"></a>
+<span class="sourceLineNo">023</span> * A string metric measures the similarity between two character sequences. Depending on<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * the algorithm, higher values can mean closer strings, or more distant strings.<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * </p><a name="line.25"></a>
+<span class="sourceLineNo">026</span> *<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * @param <R> The type of similarity score unit used by this StringMetric.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> */<a name="line.28"></a>
+<span class="sourceLineNo">029</span>public interface StringMetric<R> {<a name="line.29"></a>
+<span class="sourceLineNo">030</span><a name="line.30"></a>
+<span class="sourceLineNo">031</span> /**<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * Compares two CharSequences.<a name="line.32"></a>
+<span class="sourceLineNo">033</span> *<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * @param left the first CharSequence<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * @param right the second CharSequence<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * @return the similarity score between two CharSequences<a name="line.36"></a>
+<span class="sourceLineNo">037</span> */<a name="line.37"></a>
+<span class="sourceLineNo">038</span> R compare(CharSequence left, CharSequence right);<a name="line.38"></a>
+<span class="sourceLineNo">039</span><a name="line.39"></a>
+<span class="sourceLineNo">040</span>}<a name="line.40"></a>
@@ -114,4 +109,4 @@
</pre>
</div>
</body>
-</html>
+</html>
\ No newline at end of file
Modified: websites/production/commons/content/sandbox/commons-text/apidocs/stylesheet.css
==============================================================================
--- websites/production/commons/content/sandbox/commons-text/apidocs/stylesheet.css (original)
+++ websites/production/commons/content/sandbox/commons-text/apidocs/stylesheet.css Sun Mar 1 12:14:29 2015
@@ -471,4 +471,4 @@ h1.hidden {
}
.strong {
font-weight:bold;
-}
+}
\ No newline at end of file
Modified: websites/production/commons/content/sandbox/commons-text/changes-report.html
==============================================================================
--- websites/production/commons/content/sandbox/commons-text/changes-report.html (original)
+++ websites/production/commons/content/sandbox/commons-text/changes-report.html Sun Mar 1 12:14:29 2015
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 29 November 2014
+ | Generated by Apache Maven Doxia at 01 March 2015
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20141129" />
+ <meta name="Date-Revision-yyyymmdd" content="20150301" />
<meta http-equiv="Content-Language" content="en" />
<title>Commons Text – Apache Commons Text Changes</title>
@@ -43,7 +43,7 @@
<a class="brand" href="http://commons.apache.org/sandbox/commons-text/">Apache Commons Text ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 29 November 2014</li>
+ <li id="publishDate">Last Published: 01 March 2015</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.1-SNAPSHOT</li>
</ul>
<div class="pull-right"> <ul class="nav">
@@ -122,7 +122,7 @@
</ul>
<ul class="nav nav-list">
<li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
- <li class="collapsed">
+ <li class="collapsed">
<a href="project-info.html" title="Project Information">
Project Information</a>
</li>
@@ -143,14 +143,14 @@
JavaDocs</a>
</li>
<li class="none">
- <a href="xref-test/index.html" title="Test Source Xref">
- Test Source Xref</a>
- </li>
- <li class="none">
<a href="xref/index.html" title="Source Xref">
Source Xref</a>
</li>
<li class="none">
+ <a href="xref-test/index.html" title="Test Source Xref">
+ Test Source Xref</a>
+ </li>
+ <li class="none">
<a href="surefire-report.html" title="Surefire Report">
Surefire Report</a>
</li>
@@ -231,6 +231,14 @@
Building Components</a>
</li>
<li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
<a href="../../releases/index.html" title="Releasing Components">
Releasing Components</a>
</li>
@@ -288,14 +296,26 @@
<td>tba</td></tr></table></div>
<div class="section">
<h3 id="a1.0">Release 1.0 – tba</h3>
-<p>No changes in this release.</p></div>
+<table border="0" class="bodyTable">
+<tr class="a">
+<th>Type</th>
+<th>Changes</th>
+<th>By</th></tr>
+<tr class="b">
+<td><img src="images/add.gif" alt="Add" title="Add" /></td>
+<td>Add Hamming distance Fixes <a class="externalLink" href="http://issues.apache.org/jira/browse/SANDBOX-485">SANDBOX-485</a>.</td>
+<td><a href="team-list.html#kinow">kinow</a></td></tr>
+<tr class="a">
+<td><img src="images/add.gif" alt="Add" title="Add" /></td>
+<td>Incorporate String algorithms from Commons Lang Fixes <a class="externalLink" href="http://issues.apache.org/jira/browse/SANDBOX-483">SANDBOX-483</a>. Thanks to britter.</td>
+<td><a href="team-list.html#kinow">kinow</a></td></tr></table></div></div>
</td>
</tr>
</table>
</div>
<div class="footer">
- <p>Copyright © 2014
+ <p>Copyright © 2014-2015
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
@@ -304,4 +324,4 @@
</div>
</body>
-</html>
+</html>
\ No newline at end of file