edit_distance.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. #pragma once
  2. #ifdef __GNUC__
  3. #pragma GCC diagnostic push
  4. #pragma GCC diagnostic ignored "-Wunused-parameter"
  5. #endif
  6. //===-- llvm/ADT/edit_distance.h - Array edit distance function --- C++ -*-===//
  7. //
  8. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  9. // See https://llvm.org/LICENSE.txt for license information.
  10. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  11. //
  12. //===----------------------------------------------------------------------===//
  13. //
  14. // This file defines a Levenshtein distance function that works for any two
  15. // sequences, with each element of each sequence being analogous to a character
  16. // in a string.
  17. //
  18. //===----------------------------------------------------------------------===//
  19. #ifndef LLVM_ADT_EDIT_DISTANCE_H
  20. #define LLVM_ADT_EDIT_DISTANCE_H
  21. #include "llvm/ADT/ArrayRef.h"
  22. #include <algorithm>
  23. #include <memory>
  24. namespace llvm {
  25. /// Determine the edit distance between two sequences.
  26. ///
  27. /// \param FromArray the first sequence to compare.
  28. ///
  29. /// \param ToArray the second sequence to compare.
  30. ///
  31. /// \param AllowReplacements whether to allow element replacements (change one
  32. /// element into another) as a single operation, rather than as two operations
  33. /// (an insertion and a removal).
  34. ///
  35. /// \param MaxEditDistance If non-zero, the maximum edit distance that this
  36. /// routine is allowed to compute. If the edit distance will exceed that
  37. /// maximum, returns \c MaxEditDistance+1.
  38. ///
  39. /// \returns the minimum number of element insertions, removals, or (if
  40. /// \p AllowReplacements is \c true) replacements needed to transform one of
  41. /// the given sequences into the other. If zero, the sequences are identical.
  42. template<typename T>
  43. unsigned ComputeEditDistance(ArrayRef<T> FromArray, ArrayRef<T> ToArray,
  44. bool AllowReplacements = true,
  45. unsigned MaxEditDistance = 0) {
  46. // The algorithm implemented below is the "classic"
  47. // dynamic-programming algorithm for computing the Levenshtein
  48. // distance, which is described here:
  49. //
  50. // http://en.wikipedia.org/wiki/Levenshtein_distance
  51. //
  52. // Although the algorithm is typically described using an m x n
  53. // array, only one row plus one element are used at a time, so this
  54. // implementation just keeps one vector for the row. To update one entry,
  55. // only the entries to the left, top, and top-left are needed. The left
  56. // entry is in Row[x-1], the top entry is what's in Row[x] from the last
  57. // iteration, and the top-left entry is stored in Previous.
  58. typename ArrayRef<T>::size_type m = FromArray.size();
  59. typename ArrayRef<T>::size_type n = ToArray.size();
  60. const unsigned SmallBufferSize = 64;
  61. unsigned SmallBuffer[SmallBufferSize];
  62. std::unique_ptr<unsigned[]> Allocated;
  63. unsigned *Row = SmallBuffer;
  64. if (n + 1 > SmallBufferSize) {
  65. Row = new unsigned[n + 1];
  66. Allocated.reset(Row);
  67. }
  68. for (unsigned i = 1; i <= n; ++i)
  69. Row[i] = i;
  70. for (typename ArrayRef<T>::size_type y = 1; y <= m; ++y) {
  71. Row[0] = y;
  72. unsigned BestThisRow = Row[0];
  73. unsigned Previous = y - 1;
  74. for (typename ArrayRef<T>::size_type x = 1; x <= n; ++x) {
  75. int OldRow = Row[x];
  76. if (AllowReplacements) {
  77. Row[x] = std::min(
  78. Previous + (FromArray[y-1] == ToArray[x-1] ? 0u : 1u),
  79. std::min(Row[x-1], Row[x])+1);
  80. }
  81. else {
  82. if (FromArray[y-1] == ToArray[x-1]) Row[x] = Previous;
  83. else Row[x] = std::min(Row[x-1], Row[x]) + 1;
  84. }
  85. Previous = OldRow;
  86. BestThisRow = std::min(BestThisRow, Row[x]);
  87. }
  88. if (MaxEditDistance && BestThisRow > MaxEditDistance)
  89. return MaxEditDistance + 1;
  90. }
  91. unsigned Result = Row[n];
  92. return Result;
  93. }
  94. } // End llvm namespace
  95. #endif
  96. #ifdef __GNUC__
  97. #pragma GCC diagnostic pop
  98. #endif