-
Notifications
You must be signed in to change notification settings - Fork 237
/
LevenshteinResults.java
125 lines (115 loc) · 3.83 KB
/
LevenshteinResults.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.text.similarity;
import java.util.Objects;
/**
* Container class to store Levenshtein distance between two character sequences.
*
* <p>Stores the count of insert, deletion and substitute operations needed to
* change one character sequence into another.</p>
*
* <p>This class is immutable.</p>
*
* @since 1.0
*/
public class LevenshteinResults {
/**
* Edit distance.
*/
private final Integer distance;
/**
* Insert character count.
*/
private final Integer insertCount;
/**
* Delete character count.
*/
private final Integer deleteCount;
/**
* Substitute character count.
*/
private final Integer substituteCount;
/**
* Create the results for a detailed Levenshtein distance.
*
* @param distance distance between two character sequences.
* @param insertCount insert character count
* @param deleteCount delete character count
* @param substituteCount substitute character count
*/
public LevenshteinResults(final Integer distance, final Integer insertCount, final Integer deleteCount,
final Integer substituteCount) {
this.distance = distance;
this.insertCount = insertCount;
this.deleteCount = deleteCount;
this.substituteCount = substituteCount;
}
/**
* Get the distance between two character sequences.
*
* @return distance between two character sequence
*/
public Integer getDistance() {
return distance;
}
/**
* Get the number of insertion needed to change one character sequence into another.
*
* @return insert character count
*/
public Integer getInsertCount() {
return insertCount;
}
/**
* Get the number of character deletion needed to change one character sequence to other.
*
* @return delete character count
*/
public Integer getDeleteCount() {
return deleteCount;
}
/**
* Get the number of character substitution needed to change one character sequence into another.
*
* @return substitute character count
*/
public Integer getSubstituteCount() {
return substituteCount;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final LevenshteinResults result = (LevenshteinResults) o;
return Objects.equals(distance, result.distance) && Objects.equals(insertCount, result.insertCount)
&& Objects.equals(deleteCount, result.deleteCount)
&& Objects.equals(substituteCount, result.substituteCount);
}
@Override
public int hashCode() {
return Objects.hash(distance, insertCount, deleteCount, substituteCount);
}
@Override
public String toString() {
return "Distance: " + distance + ", Insert: " + insertCount + ", Delete: " + deleteCount + ", Substitute: "
+ substituteCount;
}
}