Added: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/diff/package-summary.html ============================================================================== --- websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/diff/package-summary.html (added) +++ websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/diff/package-summary.html Sun Mar 1 12:14:29 2015 @@ -0,0 +1,114 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> + <title>Apache Commons Text 0.1-SNAPSHOT Reference Package org.apache.commons.text.diff</title> + <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> + </head> + <body> + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <h2>Package org.apache.commons.text.diff</h2> + + <table class="summary"> + <thead> + <tr> + <th>Class Summary</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="CommandVisitor.html" target="classFrame">CommandVisitor</a> + </td> + </tr> + <tr> + <td> + <a href="DeleteCommand.html" target="classFrame">DeleteCommand</a> + </td> + </tr> + <tr> + <td> + <a href="EditCommand.html" target="classFrame">EditCommand</a> + </td> + </tr> + <tr> + <td> + <a href="EditScript.html" target="classFrame">EditScript</a> + </td> + </tr> + <tr> + <td> + <a href="InsertCommand.html" target="classFrame">InsertCommand</a> + </td> + </tr> + <tr> + <td> + <a href="KeepCommand.html" target="classFrame">KeepCommand</a> + </td> + </tr> + <tr> + <td> + <a href="ReplacementsFinder.html" target="classFrame">ReplacementsFinder</a> + </td> + </tr> + <tr> + <td> + <a href="ReplacementsHandler.html" target="classFrame">ReplacementsHandler</a> + </td> + </tr> + <tr> + <td> + <a href="StringsComparator.html" target="classFrame">Snake</a> + </td> + </tr> + <tr> + <td> + <a href="StringsComparator.html" target="classFrame">StringsComparator</a> + </td> + </tr> + </tbody> + </table> + + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + <hr /> + <div id="footer"> + Copyright © 2014–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved. + </div> + </body> +</html> \ No newline at end of file
Propchange: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/diff/package-summary.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/FuzzyScore.html ============================================================================== --- websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/FuzzyScore.html (added) +++ websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/FuzzyScore.html Sun Mar 1 12:14:29 2015 @@ -0,0 +1,146 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>FuzzyScore xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/text/similarity/FuzzyScore.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.text.similarity; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> * A matching algorithm that is similar to the searching algorithms implemented in editors such</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * as Sublime Text, TextMate, Atom and others.</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * One point is given for every matched character. Subsequent matches yield two bonus points. A higher score</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * indicates a higher similarity.</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * This code has been adapted from Apache Commons Lang 3.3.</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/similarity/FuzzyScore.html">FuzzyScore</a> <strong class="jxr_keyword">implements</strong> StringMetric<Integer> { +<a class="jxr_linenumber" name="L35" href="#L35">35</a> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Find the Fuzzy Score which indicates the similarity score between two</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Strings. This method uses the default locale.</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @param term a full term that should be matched against, must not be null</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @param query the query that will be matched against a term, must not be</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * null</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @return result score</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if either String input {@code null}</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Override +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> Integer compare(CharSequence term, CharSequence query) { +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">return</strong> compare(term, query, Locale.getDefault()); +<a class="jxr_linenumber" name="L51" href="#L51">51</a> } +<a class="jxr_linenumber" name="L52" href="#L52">52</a> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Find the Fuzzy Score which indicates the similarity score between two</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Strings.</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * score.compare(null, null, null) = IllegalArgumentException</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * score.compare("", "", Locale.ENGLISH) = 0</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * score.compare("Workshop", "b", Locale.ENGLISH) = 0</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * score.compare("Room", "o", Locale.ENGLISH) = 1</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * score.compare("Workshop", "w", Locale.ENGLISH) = 1</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * score.compare("Workshop", "ws", Locale.ENGLISH) = 2</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * score.compare("Workshop", "wo", Locale.ENGLISH) = 4</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * score.compare("Apache Software Foundation", "asf", Locale.ENGLISH) = 3</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @param term a full term that should be matched against, must not be null</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param query the query that will be matched against a term, must not be</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * null</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @param locale This string matching logic is case insensitive. A locale is</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * necessary to normalize both Strings to lower case.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @return result score</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if either String input {@code null} or</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Locale input {@code null}</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">public</strong> Integer compare(CharSequence term, CharSequence query, Locale locale) { +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">if</strong> (term == <strong class="jxr_keyword">null</strong> || query == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Strings must not be null"</span>); +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (locale == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Locale must not be null"</span>); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } +<a class="jxr_linenumber" name="L85" href="#L85">85</a> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// fuzzy logic is case insensitive. We normalize the Strings to lower</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// case right from the start. Turning characters to lower case</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// via Character.toLowerCase(char) is unfortunately insufficient</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// as it does not accept a locale.</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">final</strong> String termLowerCase = term.toString().toLowerCase(locale); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">final</strong> String queryLowerCase = query.toString().toLowerCase(locale); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">// the resulting score</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">int</strong> score = 0; +<a class="jxr_linenumber" name="L95" href="#L95">95</a> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_comment">// the position in the term which will be scanned next for potential</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_comment">// query character matches</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">int</strong> termIndex = 0; +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_comment">// index of the previously matched character in the term</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">int</strong> previousMatchingCharacterIndex = Integer.MIN_VALUE; +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> queryIndex = 0; queryIndex < queryLowerCase.length(); queryIndex++) { +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> queryChar = queryLowerCase.charAt(queryIndex); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">boolean</strong> termCharacterMatchFound = false; +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">for</strong> (; termIndex < termLowerCase.length() +<a class="jxr_linenumber" name="L108" href="#L108">108</a> && !termCharacterMatchFound; termIndex++) { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> termChar = termLowerCase.charAt(termIndex); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> (queryChar == termChar) { +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_comment">// simple character matches result in one point</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> score++; +<a class="jxr_linenumber" name="L114" href="#L114">114</a> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">// subsequent character matches further improve</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">// the score.</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">if</strong> (previousMatchingCharacterIndex + 1 == termIndex) { +<a class="jxr_linenumber" name="L118" href="#L118">118</a> score += 2; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> previousMatchingCharacterIndex = termIndex; +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_comment">// we can leave the nested loop. Every character in the</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_comment">// query can match at most one character in the term.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> termCharacterMatchFound = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L126" href="#L126">126</a> } +<a class="jxr_linenumber" name="L127" href="#L127">127</a> } +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> score; +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2014–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file Propchange: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/FuzzyScore.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/HammingDistance.html ============================================================================== --- websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/HammingDistance.html (added) +++ websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/HammingDistance.html Sun Mar 1 12:14:29 2015 @@ -0,0 +1,89 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>HammingDistance xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/text/similarity/HammingDistance.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.text.similarity; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_javadoccomment"> * The hamming distance between two strings of equal length is the number of</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment"> * positions at which the corresponding symbols are different.</em> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * For further explanation about the Hamming Distance, take a look at its</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * Wikipedia page at <a href="http://en.wikipedia.org/wiki/Hamming_distance" target="alexandria_uri">http://en.wikipedia.org/wiki/Hamming_distance</a>.</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/similarity/HammingDistance.html">HammingDistance</a> <strong class="jxr_keyword">implements</strong> StringMetric<Integer> { +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Find the Hamming Distance between two strings with the same</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * length.</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <p>The distance starts with zero, and for each occurrence of a</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * different character in either String, it increments the distance</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * by 1, and finally return its value.</p></em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <p>Since the Hamming Distance can only be calculated between strings of equal length, input of different lengths</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * will throw IllegalArgumentException</p></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * distance.compare("", "") = 0</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * distance.compare("pappa", "pappa") = 0</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * distance.compare("1011101", "1011111") = 1</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * distance.compare("ATCG", "ACCC") = 2</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * distance.compare("karolin", "kerstin" = 3</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @param left the first CharSequence, must not be null</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @param right the second CharSequence, must not be null</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @return distance</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if either input is {@code null} or</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * if they do not have the same length</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Override +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> Integer compare(CharSequence left, CharSequence right) { +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (left == <strong class="jxr_keyword">null</strong> || right == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Strings must not be null"</span>); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (left.length() != right.length()) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Strings must have the same length"</span>); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> } +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">int</strong> distance = 0; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < left.length(); i++) { +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">if</strong> (left.charAt(i) != right.charAt(i)) { +<a class="jxr_linenumber" name="L69" href="#L69">69</a> distance++; +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">return</strong> distance; +<a class="jxr_linenumber" name="L74" href="#L74">74</a> } +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2014–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file Propchange: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/similarity/HammingDistance.html ------------------------------------------------------------------------------ svn:eol-style = native